WePay logo
      Nothing Found

Get a collection of payout methods

get/payout_methods

The GET /payout_methods call allows your platform to look up a collection of payout methods. Payout methods represent payout targets, such as bank accounts.

SecurityappIdAuth and appTokenAuth
Request
query Parameters
page
string

Return elements from this page.

page_size
integer [ 1 .. 50 ]
Default: 10

Return no more than this many elements per page. If not specified, page_size defaults to 10. Maximum value allowed is 50.

create_time_start
integer <int64> >= 0

The timestamp for the start of the search window.

create_time_end
integer <int64> >= 0

The timestamp for the end of the search window.

owner_id
string

Return elements owned by this resource instance.

type
string

The type of payout method to search for. Required unless "page" is provided

Enum: Description
payout_bank_ca

Bank account in Canada.

payout_bank_gb

Bank account in the UK (not currently supported).

… 2 more
header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
required
Array of objects unique

An array of payout method objects.

next
required
string or null

An opaque path for the next page of results. Perform an HTTP GET to obtain the next page.

previous
required
string or null

An opaque path for the previous page of results. Perform an HTTP GET to obtain the previous page.

api_version
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "next": "/payout_methods?page=QVFQNUFBRVgzVDMrd3Rxd2RPYThkbFhtLzJUa08rMkU0djJnUHNpNk1HUlVhc2NoTWowUFFCaVNzajY5K1VLNFdSQ056Q1ZqL25qQXVZSDlLNVZXUnIvYVFOOTBCc2lSMWxOKzIrNzJxWXNWN1VhSHkvWllmcXF2NkNMZEphdXZYVlo3OHZtZkYzaVcwaEtpelRDbytUQjVDQ3lxUmxxSDVyaUJ4TUQwTGt1NTBwTW5qZlMvZmk1Q1paUDJJN1VPbDRpVjNxVWFDUTNZVi9aQTN3ZkJLYmtQOGpOMCtqeUJBOTNmQjcyKzczRHM1VkNHelJRMWRQLzNoNFJ0WWQxLw==",
  • "previous": null,
  • "api_version": "3.0",
  • "results": [
    • {
      • "create_time": 1480700534,
      • "custom_data": null,
      • "id": "0102b1c6-2bc7-448a-aa1d-076b1637547c",
      • "nickname": "Foo Bar Bank",
      • "owner": {
        • "id": "3cd20b3c-4008-400b-b708-2b844ce7be84",
        • "path": "/legal_entities/3cd20b3c-4008-400b-b708-2b844ce7be84",
        • "resource": "legal_entities"
        },
      • "path": "/payout_methods/0102b1c6-2bc7-448a-aa1d-076b1637547c",
      • "payout_bank_us": {
        • "account_type": "checking",
        • "last_four": "6979"
        },
      • "resource": "payout_methods",
      • "status": "active",
      • "type": "payout_bank_us",
      • "api_version": "3.0"
      },
    • {
      • "create_time": 1480700534,
      • "custom_data": null,
      • "id": "3e32b1c6-2bc7-448a-aa1d-076b1637547c",
      • "nickname": "Foo Bar Bank",
      • "owner": {
        • "id": "3cd20b3c-4008-400b-b708-2b844ce7be84",
        • "path": "/legal_entities/3cd20b3c-4008-400b-b708-2b844ce7be84",
        • "resource": "legal_entities"
        },
      • "path": "/payout_methods/0102b1c6-2bc7-448a-aa1d-076b1637547c",
      • "payout_bank_us": {
        • "account_type": "checking",
        • "last_four": "6889"
        },
      • "resource": "payout_methods",
      • "status": "active",
      • "type": "payout_bank_us",
      • "api_version": "3.0"
      }
    ]
}