API Reference

Validate transfer

post
https://api.aidev.payouts.com/api/v1/wire-transfers/validate

Validate a transfer request before creating it. Returns OK if valid, or validation errors if invalid. Always call this endpoint before creating a transfer to catch errors early.

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

ID of a previously saved beneficiary (alternative to beneficiary object)

payer
object
required
string

ID of a previously saved payer (alternative to payer object)

string
required

Currency the payer uses to fund the transfer (3-letter ISO 4217)

number

Amount in source currency (either this or transferAmount required)

number

Amount in transfer currency (either this or sourceAmount required)

string
required

Currency the beneficiary receives (3-letter ISO 4217)

string
enum
required

Transfer method

Allowed:
date

Date when transfer should be made (ISO 8601 format)

string
enum
required

Reason for the transfer

string
required
length between 1 and 140

Reference shown on beneficiary's bank statement (1-140 characters)

string
length ≤ 200

Internal remarks (not shown to beneficiary, 1-200 characters)

string
required
length between 10 and 50

Unique idempotency key (10-50 characters)

string
enum

Who pays the transfer fee

Allowed:
string
enum

SWIFT charge option (for SWIFT transfers only)

Allowed:
metadata
object

Custom metadata (key-value pairs)

Responses

Updated 9 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 9 months ago