Get all payout

GET 
/v1/payout

Tag: api-payments-gateway-get-payout-allDescription: Retrieve all payouts for the authenticated user by payout type, with an optional country filter and pagination.

Request

Query Parameters

page number

Page number, starting from 1. Default is 1.

sort string

Field to sort the results by.

country stringrequired

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

type stringrequired

Possible values: [BANK_TRANSFER, YAPE]

Payment method type

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

Payouts retrieved successfully.

application/json

Schema

Schema

oneOf
V1GetAllBankTransferPaymentsResponse
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 payments.
Array [
id stringrequired
Payout 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.
currency_tag objectrequired
Currency tag of the transaction.
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 objectrequired
Third part 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.
third_part_bank_code stringrequired
Third party's bank code.
third_part_bank_name string
Third party's bank name.
third_part_account_type stringrequired
Possible values: [SA, CA, CP]
Third party's account type.
third_part_account_number stringrequired
Third party's account number.
authorized_date date-time
Date when the transaction was authorized.
failed_date date-time
Date when the transaction failed.
created_at date-timerequired
Creation date of the transaction record.
updated_at date-timerequired
Last update date of the transaction record.
]
V1GetAllYapeWalletPaymentsResponse
page numberrequired
Page number.
page_size numberrequired
Page size.
page_total numberrequired
Page total.
total numberrequired
Total of elements.
data object[]required
List of Yape wallet payments.
Array [
id stringrequired
Payout ID.
operation_id string
Operation ID associated with the transaction.
country stringrequired
Possible values: [BRA, ARG, CHL, PER, MEX]
Country of the transaction.
status stringrequired
Possible values: [PENDING, WAITING, AUTHORIZED, REJECTED, REVERSED, PROCESSED, FAILED, ERROR]
Status of the transaction.
amount numberrequired
Amount of the transaction in cents.
currency_tag stringrequired
Possible values: [MXN, PEN, CLP, ARS, USD, BRL]
Currency of the transaction.
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 (Yape cellphone number).
third_part_document stringrequired
Third part document (DNI).
third_part_document_type stringrequired
Possible values: [DNI, CE, PAS, PP, RUT, RUC, CUIL, CUIT, CPF, CNPJ, RFC, CURP, PASSPORT, TAXSTATEMENT, IDCARD]
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.
third_part_account_type stringrequired
Possible values: [SA, CA, CP]
Third part account type (Yape uses cellphone).
third_part_account_number stringrequired
Third part account number (Yape cellphone number).
third_part_bank_code string
Third part bank code.
third_part_bank_name string
Third part bank name.
authorized_date date-time
Authorized date.
succeeded_date date-time
Succeeded date.
failed_date date-time
Failed date.
created_at date-timerequired
Created at.
updated_at date-timerequired
Updated at.
]

Example (from schema)

{}

bank_transfer

Bank transfer payouts details

{
  "page": 1,
  "page_size": 20,
  "page_total": 2,
  "total": 25,
  "data": [
    {
      "id": "0197b169-da6b-7ba2-b053-ce413ae39afd",
      "operation_id": "456e7890-e12b-34d5-a678-426614174001",
      "country": "CHL",
      "status": "PENDING",
      "amount": 1000,
      "currency_tag": "PEN",
      "third_part_name": "John",
      "third_part_last_name": "Doe",
      "third_part_email": "john.doe@example.com",
      "third_part_phone": "+1234567890",
      "third_part_document": "A12345678",
      "third_part_document_type": "DNI",
      "third_part_address_zip_code": "12345",
      "third_part_address_street": "Main St",
      "third_part_address_number": "100",
      "third_part_address_city": "Metropolis",
      "third_part_address_state": "StateName",
      "third_part_address_country": "CountryName",
      "third_part_bank_code": "123",
      "third_part_account_type": "CA",
      "third_part_account_number": "1234567890",
      "authorized_date": "2023-10-01T12:00:00.000Z",
      "failed_date": "2023-10-03T12:00:00.000Z",
      "created_at": "2023-09-30T12:00:00.000Z",
      "updated_at": "2023-10-01T15:00:00.000Z"
    }
  ]
}

yape

Yape wallet payouts details

{
  "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": "PER",
      "status": "PENDING",
      "amount": 10000,
      "currency_tag": "PEN",
      "third_part_name": "Juan",
      "third_part_last_name": "Pérez",
      "third_part_email": "juan.perez@example.com",
      "third_part_phone": "987654321",
      "third_part_document": "12345678",
      "third_part_document_type": "DNI",
      "third_part_address_zip_code": "15001",
      "third_part_address_street": "Av. Javier Prado",
      "third_part_address_number": "1234",
      "third_part_address_city": "Lima",
      "third_part_address_state": "Lima",
      "third_part_address_country": "Peru",
      "third_part_address_complement": "Apto 101",
      "third_part_account_type": "CP",
      "third_part_account_number": "987654321",
      "authorized_date": "2025-11-14T17:34:31.363Z",
      "succeeded_date": "2025-11-14T17:34:31.363Z",
      "failed_date": "2025-11-14T17:34:31.363Z",
      "created_at": "2025-11-14T17:34:31.363Z",
      "updated_at": "2025-11-14T17:34:31.363Z"
    }
  ]
}

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...