Skip to main content
POST
Create a Transfer

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
pix_key_type
enum<string>
required

Type of the PIX key that identifies the recipient account.

Available options:
CPF,
CNPJ,
EMAIL,
PHONE,
EVP
pix_key_value
string
required

Value of the PIX key corresponding to the selected pix_key_type.

Required string length: 1 - 77
amount
integer
required

Transfer amount in cents. Minimum of 1000 (10.00).

Required range: 1000 <= x <= 9007199254740991
description
string

Optional description for the transfer, shown in reports and statements.

Maximum string length: 140
external_ref
string

Optional idempotency key or external reference from your system. If omitted, a value is generated automatically.

Maximum string length: 100
notify_url
string | null

Optional HTTPS URL that will receive webhook notifications for this transfer.

Maximum string length: 2048
origin
string | null

Optional origin identifier for the transfer (e.g. your platform name or channel).

Maximum string length: 50

Response

Existing transfer returned

success
boolean
required
requestId
string
required

Request correlation identifier.

data
object
required

Public transfer returned by create, retrieve, and cancel operations.