Skip to main content
POST
Request transfer

Authorizations

Authorization
string
header
required

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

Body

application/json
amount
integer
required

Gross amount of the transfer, in cents (R$ 500.00 = 50000).

Required range: x > 0
idempotencyKey
string
required

Unique key of this request. Resending with the same key returns the transfer already created, without duplication.

Required string length: 1 - 255
pixKey
string

Does not define the destination. The transfer is always credited to the bank account registered for the account.

Minimum string length: 1
description
string

Free-text description recorded on the transfer.

Maximum string length: 255

Response

Transfer requested.

Transfer requested.

success
boolean
required

Always true in a successful response.

data
object
required