Get all payins by type

GET 
/v1/payin

Tag: api-payments-gateway-get-payin-allDescription: Retrieve all payins for the authenticated user by payment type with optional country filter and pagination.

Request

Query Parameters

sort string

Page sort attribute.

page number

Page number, starting from 1. Default is 1.

country string

Possible values: [BRA, ARG, CHL, PER]

type stringrequired

Possible values: [CREDIT_CARD, DEBIT_CARD, CASH, BANK_TRANSFER]

Payment type filter. Use CREDIT_CARD or DEBIT_CARD for card payments, CASH for cash payments, or BANK_TRANSFER for bank transfer deposits.

Header Parameters

x-wallet-uuid string

Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

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

200

Payins retrieved successfully.

application/json

Schema

Schema

oneOf
V1GetAllAcquiringPaymentsResponse
page numberrequired
Page number.
page_size numberrequired
Page size.
page_total numberrequired
Page total.
total numberrequired
Total of elements.
data object[]required
List of acquiring payments.
Array [
id stringrequired
Payment ID.
user_id stringrequired
User ID of the merchant who performed the transaction.
operation_id string
Operation ID associated with the transaction.
wallet_id string
Wallet ID associated with the transaction.
country stringrequired
Country Of Transaction.
sales_channel stringrequired
Possible values: [POS, PDV, MPOS, PAYLINK, INTEGRATION, TAP_ON_PHONE, VIRTUAL_TERMINAL]
Payment Sales Channel.
payment_method stringrequired
Possible values: [DEBIT_CARD, CREDIT_CARD]
Payment Method.
amount numberrequired
Payment Value in cents.
currency_tag stringrequired
Possible values: [PEN, CLP, ARS, USD, BRL]
Payment Currency Tag.
status stringrequired
Possible values: [PENDING, WAITING, WAITING_THREE_DS, AUTHORIZED, EXPIRED, DECLINED, REVERTED, CANCELLATION_IN_PROGRESS, CANCELLED, SETTLED, REFUNDED, FAILED]
Transaction Status.
third_part_name stringrequired
Third Part Full Name.
third_part_email stringrequired
Third Part Email Address.
third_part_phone_number stringrequired
Third Part Phone Number.
third_part_document_type stringrequired
Possible values: [DNI, CE, PAS, PP, RUT, RUC, CUIL, CUIT, CPF, CNPJ]
Third Part Document Type.
third_part_document stringrequired
Third Part Document Number.
third_part_address_city stringrequired
Third Part Address City.
third_part_address_country stringrequired
Third Part Address Country.
third_part_address_state stringrequired
Third Part Address Federative Unit.
third_part_address_number stringrequired
Third Part Address Number.
third_part_address_street stringrequired
Third Part Address Street.
third_part_address_zip_code stringrequired
Third Part Address Zip Code.
third_part_address_complement string
Third Part Address Complement.
card_last_four_digits stringrequired
Last four digits of the card used.
installments numberrequired
Number of installments for the transaction.
authorized_date date-time
Transaction Confirmation Date.
declined_date date-time
Transaction Declined Date.
cancelled_date date-time
Transaction Cancelled Date.
settlement_date date-time
Transaction Settled Date.
cancelled_max_date date-time
Transaction Cancelled Max Date.
expected_settlement_date date-time
Expected External Settlement Date.
refunded_date date-time
Transaction Refunded Date.
payment_url string
Url to provide to customer to continue the payment.
redirect_url string
Redirect URL for payment success and error.
expiration_time_minutes number
Expected time in minutes for transaction expiration.
language string
Language code for the transaction, e.g., "en", "pt".
expiration_date date-time
Transaction Expiration Date.
created_at date-timerequired
Transaction creation date
updated_at date-timerequired
Transaction last update date
]
V1GetAllCashDepositsResponse
page numberrequired
Page number.
page_size numberrequired
Page size.
page_total numberrequired
Page total.
total numberrequired
Total of elements.
data object[]required
List of cash payments.
Array [
id stringrequired
Payment ID.
operation_id string
Operation ID associated with the transaction.
country objectrequired
Country of the transaction.
status objectrequired
Status of the transaction.
amount numberrequired
Amount of the transaction in cents.
currency_tag objectrequired
Currency of the transaction.
expiration_time_minutes number
Expiration time in minutes.
payment_url string
Url to provide to customer to continue the payment.
third_part_name stringrequired
Third part name.
third_part_last_name stringrequired
Third part last name.
third_part_email stringrequired
Third part email.
third_part_phone stringrequired
Third part phone.
third_part_document stringrequired
Third part document.
third_part_document_type objectrequired
Third part document type.
third_part_address_zip_code stringrequired
Third part address zip code.
third_part_address_street stringrequired
Third part address street.
third_part_address_number stringrequired
Third part address number.
third_part_address_city stringrequired
Third part address city.
third_part_address_state stringrequired
Third part address state.
third_part_address_country stringrequired
Third part address country.
third_part_address_complement string
Third part address complement.
redirect_url stringrequired
Redirect URL for payment success and error.
expiration_date date-time
Expiration date.
authorized_date date-time
Authorized date.
refunded_date date-time
Refunded date.
settlement_date date-time
Settlement date.
failed_date date-time
Failed date.
created_at date-timerequired
Created at.
updated_at date-timerequired
Updated at.
]
V1GetAllBankTransferDepositsResponse
page numberrequired
Page number.
page_size numberrequired
Page size.
page_total numberrequired
Page total.
total numberrequired
Total of elements.
data object[]required
List of bank transfer deposits.
Array [
id stringrequired
Deposit ID.
user_id stringrequired
User ID associated with the deposit.
wallet_id string
Wallet ID associated with the deposit.
operation_id string
Operation ID associated with the deposit.
country objectrequired
Country of the deposit.
status objectrequired
Status of the deposit.
amount numberrequired
Amount of the deposit.
currency_tag stringrequired
Currency tag of the deposit.
expiration_time_minutes numberrequired
Expiration time in minutes.
payment_url string
Url to provide to customer to continue the payment.
language objectrequired
Language preference for the deposit process.
third_part_name stringrequired
Third party's first name.
third_part_last_name stringrequired
Third party's last name.
third_part_email string
Third party's email address.
third_part_phone stringrequired
Third party's phone number.
third_part_document stringrequired
Third party's document number.
third_part_document_type stringrequired
Third party's document type.
third_part_address_zip_code stringrequired
Third party's address zip code.
third_part_address_street stringrequired
Third party's address street.
third_part_address_number stringrequired
Third party's address number.
third_part_address_city stringrequired
Third party's address city.
third_part_address_state stringrequired
Third party's address state.
third_part_address_country stringrequired
Third party's address country.
third_part_address_complement string
Third party's address complement.
expiration_date date-timerequired
Date when the expiration occurs.
authorized_date date-timerequired
Date when the deposit was authorized.
refunded_date date-timerequired
Date when the deposit refund.
settlement_date date-timerequired
Date when the settlement occurred.
scheduled_settlement_date date-timerequired
Date when the scheduled settlement will occur.
created_at date-timerequired
Creation date of the deposit record.
updated_at date-timerequired
Last update date of the deposit record.
redirect_url stringrequired
Redirect URL for payment success and error.
]

Example (from schema)

{}

acquiring

Acquiring Payments Response (type=ACQUIRING)

{
  "page": 1,
  "page_size": 20,
  "page_total": 5,
  "total": 100,
  "data": [
    {
      "id": "0197b169-da6b-7ba2-b053-ce413ae39afd",
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "operation_id": "456e7890-e12b-34d5-a678-426614174001",
      "wallet_id": "789e0123-e45b-67d8-a901-426614174002",
      "country": "BR",
      "sales_channel": "INTEGRATION",
      "payment_method": "CREDIT_CARD",
      "amount": 10000,
      "currency_tag": "BRL",
      "status": "AUTHORIZED",
      "third_part_name": "John Doe",
      "third_part_email": "john.doe@example.com",
      "third_part_phone_number": "+5511999998888",
      "third_part_document_type": "CPF",
      "third_part_document": "12345678901",
      "third_part_address_city": "São Paulo",
      "third_part_address_country": "BR",
      "third_part_address_state": "SP",
      "third_part_address_number": "123",
      "third_part_address_street": "Avenida Paulista",
      "third_part_address_zip_code": "01311000",
      "third_part_address_complement": "Apto 101",
      "card_last_four_digits": "1234",
      "installments": 1,
      "authorized_date": "2023-01-01T12:00:00.000Z",
      "declined_date": null,
      "cancelled_date": null,
      "settlement_date": "2023-01-02T12:00:00.000Z",
      "cancelled_max_date": null,
      "expected_settlement_date": "2023-01-02T12:00:00.000Z",
      "refunded_date": null,
      "created_at": "2023-01-01T10:00:00.000Z",
      "updated_at": "2023-01-01T11:00:00.000Z"
    }
  ]
}

cash

Cash Deposits Response (type=CASH)

{
  "page": 1,
  "page_size": 20,
  "page_total": 3,
  "total": 50,
  "data": [
    {
      "id": "0197b169-da6b-7ba2-b053-ce413ae39afd",
      "operation_id": "456e7890-e12b-34d5-a678-426614174001",
      "country": "ARG",
      "status": "PENDING",
      "amount": 5000,
      "currency_tag": "PEN",
      "expiration_time_minutes": 10,
      "payment_url": "https://example.com/deposit/0197b169-da6b-7ba2-b053-ce413ae39afd",
      "third_part_name": "Jane",
      "third_part_last_name": "Smith",
      "third_part_email": "jane.smith@example.com",
      "third_part_phone": "+54123456789",
      "third_part_document": "87654321",
      "third_part_document_type": "DNI",
      "third_part_address_zip_code": "2000",
      "third_part_address_street": "Av. Santa Fe",
      "third_part_address_number": "456",
      "third_part_address_city": "Rosario",
      "third_part_address_state": "SF",
      "third_part_address_country": "AR",
      "third_part_address_complement": "Piso 2",
      "redirect_url": "https://example.com/success",
      "expiration_date": "2023-10-01T12:10:00.000Z",
      "authorized_date": null,
      "refunded_date": null,
      "settlement_date": null,
      "failed_date": null,
      "created_at": "2023-10-01T12:00:00.000Z",
      "updated_at": "2023-10-01T12:00:00.000Z"
    }
  ]
}

bankTransfer

Bank Transfer Deposits Response (type=BANK_TRANSFER)

{
  "page": 1,
  "page_size": 20,
  "page_total": 2,
  "total": 25,
  "data": [
    {
      "id": "0197b169-da6b-7ba2-b053-ce413ae39afd",
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "wallet_id": "223e4567-e89b-12d3-a456-426614174000",
      "operation_id": "456e7890-e12b-34d5-a678-426614174001",
      "country": "ARG",
      "status": "PENDING",
      "amount": 10000,
      "currency_tag": "USD",
      "expiration_time_minutes": 10,
      "payment_url": "https://bank.example.com/transfer/0197b169-da6b-7ba2-b053-ce413ae39afd",
      "language": "en",
      "third_part_name": "Carlos",
      "third_part_last_name": "Garcia",
      "third_part_email": "carlos.garcia@example.com",
      "third_part_phone": "+54123456789",
      "third_part_document": "11223344",
      "third_part_document_type": "DNI",
      "third_part_address_zip_code": "3000",
      "third_part_address_street": "Av. San Martin",
      "third_part_address_number": "789",
      "third_part_address_city": "Cordoba",
      "third_part_address_state": "CB",
      "third_part_address_country": "AR",
      "third_part_address_complement": "Depto 3B",
      "expiration_date": "2023-10-01T12:10:00.000Z",
      "authorized_date": null,
      "refunded_date": null,
      "settlement_date": null,
      "scheduled_settlement_date": "2023-10-02T12:00:00.000Z",
      "created_at": "2023-10-01T12:00:00.000Z",
      "updated_at": "2023-10-01T12:00:00.000Z",
      "redirect_url": "https://example.com/my-home-page"
    }
  ]
}

400

If any required params are missing or has invalid format or type.

401

User authentication failed.

422

If any required params are missing or has invalid format or type.

Loading...