Skip to main content
POST
/
v2
/
transfers
Create a Transfer
curl --request POST \
  --url https://api.pagou.ai/v2/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pix_key_type": "CPF",
  "pix_key_value": "<string>",
  "amount": 4503599627370546,
  "description": "<string>",
  "external_ref": "<string>",
  "notify_url": "<string>"
}
'
{}

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 100 (R$1.00).

Required range: 100 <= 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<uri> | null

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

Response

Success

Generic success response payload.