---
title: "Returns the payout orders for the customer"
method: GET
path: "/payout_orders"
tags: ["Payout orders"]
---

# Returns the payout orders for the customer

`GET /payout_orders`

Returns a paginated list of payout orders for the customer. The information can be filtered using the different parameters.

## Query parameters

- `shinkansen_payout_order_id` string, uuid
- `external_id` string
- `recipient_id` string
- `state` string
- `amount` number
- `upperbound_amount` string
- `recipient_name` string
- `recipient_account` string
- `description` string
- `bank_account_currency` string
- `bank_account` string
- `recipient_fin_id` string
- `gte_execution_date` string, date-time
- `lte_execution_date` string, date-time
- `gte_inserted_at` string, date-time
- `lte_inserted_at` string, date-time
- `tracking_key` string
- `reference_number` string
- `shinkansen_transaction_id` string, uuid
- `page_size` integer
- `page` integer

## Response `200`

Returns a paginated list of payout orders

- PayoutOrdersPage — Payout order
  - `meta` PayoutOrderPageMeta — Payout order page meta information used for pagination
    - `current_page` integer — The current page number of the paginated response.
    - `total_count` integer — The total number of elements in the paginated response.
    - `total_pages` integer — The total number of pages in the paginated response.
  - `payout_orders` PayoutOrderItem[] — A list of payout orders
    - `recipient_fin_id_schema` string — Identification schema for financial institution, namely, any participant in Shinkansen Network. Use `"SHINKANSEN"` for Shinkansen's native network ids and full support on any participant and service of the Shinkansen network. Other schemas might be used when interfacing with other networks but they are *not* recommended unless you *really* know what you are doing or have been explicitly instructed to do so by Shinkansen.
    - `recipient_account` string — Is the account number of the recipient
    - `state` PayoutOrderState — Payout order state
      - `shinkansen_payout_order_state` 'created' | 'waiting_approval' | 'approved' | 'enqueued' | 'executing' | 'cancelled' | 'rejected' | 'succeeded' | 'partially_succeeded' | 'failed' — The state of the payout order. This can be any of these values: * `created`: the payout was created (initial state) * `waiting_approval`: the payout is waiting for approval * `approved`: payout was approved will soon be enqueued or executed * `enqueued`: the payout order is waiting in a queue to be executed * `executing`: the payout order is being executed (the payout is executing) * `cancelled`: the payout order was cancelled by sender * `rejected`: the payout order was rejected by a representative * `succeeded`: the payout was executed successfully * `partially_succeeded`: the payout was split into chunks and some succeeded while others failed (only for chunked orders) * `failed`: the payout failed execution
    - `description` string — A description of the payout order.
    - `recipient_name` string — The name of the recipient of the order
    - `type` 'wire_transfer' | 'swift' | 'lbtr' — Type of payout Order, must be one of: wire_transfer, swift or lbtr
    - `reference_number` string — Up to 7 integer digits
    - `created_by` string — Email of the creator of the payout order
    - `bank_account` object — Describes the bank account used in the payout
      - `currency` string — Currency ISO 4217 code (e.g: `"CLP"`)
      - `financial_institution_id` FinancialInstitutionId — The identifier for a financial institution
        - `fin_id_schema` string, required — Identification schema for financial institution, namely, any participant in Shinkansen Network. Use `"SHINKANSEN"` for Shinkansen's native network ids and full support on any participant and service of the Shinkansen network. Other schemas might be used when interfacing with other networks but they are *not* recommended unless you *really* know what you are doing or have been explicitly instructed to do so by Shinkansen.
        - `fin_id` string, required — Identification according to schema. When the `"SHINKANSEN"` schema is used (as recommended), this is the ID assigned by Shinkansen to the participant in the network. In the context of the `header`, it refers to the Shinkansen network participant that sends (Sender) or receives (Receiver) the message. In the context of the `transactions`, it refers to the financial institution from which the resources leave or where the resources arrive. The ID assigned by Shinkansen to the financial institution can be found in https://docs.shinkansen.tech/docs/instituciones-financieras. When sending a transaction to Shinkansen, this value must always be SHINKANSEN. When sending a payout order to Shinkansen Treasury, this value must be SHINKANSEN_TREASURY
      - `account` string — Account number of the bank account
    - `comments` object — A count of how many comments have this payout Order
      - `count` integer
    - `inserted_at` string, date-time
    - `amount` string — Amount, ISO20022-compatible: Up to 18 integer digits, optional decimal separator ".", up to 5 fraction digits (also optional). By using a string we avoid issues with floating-point arithmetic as well as integer type limits on some JSON implementations.
    - `recipient_id` string — The actual identification "number" (but not always just numbers). For `"MXRFC"` schema (Mexican RFCs), it can contain numbers and letters (13 for natural persons, 12 for legal entities). For `"MXCURP"` schema (Mexican CURPs) identifying natural persons, it can contain numbers and letters (18 characters). For `"COCC"`, `"COTI"`, `"CONUIP"`, and `"COCE"` schemas (all identifying natural personal in Colombia), use only numbers. For `"CONIT"` schema (Colombian NITs, for legal entities), also use only numbers. For `"PASS"` schema (Passports, used in Colombia for some accounts in name of foreign natural persons), it can contain numbers and letters (and generally whatever is literally printed as a passport number). For `"CLID"` schema (Chilean RUTs, for legal entities and natural persons) you must use the XXXXXXXX-X format: `^\d{8}[-][0-9kK]$`. See https://docs.shinkansen.tech/docs/tipos-de-identificacion for more details.
    - `external_id` string, uuid — Identification of the transaccion provided by customer.
    - `recipient_fin_id` string — Identification according to schema. When the `"SHINKANSEN"` schema is used (as recommended), this is the ID assigned by Shinkansen to the participant in the network. In the context of the `header`, it refers to the Shinkansen network participant that sends (Sender) or receives (Receiver) the message. In the context of the `transactions`, it refers to the financial institution from which the resources leave or where the resources arrive. The ID assigned by Shinkansen to the financial institution can be found in https://docs.shinkansen.tech/docs/instituciones-financieras
    - `execution_mode` 'default' | 'immediate' | 'deferred' — Execution mode for the transaction.
    - `payment_purpose_category` 'default' | 'salary_payment' | 'supplier_payment' | 'dividend' | 'confirming' | 'tax_payment' | 'pe_cts' | 'bonus_payment' | 'compensation_payment' | 'holiday_payment' | 'overtime_payment' | 'cash_management_transfer' | 'card_bulk_clearing' | 'credit_card_payment' | 'trade_settlement_payment' | 'debit_card_payment' | 'deliver_against_payment' | 'epayment' | 'fee_collection_and_interest' | 'fee_collection' | 'person_to_person_payment' | 'government_payment' | 'hedging' | 'irrevocable_credit_card_payment' | 'irrevocable_debit_card_payment' | 'intra_company_payment' | 'interest' | 'lockbox_transactions' | 'loan' | 'commercial' | 'consumer' | 'other_payment' | 'pension_payment' | 'represented' | 'reimbursement_received_credit_transfer' | 'receive_against_payment' | 'securities' | 'social_security_benefit' | 'trade' | 'treasury_payment' | 'value_added_tax_payment' | 'with_holding' | 'cash_management_sweep_account' | 'cash_management_top_account' | 'cash_management_zero_balance_account' | 'crossborder_mipayments' | 'foreign_currency_domestic_transfer' | 'cash_in_pre_credit' | 'cash_out_notes_coins' | 'carrier_guarded_wholesale_valuables' | 'saving' | 'profit_sharing_payment' — The payment purpose category of the transaction.
    - `updated_at` string
    - `via_api` boolean — Indicates if the payout order was generated using the api
    - `payment_rail` 'default' | 'swift' | 'swift_gpi' | 'swift_go' | 'cl_tef' | 'cl_tef_masiva' | 'cl_batch_credito' | 'cl_batch_debito' | 'cl_lbtr' | 'co_ach_batch' | 'co_ach_transfiya' | 'co_cenit_batch' | 'co_redeban' | 'co_breb' | 'co_pse' | 'co_lbtr' | 'mx_spei' | 'mx_spei_b' | 'mx_spid' | 'mx_batch_domiciliation' | 'mx_batch_payroll' | 'mx_batch_referenced' | 'mx_tef' | 'pe_cce_batch' | 'pe_cce_inmediate' | 'pe_visa_direct' | 'pe_lbtr' | 'cashier_back' — Payment rail for the transaction.
    - `po_connection` 'default' | 'api' | 'h2h' — The preferable connection type to deliver the transaction.
    - `recipient_id_schema` string — Identification schema. See https://docs.shinkansen.tech/docs/tipos-de-identificacion
    - `execution_date` string, date-time — Date time of the execution of the payout order
    - `tags` unknown[] — List of tags for the payout order
      - unknown
    - `recipient_account_type` string — Account type. See https://docs.shinkansen.tech/docs/tipos-de-cuentas for possible values.
    - `error_message` string — Error message when execution failed.
    - `tracking_key` string — Up to 30 alpha numeric characters (letters and digits, no special characters)
    - `recipient_email` string — Email of the recipient of the payout order
    - `split_details` SplitDetails — **Payout Order Split Details** Information about payout orders that have been divided into multiple chunks (partial payments). **When This Field Is Present?** This field only appears when a payout order has been automatically split into multiple chunks. Not all payout orders are split - this depends on factors such as transaction amount limits and client-specific configuration managed by Shinkansen. **Understanding Split Orders** When a payout order is split: - The total amount is divided into multiple smaller transactions (chunks) - Each chunk is processed independently - Each chunk can have its own status: `succeeded`, `failed`, or `pending` - The `transferred_amount` reflects the sum of amounts from successful chunks only - You can track the progress and status of each individual chunk **Important Notes** - LBTR orders are never split due to regulatory restrictions - If this field is absent, the payout order was processed as a single transaction - Contact Shinkansen if you need chunking enabled or configured for your account
      - `total_chunks` integer — Total number of chunks this payout order was split into
      - `succeeded_chunks` integer — Number of chunks that completed successfully
      - `failed_chunks` integer — Number of chunks that failed
      - `currency` string — Currency ISO 4217 code (e.g: `"CLP"`)
      - `original_amount` string — Original amount before splitting (as a string to preserve precision)
      - `transferred_amount` string — Actual amount transferred (sum of successful chunks, as a string to preserve precision)
      - `chunks` object[] — Array of individual chunk details
        - `index` integer — Zero-based index of this chunk
        - `amount` string — Amount for this specific chunk (as a string to preserve precision)
        - `currency` string — Currency ISO 4217 code (e.g: `"CLP"`)
        - `status` 'succeeded' | 'failed' | 'pending' — Status of this chunk: - succeeded: chunk was processed successfully - failed: chunk processing failed - pending: chunk is awaiting processing
        - `payout_response_status` string, nullable — Response status from the payout provider for this chunk
        - `payout_response_message` string, nullable — Response message from the payout provider for this chunk
    - `payouts` PayoutResultPayout[] — Structured per-payout information. Each element represents an individual payout executed as part of this order. For chunked orders, each payout includes `chunk_index` and `chunk_amount`. For non-chunked orders those fields are omitted. This field is only present for payout orders that have been executed (i.e., orders in terminal states like `succeeded`, `failed`, or `partially_succeeded`). For orders still in progress or not yet executed, this field is omitted.
      - `shinkansen_transaction_id` string, uuid, required — Shinkansen unique identifier for this payout transaction.
      - `transaction_id` string, uuid, required — Unique identifier for the payout transaction assigned by the payment operator.
      - `state` 'ok' | 'error' | 'invalid', required — State of this individual payout: - `ok`: payout succeeded - `error`: payout failed - `invalid`: payout was rejected due to validation errors
      - `response_status` 'ok' | 'invalid' | 'error_creditor_account_not_found' | 'error_creditor_account_detail_mismatch' | 'error_creditor_account_over_limits' | 'error_creditor_fi_offline' | 'error_payment_rail_offline' | 'error_debtor_account_over_limits' | 'error_debtor_insufficient_funds' | 'error_delivery_ttl_expired' | 'error', required — Status as reported by the payout operator (or shinkansen if the operator is down): * `ok`: The payout was successful. * `invalid`: The request failed some validation * `error_creditor_account_not_found`: The destination account doesn't exist * `error_creditor_account_detail_mismatch`: Something is wrong with the destination account details * `error_creditor_account_over_limits`: The destination account is over the limits set by the creditor bank/institution * `error_creditor_fi_offline`: The creditor bank/institution is temporarily offline * `error_payment_rail_offline`: The payment rail used by Shinkansen/PO is temporarily offline * `error_debtor_account_over_limits`: The origin account is over the limits set by the debtor bank/institution or the payout operator. * `error_debtor_insufficient_funds`: The origin account doesn't have enough funds to cover the payout amount. * `error_delivery_ttl_expired`: The transaction could not be delivered to the source bank/institution before the TTL specified on the original payout message. * `error`: Other errors not categorized above
      - `response_message` string, required — Human-readable message further explaining the status.
      - `error_codes` string[] — Error codes returned by the payment operator, if any.
      - `error_messages` string[] — Error messages returned by the payment operator, if any.
      - `chunk_index` integer, nullable — 1-based index of this payout within the split order. Only present for chunked payout orders.
      - `chunk_amount` string, nullable — Amount assigned to this specific chunk (as a string to preserve precision). Only present for chunked payout orders.

## Other responses

- `422` — Returns the error detail when payout-orders get endpoint fails

---

[API](https://skmtc.net/shinkansen/apis/payouts-shinkansen-endpoints.md) · [All operations](https://skmtc.net/shinkansen/apis/payouts-shinkansen-endpoints/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shinkansen/payouts-shinkansen-endpoints/versions/1e4a6760b7e8/schema)