Infopago API Documentation

Infopago API

Get customer account transactions.

GET

/accounts/transactions/

Accounts

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://infopago.apidog.io//accounts/transactions/?event_date_start&event_date_end'

Response Example

200 - Exemplo 1

{
    "meta": {
        "total": 100,
        "limit": 10,
        "offset": 1
    },
    "data": [
        {
            "eventDate": "2019-08-24T14:15:22Z",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "status": "CANCELED",
            "endToEndId": "string",
            "txId": "string",
            "creditDebitType": "CREDIT",
            "transactionType": "PIX",
            "transactionAmount": {
                "currency": "BRL",
                "available": 0
            }
        }
    ]
}

Requisição

Parâmetros Query

event_date_start

string <date-time>

requerido

Minimal date of query range (ISO 8601)

event_date_end

string <date-time>

requerido

Maximal date of query range (ISO 8601)

page_offset

integer

opcional

Start position in pagination

>= 1

Padrão:

1

page_limit

integer

opcional

Maximum resources per page

>= 1<= 100

Padrão:

10

sort_by

enum<string>

opcional

Parameter using to sort data

Valores permitidos:

EVENT_DATEAMOUNT

Padrão:

EVENT_DATE

sort_order

enum<string>

opcional

Define order direction

Valores permitidos:

ASCDESC

Padrão:

ASC

filter

string

opcional

Filter transactions by payer or payee document number

Respostas

🟢200OK

application/json

Successful

Body

meta

object (MetaPagination)

opcional

The pagination object is used to paginate the results of a request. It contains information about the total number of items available, the number of items returned in the response, the number of items per page, and the current page number.

total

integer <int32>

opcional

Padrão:

100

limit

integer <int32>

opcional

Padrão:

10

offset

integer <int32>

opcional

Padrão:

1

data

array [object {8}]

opcional

eventDate

string <date-time>

opcional

id

string <uuid>

opcional

status

enum<string>

opcional

Valores permitidos:

CANCELEDPROCESSING,LIQUIDATED,REFUNDED,PARTIALLY_REFUNDED,

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.

txId

string

opcional

The "txId" field is a unique identifier generated by the Pix system to uniquely identify and monitor transactions.

creditDebitType

enum<string>

opcional

Valores permitidos:

CREDITDEBIT

transactionType

enum<string>

opcional

Valores permitidos:

PIXBILLET

transactionAmount

object

opcional

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable

🔴504Gateway Timeout

Página anterior

Get an access token.

Próxima página

Get details of transaction.