Add a payment instruction

Adds a payment instruction to an existing beneficiary.

POST /api/beneficiaries/{beneficiaryId}/payment-instructions

cURL

pix

curl --request POST \ --url https://api.sandbox.tracefinance.com/api/beneficiaries/{beneficiaryId}/payment-instructions \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'X-Idempotency-Key: <x-idempotency-key>' \ --data ' { "type": "PIX", "asset": "BRL", "dictKeyType": "CPF", "dictKey": "12345678900" } '

201

Example

{ "id": "ben-a1b2c3d4-5e6f-7890-abcd-ef1234567890", "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "holder": { "type": "INDIVIDUAL", "firstName": "João", "lastName": "Silva", "taxId": { "value": "52998224725", "type": "CPF" }, "dateOfBirth": "1985-03-15", "address": { "addressLine1": "<string>", "addressLine2": "<string>", "city": "<string>", "state": "<string>", "country": "BR", "postalCode": "<string>" } }, "relationshipType": "SELF_OWNED", "paymentInstructions": [ { "id": "pi-a1b2c3d4-5e6f-7890-abcd-ef1234567890", "asset": "BRL", "currentState": { "status": "PENDING_REVIEW", "createdAt": "2023-11-07T05:31:56Z", "reason": { "code": "INSUFFICIENT_BALANCE", "message": "Insufficient balance for the requested operation", "details": {} } }, "address": { "rail": "PIX_KEY", "dictKeyType": "CPF", "dictKey": "[e-mail]" }, "createdAt": "2026-04-14T10:30:00Z" } ], "createdAt": "2026-04-14T10:30:00Z", "updatedAt": "2026-04-14T10:30:00Z" }

Authorizations

Authorization · string · header · required

JWT bearer token. Include as Authorization: Bearer <token>. See the Authentication guide for how to obtain one.

Headers

X-Idempotency-Key · string<uuid> · required

Unique key to ensure idempotent request processing. Required on all POST, PUT, and PATCH requests.

X-Trace-Version · string

API version. Omit to use the default version.

Example:

"1"

Path Parameters

beneficiaryId · string<uuid> · required

UUID of the beneficiary.

Body

application/json

PIX

Bank account

Crypto wallet

Payment instruction for receiving funds. Discriminated by type.

type · enum<string> · required

Available options: PIX

asset · enum<string> · required

ISO 4217 currency code or stablecoin ticker. The maximum decimal scale of an AmountValue paired with this asset depends on the asset:

Asset	Decimals	Asset	Decimals
USD	2	NZD	2
BRL	2	CHF	2
EUR	2	NOK	2
CAD	2	DKK	2
AUD	2	PLN	2
GBP	2	SEK	2
MXN	2	USDC	6
HKD	2	USDT	6
SGD	2	EURC	6
PHP	2	BRLT	6

Available options: USD, BRL, EUR, CAD, AUD, GBP, MXN, HKD, SGD, PHP, NZD, CHF, NOK, DKK, PLN, SEK, USDC, USDT, EURC, BRLT

Example:

"BRL"

dictKeyType · enum<string> · required

DICT key type.

Available options: CPF, CNPJ, EMAIL, PHONE, EVP

dictKey · string · required

DICT key value.

Example:

"[e-mail]"

Response

201

application/json

Payment instruction added. Returns the full beneficiary.

An external beneficiary registered for withdrawals.

id · string<uuid> · required · read-only

Example:

"ben-a1b2c3d4-5e6f-7890-abcd-ef1234567890"

customerId · string<uuid> · required

Customer that owns this beneficiary.

holder · Individual · object · required

The person or company that receives funds. Discriminated by type.

Individual

Company

Show child attributes

relationshipType · enum<string> · required

Whether the beneficiary is the customer themselves (SELF_OWNED) or a separate party (THIRD_PARTY).

Available options: SELF_OWNED, THIRD_PARTY

paymentInstructions · object[] · required

Show child attributes

createdAt · string<date-time> · required · read-only

Example:

"2026-04-14T10:30:00Z"

updatedAt · string<date-time> · required · read-only

Example:

"2026-04-14T10:30:00Z"