Add a payment instruction - Trace Finance

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

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

POST

/

v1

/

beneficiaries

/

{beneficiaryId}

/

payment-instructions

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

{
  "id": "ben-a1b2c3d4-5e6f-7890-abcd-ef1234567890",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entity": {
    "type": "INDIVIDUAL",
    "firstName": "João",
    "lastName": "Silva",
    "taxId": {
      "value": "52998224725",
      "type": "CPF"
    },
    "birthDate": "1985-03-15",
    "address": {
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "BR",
      "postalCode": "<string>"
    }
  },
  "paymentInstructions": [
    {
      "id": "pi-a1b2c3d4-5e6f-7890-abcd-ef1234567890",
      "asset": "BRL",
      "currentState": {
        "createdAt": "2023-11-07T05:31:56Z",
        "reason": {
          "code": "INSUFFICIENT_BALANCE",
          "message": "Insufficient balance for the requested operation",
          "details": {}
        }
      },
      "address": {
        "rail": "PIX_KEY",
        "dictKey": "john@example.com"
      },
      "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 key
PIX bank instruction
Crypto wallet

Payment instruction for receiving funds. Discriminated by rail.

rail

enum<string>

required

Available options:

PIX_KEY

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
BRL	2
USDT	6
USDC	6

Available options:

BRL,

USDT,

USDC

Example:

"BRL"

dictKeyType

enum<string>

required

DICT key type.

Available options:

CPF,

CNPJ,

EMAIL,

PHONE,

EVP

dictKey

string

required

DICT key value.

Example:

"john@example.com"

Response

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.

entity

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"

Upload a beneficiary document

Remove a payment instruction

⌘I