Infopago API Documentation

Infopago API

Get transaction details by idempotency key.

GET

/pix/payments/idempotencyKey/{idempotencyKey}

Pix

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://infopago.apidog.io//pix/payments/idempotencyKey/'

Response Example

200 - Exemplo 1

{
    "data": {
        "id": 0,
        "idempotencyKey": "string",
        "endToEndId": "string",
        "pixKey": "string",
        "transactionType": "PIX",
        "status": "CANCELED",
        "errorCode": "AB03",
        "creditDebitType": "CREDIT",
        "localInstrument": "MANU",
        "createdAt": "2019-08-24T14:15:22Z",
        "creditorAccount": {
            "ispb": "string",
            "issuer": "string",
            "number": "string",
            "accountType": "SLRY",
            "document": "string",
            "name": "string"
        },
        "debtorAccount": {
            "ispb": "string",
            "issuer": "string",
            "number": "string",
            "accountType": "SLRY",
            "document": "string",
            "name": "string"
        },
        "remittanceInformation": "string",
        "txId": "string",
        "payment": {
            "currency": "BRL",
            "amount": 0
        },
        "refunds": [
            {
                "endToEndId": "string",
                "status": "CANCELED",
                "errorCode": "AB03",
                "pixRefundAmount": {
                    "currency": "BRL",
                    "amount": 0
                }
            }
        ]
    }
}

Requisição

Parâmetros Path

idempotencyKey

string

requerido

Idempotency Key of the pix

Respostas

🟢200OK

application/json

Success

Body

data

object (PixDataProperties)

opcional

number

opcional

idempotencyKey

string

opcional

The idempotency key is a unique identifier associated with each request. By using this key, the system can identify whether a request with the same key has been processed previously, avoiding duplication.

endToEndId

string

opcional

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

opcional

transactionType

enum<string>

opcional

Valores permitidos:

PIXBILLET

status

enum<string>

opcional

Valores permitidos:

CANCELEDPROCESSING,LIQUIDATED,REFUNDED,PARTIALLY_REFUNDED,

errorCode

PixErrorCode

opcional

creditDebitType

enum<string>

opcional

Valores permitidos:

CREDITDEBIT

localInstrument

LocalInstrumentType

opcional

createdAt

string <date-time>

opcional

creditorAccount

object (CreditorData)

opcional

debtorAccount

object (DebtorData)

opcional

remittanceInformation

string

opcional

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

txId

string

opcional

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

payment

object

opcional

refunds

array [object {4}]

opcional

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable

🔴504Gateway Timeout

Página anterior

Get transaction details by end-to-end-id.

Próxima página

Get pix payment receipt in PDF format.