Create Pix Payment by Bank Account
POST/v2/pix/payments/by-account/instant-billing
Initiate a new pix payment using a bank account. First, create a Decoded Pix Account ID at the endpoint /pix/payment/decode/by-account. Then, use the decoded_pix_account_id to enter the pix payment's information in the request body and execute.
Request
Header Parameters
- If there's no value: The default protection checks that the values in this request are equal: { method, params, path, query, body, userId }. This means that if a request repeats the same values, it will be blocked.
- 'nonce': The nonce and { method, params, path, query, body, userId } value are checked. When the protection schema is this, requests will be OK if this nonce value is different in each request.
- 'x-transaction-uuid': The transactionId and { method, params, path, query, body, userId } value are checked. Requests will be OK if this x-transaction-uuid value is different in each request.
- 'x-transaction-uuid&nonce' or 'nonce&x-transaction-uuid': The nonce, transactionId value and { method, params, path, query, body, userId } are checked, i.e. if requests are repeated the same value in both fields, they will be blocked. But if any field has a different value, the request is OK.
The replay-protection-schema allows the user to choose between 3 options:
The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.
Sender Wallet UUID (if empty, your default Wallet UUID will be settled)
The nonce ID is a UUID (v4) used to uniquely identify the requisition. All requisitions must have an identifier.
- application/json
Body
required
- NATURAL_PERSON.
- LEGAL_PERSON.
- CACC: Checking account.
- SLRY: Salary.
- SVGS: Savings.
Possible values: [NATURAL_PERSON
, LEGAL_PERSON
]
Person type:
Person's document (CPF or CNPJ).
Bank ISPB code (8 digits)
Account branch (4 digits).
Account number (between 1 and 20 digits).
Possible values: [CACC
, CASH
, CHAR
, CISH
, COMM
, CPAC
, LLSV
, LOAN
, MGLD
, MOMA
, NREX
, ODFT
, ONDP
, OTHR
, SACC
, SLRY
, SVGS
, TAXE
, TRAN
, TRAS
, CC
, PG
, CD
, CG
, CI
, PP
]
Account type:
Value in R$ cents.
Payment date.
User defined payment description.
Responses
- 201
- 400
- 401
- 422
Payment accomplished.
- application/json
- Schema
- Example (from schema)
Schema
Payment UUID.
Operation UUID. Used to get receipt and track the transaction. This will not be returned if the payment has been scheduled.
Possible values: [PENDING
, WAITING
, WAITING_DELAYED
, CONFIRMED
, ERROR
, FAILED
, CANCELED
, SCHEDULED
]
Payment state.
Value in R$ cents.
Schedule a day to execute payment. Use null to send payment right now.
User defined payment description.
Payment created date.
{
"id": "f6e2e084-29b9-4935-a059-5473b13033aa",
"operation_id": "f6e2e084-29b9-4935-a059-5473b13033aa",
"state": "PENDING",
"value": 1299,
"payment_date": null,
"description": "string",
"created_at": "2024-12-26T10:36:25.755Z"
}
If any required params are missing or has invalid format or type.
User authentication failed.
If any required params are missing or has invalid format or type.