v1

latestOpenAPI 3.0.02026-07-26280204.9 KB

Payout Sender

Create Payout Sender

Create a payout sender to be used as the payer for payouts. The payout sender can be an individual or a company, serving as the source of funds for payouts.

Required fields: sender_name, type (must be "individual" or "company"). All other fields are optional.

Conditional requirements:

If type is "individual", provide an individual object with the required individual details.
If type is "company", provide a company object with the required company details.

Sender Party explained

As a merchant paying an invoice from a supplier through a bank transfer, the sender party is the merchant.
For a marketplace platform collecting funds from buyers and sending them to a third party, the source of funds is the buyer.
For a remittance company providing a platform for buyers to remit funds cross-border, the sender party is the buyer.
For a company making payroll payments to employees, the sender party is the company.

Depending on the market, sender party parameters may change. It is advisable to create a sender party for yourself if funds need to be sent to suppliers.

post/payout-sender

Request body

sender_namestring required

Name of the payout sender

type'individual' | 'company' required

Type of sender. Must be either 'individual' or 'company'

descriptionstring

Description of the payout sender

metadataobject nullable

Custom metadata object

emailstring email

Email address

organization_reference_idstring

A reference you can later use to identify this payout sender, such as an order number. Can only be alphanumeric and must be unique.

address_line1string

Address line 1

address_line2string

Address line 2

address_citystring

City

address_statestring

State or province

address_countrystring

Country code (ISO 3166-1 alpha-2)

address_zip_codestring

ZIP or postal code

phone_numberstring

Phone number

phone_country_codestring

Phone country code (e.g., +1, +61)

phone_number_e164string

Phone number in E.164 format

Example request

{
  "sender_name": "John Doe Enterprises",
  "type": "individual",
  "description": "Primary sender account",
  "metadata": {
    "internal_ref": "ref_001"
  },
  "email": "john@example.com",
  "organization_reference_id": "org_ref_123",
  "address_line1": "123 Main Street",
  "address_line2": "Suite 100",
  "address_city": "San Francisco",
  "address_state": "CA",
  "address_country": "US",
  "address_zip_code": "94105",
  "phone_number": "1234567890",
  "phone_country_code": "+1",
  "phone_number_e164": "+11234567890",
  "individual": {
    "first_name": "John",
    "last_name": "Doe",
    "dob": "1990-01-15",
    "nationality": "US",
    "country_of_residence": "US",
    "identification_type": "PASSPORT",
    "identification_custom_type": "",
    "identification_value": "AB1234567"
  },
  "company": null
}

Response

Created