Skip to main content
POST
cURL with fictitious data

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

Idempotency-Key
string
required

Client-generated key used to retry exactly the same request safely.

Required string length: 1 - 64
X-Account-Id
string
required

UUID of the account associated with the operation.

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

X-End-To-End-Id
string

Idempotency key — caller-supplied 32-char BCB endToEndId. Omit to let SPI generate one.

Example:

"E12345678202605061030abcdef12345"

Body

application/json
initiationId
string
required

Initiation UUID returned by step 1

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

amount
string

Confirmed amount (required unless locked by a static QR)

Example:

"100.00"

Response

Created

amount
string
required
Example:

"100.00"

createdAt
string<date-time>
required
Example:

"2026-05-06T10:30:00Z"

endToEndId
string
required
Example:

"E12345678202605061030abcdef12345"

id
string
required
Example:

"019606a2-4c5d-7e8f-90a1-345678901bcd"

status
string
required
Example:

"COMPLETED"

type
string
required
Example:

"OUTBOUND"

updatedAt
string<date-time>
required
Example:

"2026-05-06T10:30:05Z"

accountId
string
Example:

"019606a0-1a2b-7c3d-8e4f-567890123abc"

aliasId
string
alreadyRefundedAmount
string

Cross-mechanism settled and reserved refund amount. Returned only for INBOUND transfers.

Example:

"60.00"

currency
string
Example:

"BRL"

deletedAt
string<date-time>
description
string
Example:

"Pagamento de aluguel"

destination
object
feeCharge
object
initiatedAt
string<date-time>
Example:

"2026-05-06T10:30:00Z"

initiationType
string
Example:

"DICT"

ledger
object
metadata
object
paymentType
string
Example:

"PIX"

purpose
string
Example:

"IACT"

remainingRefundableAmount
string

Amount minus alreadyRefundedAmount. Returned only for INBOUND transfers and can be negative.

Example:

"40.00"

source
object
urgency
string
Example:

"HIGH"