v1

latestOpenAPI 3.0.02026-07-14866188.2 KB
Beneficiary

Create a new bank beneficiary

post/v0.2.4/beneficiary/bank

Request body

Example request

{
  "beneficiaryData": {
    "accountHolderName": "John Doe",
    "accountHolderAddress1": "123 Main St",
    "accountHolderAddress2": "Apt 4B",
    "accountHolderCity": "New York",
    "accountHolderRegion": "NEW YORK",
    "accountHolderPostal": "10001",
    "bankName": "Test Bank",
    "bankCity": "New York",
    "bankAddressLine1": "456 Bank St",
    "bankRegion": "NEW YORK",
    "bankPostal": "10001",
    "accountNumber": "12345678",
    "routingCode": "123456789",
    "classification": "Individual",
    "preferredMethod": "W",
    "currency": "USD",
    "country": "US"
  }
}

Response

Success

statusstring
messagestring

Example response

{
  "status": "success",
  "message": "Beneficiary created successfully",
  "data": {
    "id": "12345",
    "beneID": "BENE12345",
    "templateId": "TEMPLATE12345"
  }
}