---
title: "List payout"
method: GET
path: "/payout/transfer"
tags: ["payout"]
---

# List payout

`GET /payout/transfer`

## Query parameters

- `external_id` string
- `external_provider_id` string
- `timestamp` string, date-time
- `timestamp_from` string, date-time
- `timestamp_to` string, date-time
- `amount` number, double — String encoded decimal number
- `amount_min` number, double — String encoded decimal number
- `amount_max` number, double — String encoded decimal number
- `state` 'created' | 'initiated' | 'pending' | 'failed' | 'settled' | 'cancelled'
- `currency` string — ISO-4217 currency code
- `origin_financial_institution` string
- `origin_account` string
- `customer_account` string
- `name` string
- `customer_tax_id` string
- `ordering` 'timestamp' | 'amount' | 'fee'
- `page` integer

## Response `200`

Payout listed

- object
  - `count` integer — The number of payout listed
  - `next` string, uri — The next page of listed payout
  - `previous` string, uri — The previous page of listed payout
  - `results` PayoutTransfer[] — The list of payout
    - `id` string, uuid — Id of the payout intent
    - `origin` string, uuid — The origin account Id
    - `description` string
    - `external_id` string — Id used to track the payout
    - `amount` number, double — String encoded decimal number
    - `fee` number, double — String encoded decimal number
    - `total_amount` number, double — String encoded decimal number
    - `reference` string — Id of the payout generated by the financial provider
    - `timestamp` string, date-time — The timestamp of the payout creation
    - `customer` PayoutCustomer
      - `name` string — The customer name
      - `tax_id_type` 'rfc' | 'cnpj' | 'cpf' | 'ruc' | 'curp' | 'le' | 'dni' | 'lm' | 'pas' | 'ce' | 'nit' | 'cc' | 'pa' | 'ti' | 'nuip' | 'ppt' | 'pep' | 'cuil' | 'cuit' | 'other' — The type of tax identification of the customer
      - `tax_id` string — The customer's tax identification number
      - `external_id` string, required — An external ID to identify a user. It can be the merchant's user ID or other tracking ID.
      - `withdrawal_account` WithdrawalAccountDetailsResponse
        - `id` string, uuid
        - `account_format` 'iban' | 'clabe' | 'cci' | 'pix' | 'bre_b' | 'alias' | 'cbu' | 'cvu' — The type of customer's account
        - `account_number` string, required — The customer account number
        - `description` string — Account description
        - `selected` boolean — Account selected for withdrawal
        - `branch` string
        - `bank` Bank
          - `code` string — The bank code number
          - `bicfi` string — The bank BICFI code
          - `name` string — The bank name
          - `country` string — ISO-3166-1 Alfa-2 country code
    - `events` PayoutTransferState[] — The events of the payout
      - `state` 'created' | 'initiated' | 'pending' | 'failed' | 'settled' | 'cancelled'
      - `timestamp` string, date-time — The timestamp of the payout event
      - `message` string — The message of the event, if exists

## Other responses

- `400` — Bad Request - Invalid input or malformed data
- `401` — Unauthorized access due to missing or invalid API key
- `403` — Permission denied for the requested action.
- `404` — The requested resource does not exist.
- `405` — The HTTP method used is not allowed for this endpoint.
- `406` — The Accept header cannot be satisfied.
- `415` — The request's content type is not supported.
- `429` — Too many requests, the request has been throttled.
- `500` — A generic internal API error occurred.

---

[API](https://skmtc.net/prometeoapi/apis/account-validation-v2.md) · [All operations](https://skmtc.net/prometeoapi/apis/account-validation-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/prometeoapi/account-validation-v2/revisions/9c278fe91cbd/schema)