Skip to main content
POST
Create counterparty 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.

Headers

Trio-Version
enum<string>
required

Version of the v2 contract the client is written against. Each breaking change publishes a new version.

Available options:
2026-10-19.v2
Trio-Target-Org-Id
string<uuid>

ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.

Body

application/json

The create counterparty recipient attributes

Body params to create a counterparty recipient

name
string
required

Name of the counterparty

ref_type
enum<string>
required

How the recipient is referenced

Available options:
pix_key,
bank_account_detailed
tax_number
string
required

Tax number of the counterparty

branch
string | null

Bank account branch. Required when ref_type is bank_account_detailed

digit
string | null

Bank account digit. Required when ref_type is bank_account_detailed

ispb
string | null

Bank account ispb. Required when ref_type is bank_account_detailed

number
string | null

Bank account number. Required when ref_type is bank_account_detailed

pix_key
string | null

Pix key. Required when ref_type is pix_key

type
string

Type of the counterparty bank account

Response

CounterpartyRecipient

data
Counterparty recipient data · object

Body response of the counterparty recipient

Example: