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.

Body Params
string
required

Name of the payout sender

string
enum
required

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

Allowed:
string

Description of the payout sender

metadata
object | null

Custom metadata object

string

Email address

string

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

string

Address line 1

string

Address line 2

string

City

string

State or province

string

Country code (ISO 3166-1 alpha-2)

string

ZIP or postal code

string

Phone number

string

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

string

Phone number in E.164 format

individual
object | null

Conditionally required: If type is 'individual', then this field is mandatory

company
object | null

Conditionally required: If type is 'company', then this field is mandatory

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; charset=utf-8