API Reference

Validate beneficiary

post
https://api.stage.payouts.com/vendor/beneficiaries/validate

Required permissions for this API:

  • READ:VENDOR_FINANCE
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
beneficiary
object
required

Details of the beneficiary

string

Nickname of the beneficiary.

string

The payer entity type that will be used for payments being made to this beneficiary. This is required to accurately capture and validate appropriate data for compliance reasons. Defaults to COMPANY.

transferMethods
array of strings

Payment methods, i.e. SWIFT, LOCAL. The payment method needs to be specified to ensure that accurate banking details are captured and validated for the specified payment method. This is required for timely and accurate delivery of funds to the beneficiary account.

transferMethods
string

Reason for the payment instruction being made to this beneficiary.

Responses

Updated 11 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago