INinfiniaweb
Payins

List Payments

Changed on

Retrieve a paginated list of payins.

get/

Request

  • Base URL
    https://app2test.infiniaweb.com/infinia_api/v1/payments
  • URL
    https://app2test.infiniaweb.com/infinia_api/v1/payments/
  • Auth
    HTTP basic

Query parameters

pageNumberinteger

Page number

pageSizeinteger

Page size

dateFromstring date-time
dateTostring date-time
status'AWAITING' | 'EXPIRED' | 'COMPLETED' | 'ERROR' | 'PARTIALLY_REFUNDED' | 'REFUNDED'
market'BR' | 'AR' | 'CO' | 'CL' | 'BO' | 'PY' | 'SG' | 'PE' | 'MX' | 'UY' | 'US' | 'EU' | 'XX' | 'GB'
type'ONLINE' | 'OFFLINE' | 'PULL' | 'PIX' | 'PIX_ITP' | 'PLEXO' | 'QR'
includeChildCompaniesboolean
referencestring
paymentIdstring
limitinteger
cursorstring

Headers

x-company-idinteger

ID of a child company for authentication. If not provided, the parent company will be authenticated.

Response

Successful Response

next_cursorstring
has_moreboolean
status'success'
page_numberinteger required

Page number

page_sizeinteger required

Page size

total_pagesinteger required

Total pages

total_paymentsinteger required

Total payments

Changes

  • 9d06fde6b2baRevision changes
    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      api operation id v1_2_list_claims removed and replaced with v1_list_payments__get

    • info

      api tag Payins added

    • info

      api tag Claims removed

    • info

      added the new optional query request parameter dateFrom

    • info

      added the new optional query request parameter dateTo

    • info

      added the new optional query request parameter includeChildCompanies

    • info

      added the new optional query request parameter market

    • info

      added the new optional query request parameter pageNumber

    • info

      added the new optional query request parameter pageSize

    • info

      added the new optional query request parameter paymentId

    • info

      added the new optional query request parameter reference

    • info

      added the new optional query request parameter status

    • info

      added the new optional query request parameter type

    • info

      deleted the query request parameter page_number with deprecation

    • info

      deleted the query request parameter page_size with deprecation

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added to the / response property anyOf list for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status