Skip to main content

Get all payments

GET 
/v1/payments
Description: Retrieve payments for the authenticated user with pagination and sorting options.

Request​

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort string

    Possible values: [created_at]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

    x-product-uuid string

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

Payments retrieved successfully.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Payment data

  • Array [
    • id stringrequired

    Payment ID

    sales_channel stringrequired

    Possible values: [POS, PDV, MPOS, PAYLINK, INTEGRATION, TAP_ON_PHONE, VIRTUAL_TERMINAL]

    Sales channel used for the payment

    transaction_method stringrequired

    Possible values: [CNP, CP]

    Payment method (Card Present or Card Not Present)

    payment_method stringrequired

    Possible values: [DEBIT, CREDIT]

    Payment method used

    amount_local numberrequired

    Payment value in local currency in cents

    amount_original numberrequired

    Payment value in original currency in cents

    amount_iof numberrequired

    IOF (Tax on Financial Operations) amount

    currency_local stringrequired

    Currency used for the payment in local market

    currency_original stringrequired

    Original currency of the payment

    currency_rate numberrequired

    Exchange rate applied to the payment

    status stringrequired

    Possible values: [PENDING, AUTHORIZED, REVERTED, CANCELLED, SETTLED]

    Current payment status

    buyer_name stringrequired

    Buyer full name

    buyer_email stringrequired

    Buyer email address

    buyer_address objectrequired

    Buyer address information

    buyer_phone_number stringrequired

    Buyer phone number

    buyer_document_type stringrequired

    Possible values: [CPF, CNPJ]

    Buyer document type

    buyer_document stringrequired

    Buyer document number

    card_last_numbers stringrequired

    Last four digits of the card used

    installments numberrequired

    Number of installments for the payment

    refund_id stringrequired

    Refund ID if payment was refunded

    chargeback_id stringrequired

    Chargeback ID if payment was charged back

    creation_date date-timerequired

    Payment creation date

    last_update_date date-timerequired

    Payment last update date

    confirmation_date date-timerequired

    Payment confirmation date

    expected_settlement_date date-timerequired

    Expected settlement date

  • ]
Loading...