Skip to main content
POST
/
v1
/
transfers
Creates a batch of PIX transfers.
curl --request POST \
  --url https://api.example.com/v1/transfers \
  --header 'Content-Type: application/json' \
  --header 'x-access-id: <api-key>' \
  --data '
{
  "transfers": [
    {
      "pix_key": "<string>",
      "amount_in_cents": 123,
      "external_reference_id": "<string>",
      "name": "<string>",
      "tax_id": "<string>",
      "account_type": "<unknown>",
      "display_description": "<string>"
    }
  ]
}
'
{
  "batch": {
    "created_at": "2023-11-07T05:31:56Z",
    "id": 123,
    "idempotency_key": "<string>",
    "origin_bank_account_id": 123,
    "payment_type": "pix_transfer",
    "status": "created",
    "total_amount_in_cents": 123,
    "total_items": 123
  },
  "transfers": [
    {
      "amount_in_cents": 123,
      "beneficiary": {
        "pix_key": "<string>",
        "name": "<string>",
        "tax_id": "<string>",
        "account_type": "<unknown>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "external_reference_id": "<string>",
      "id": 123,
      "status": "awaiting_approval",
      "display_description": "<string>"
    }
  ]
}

Authorizations

x-access-id
string
header
required

UUID of the service account (e.g., 550e8400-e29b-41d4-a716-446655440000)

Headers

X-Idempotency-Key
string | null

Optional idempotency key for safe retries. When provided, requests with the same key return the same result. Without this header, duplicate external_reference_id values will fail with 400 Bad Request.

Body

application/json
transfers
object[]
required

Response

Transfers batch created successfully

batch
object
required
transfers
object[]
required