Sign in

v1

latestOpenAPI 3.0.02026-07-26280204.9 KB
Payout Sender

Validate Payout Sender

Validates a payout sender (either an existing one by ID, or inline sender data) against a specific payout method's required fields.

Validate sender details using either the payout_sender_id or the provided payout_sender object details.

Note: Provide either payout_sender_id (to validate an existing sender) OR payout_sender (to validate inline data) — not both. payout_method_name is always required.

post/payout-sender/validate

Request body

payout_method_namestring required

Payout method name (required)

payout_sender_idstring

Payout sender ID to validate an existing sender (optional)

Example request

{
  "payout_method_name": "bank_transfer_sg",
  "payout_sender": {
    "sender_name": "John Doe Enterprises",
    "type": "individual",
    "email": "john@example.com",
    "address_line1": "123 Orchard Road",
    "address_city": "Singapore",
    "address_country": "SGP",
    "address_zip_code": "238858",
    "phone_number": "91234567",
    "phone_country_code": "+65",
    "phone_number_e164": "+6591234567",
    "individual": {
      "first_name": "John",
      "last_name": "Doe",
      "dob": "1990-01-15",
      "nationality": "SGP",
      "country_of_residence": "SGP",
      "identification_type": "PASSPORT",
      "identification_value": "AB1234567"
    }
  }
}

Response

OK