Skip to main content
POST
Create counterparty split recipient

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

counterparty_id
string<uuid>
required

Counterparty ID Unique identifier

Body

application/json

The create counterparty split recipient attributes

Body params counterparty split recipient data

ref_type
enum<string>
required

Counterparty split recipient reference type

Available options:
bank_account,
pix_key
ref_bank_account
Counterparty split recipient ref bank account params · object

Bank account information. Required when ref_type is bank_account

Example:
ref_pix_key
Counterparty split recipient ref pix key params · object

Pix key information. Required when ref_type is pix_key

Example:

Response

CounterpartySplitRecipient

Body response of the counterparty split recipient

data
Counterparty split recipient response params · object

Counterparty split recipient data

Example: