Get pix operation data by idempotencyKey.

get https://accounts.voluti.com.br/api/v2/pix/payments/idempotencyKey/{idempotencyKey}

Responses

Response body

object

data

object

number

idempotencyKey

string

endToEndId

string

The "endToEndId" field refers to a unique identifier that can be used to track and associate a specific transaction throughout the lifecycle of the operation. The term "end-to-end" pertains to the ability to trace the transaction from beginning to end, ensuring data integrity along the way.

pixKey

string

The allowed key types include: CPF, CNPJ, email address, phone number (including country and area codes), and EVP (random key).

transactionType

string

PIX BILLETS

status

string

CANCELED PROCESSING, LIQUIDATED, WAITING_CONFIRMATION, ON_QUEUE, REFUNDED, PARTIALLY_REFUNDED, WAITING_SETTLEMENTCORE

errorCode

string

Possible errors and their descriptions:

Code	Description
AB03	Settlement aborted due to timeout.
AB09	Transaction stopped due to error at the Creditor Agent.
AB11	Transaction stopped due to timeout at the Debtor Agent.
AC03	Creditor account number invalid or missing.
AC06	Account specified is blocked, prohibiting posting of transactions against it.
AC07	Creditor account number closed.
AC14	Creditor account type missing or invalid.
AG03	Transaction type not supported/authorized on this account.
AG12	Payment orders made by transferring funds from one account to another at the same financial institution (bank or payment institution) are not allowed.
AG13	Returned payments derived from previously returned transactions are not allowed.
AGNT	Agent in the payment workflow is incorrect.
AM01	Specified message amount is equal to zero.
AM02	Specific transaction/message amount is greater than allowed maximum.
AM04	Amount of funds available to cover specified message amount is insufficient.
AM09	Amount received is not the amount agreed or expected.
AM12	Amount is invalid or missing.
AM18	Number of transactions is invalid or missing. Generic usage if cannot specify between group and payment information levels.
BE01	Identification of end customer is not consistent with associated account number.
BE05	Party who initiated the message is not recognised by the end customer.
BE17	Creditor or Ultimate Creditor identification code missing or invalid.
CH11	Value in Creditor Identifier is incorrect.
CH16	Content is incorrect.
DS04	The order was rejected by the bank side (for reasons concerning content).
DS0G	Signer is not allowed to sign this operation type.
DS24	Waiting time expired due to incomplete order.
DS27	The user is not yet activated.
DT02	Invalid creation date and time in Group Header (e.g., historic date).
DT05	Associated message, payment information block or transaction was received after agreed processing cut-off date, i.e., date in the past.
ED05	Settlement of the transaction has failed.
FF07	Purpose is missing or invalid.
FF08	End to End Id missing or invalid.
MD01	No Mandate.
OZ01	Insufficient balance.
RC09	Debtor ClearingSystemMember identifier is invalid or missing.
RC10	Creditor ClearingSystemMember identifier is invalid or missing.
RR04	Regulatory Reason.
SL02	Due to specific service offered by the Creditor Agent.

AB03 AB09 AB11 AC03 AC06 AC07 AC14 AG03 AG12 AG13 AGNT AM01 AM02 AM04 AM09 AM12 AM18 BE01 BE05 BE17 CH11 CH16 DS04 DS0G DS24 DS27 DT02 DT05 ED05 FF07 FF08 MD01 OZ01 RC09 RC10 RR04 SL02

creditDebitType

string

CREDIT DEBIT

localInstrument

string

createdAt

date-time

creditorAccount

object

debtorAccount

object

remittanceInformation

string

It must be filled in whenever the paying user includes any additional information in a payment to be sent to the recipient.

txId

string

The txId is generated by the Pix system and serves to uniquely identify and monitor transactions.

payment

object

refunds

array of objects

refunds

object

endToEndId

string

status

string

CANCELED PROCESSING, LIQUIDATED, WAITING_CONFIRMATION, ON_QUEUE, REFUNDED, PARTIALLY_REFUNDED, WAITING_SETTLEMENTCORE

errorCode

string

Possible errors and their descriptions:

Code	Description
AB03	Settlement aborted due to timeout.
AB09	Transaction stopped due to error at the Creditor Agent.
AB11	Transaction stopped due to timeout at the Debtor Agent.
AC03	Creditor account number invalid or missing.
AC06	Account specified is blocked, prohibiting posting of transactions against it.
AC07	Creditor account number closed.
AC14	Creditor account type missing or invalid.
AG03	Transaction type not supported/authorized on this account.
AG12	Payment orders made by transferring funds from one account to another at the same financial institution (bank or payment institution) are not allowed.
AG13	Returned payments derived from previously returned transactions are not allowed.
AGNT	Agent in the payment workflow is incorrect.
AM01	Specified message amount is equal to zero.
AM02	Specific transaction/message amount is greater than allowed maximum.
AM04	Amount of funds available to cover specified message amount is insufficient.
AM09	Amount received is not the amount agreed or expected.
AM12	Amount is invalid or missing.
AM18	Number of transactions is invalid or missing. Generic usage if cannot specify between group and payment information levels.
BE01	Identification of end customer is not consistent with associated account number.
BE05	Party who initiated the message is not recognised by the end customer.
BE17	Creditor or Ultimate Creditor identification code missing or invalid.
CH11	Value in Creditor Identifier is incorrect.
CH16	Content is incorrect.
DS04	The order was rejected by the bank side (for reasons concerning content).
DS0G	Signer is not allowed to sign this operation type.
DS24	Waiting time expired due to incomplete order.
DS27	The user is not yet activated.
DT02	Invalid creation date and time in Group Header (e.g., historic date).
DT05	Associated message, payment information block or transaction was received after agreed processing cut-off date, i.e., date in the past.
ED05	Settlement of the transaction has failed.
FF07	Purpose is missing or invalid.
FF08	End to End Id missing or invalid.
MD01	No Mandate.
OZ01	Insufficient balance.
RC09	Debtor ClearingSystemMember identifier is invalid or missing.
RC10	Creditor ClearingSystemMember identifier is invalid or missing.
RR04	Regulatory Reason.
SL02	Due to specific service offered by the Creditor Agent.

pixRefundAmount

object

503

Service unavailable

504

Gateway timeout

Language

Credentials

OAuth2

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://accounts.voluti.com.br/api/v2/pix/payments/idempotencyKey/idempotencyKey \
3
     --header 'accept: application/json'


xxxxxxxxxx
44
}
1
{
2
  "data": {
3
    "id": 0,
4
    "idempotencyKey": "string",
5
    "endToEndId": "string",
6
    "pixKey": "+552199999999",
7
    "transactionType": "PIX",
8
    "status": "CANCELED",
9
    "errorCode": "AB03",
10
    "creditDebitType": "CREDIT",
11
    "createdAt": "2025-04-11T09:53:42.804Z",
12
    "creditorAccount": {
13
      "ispb": "string",
14
      "issuer": "string",
15
      "number": "string",
16
      "accountType": "SLRY",
17
      "document": "string",
18
      "name": "string"
19
    },
20
    "debtorAccount": {
21
      "ispb": "string",
22
      "issuer": "string",
23
      "number": "string",
24
      "accountType": "SLRY",
25
      "document": "string",

200Success

400Bad request

401Unauthorized

403Access denied

404Resource not found

429Rate limit exceeded

500Internal server error