API Reference

Get the beneficiaries API schema

post
https://api.stage.payouts.com/api/v1/beneficiaries/api_schemas/generate

Required headers for authentication with api key OR more secure signature + timestamp

Required permissions for this API:

and:

or: READ:TRANSFERS, CREATE:TRANSFERS

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

Bank country code (2-letter ISO 3166-2 country code).

string

Account currency (3-letter ISO 4217 currency code).

string
enum

Transfer method, i.e., SWIFT, LOCAL

Allowed:
string

Local clearing systems are available for selection when making local payments to the following countries and currencies: US USD, AU AUD, HK HKD, HK USD, HK CNY, SG SGD. Without specification, it will be set to the default value.

string
enum

Entity type of the beneficiary, i.e., COMPANY, PERSONAL

Allowed:
Responses
200
401

Invalid API Key

500
  1. Service unavailable

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 5 months ago

Did this page help you?