Fetch Payee Bank/Crypto Parameter Schema

This endpoint is used to retrieve the configuration parameters for available payment methods in international transfers and crypto accounts. On the right-hand side, in the cURL section, you'll find examples showing how the request would look depending on whether you're using bank accounts or a crypto wallet.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

You will receive the necessary parameters to include in the request body for either the "Add Payee Funding Method" API or the "Add a Cryptocurrency Wallet Funding Method" API. Depending on whether you're using bank accounts or crypto wallets, you'll use either /v3/payee/account/create/bank-account or /v3/payee/account/create/crypto. These parameters may vary depending on the country, currency, and funding method. Please pay close attention to the description and allowed size of each parameter — failure to follow these guidelines may result in request errors.

Body Params
string
Defaults to US

The bank account country

string
Defaults to USD

The bank account currency

string
Defaults to BANK_ACCOUNT

The funding source account type. e.g. BANK_ACCOUNT

string
required
Defaults to 303456

Merchant ID in Pockyt's system. A unique value generated by Pockyt during the onboarding process.

string
Defaults to INDIVIDUAL

The payee's profile type. Possible types are: INDIVIDUAL, BUSINESS

string
required
Defaults to 204659

Store Number in Pockyt's system. A unique value created and assigned by Pockyt's systems when a new store is created under a merchant

string
required
Defaults to 2025-01-24T20:54:59Z

Current UTC time, correct format should be "yyyy-mm-ddTHH:MM:SSZ"

string
required
Defaults to cac56b252c05fce25110165063e7c6cd,fhj5

The parameter signature. It is the calculated MD5 hash value of the API token used to encrypt the request message and authorize transaction requests. For more information, visit Signing API Parameters

Response

Language
LoadingLoading…
Response
Choose an example:
application/json