Payout orders

Returns the payout orders for the customer

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

get/payout_orders

Request

Base URL
https://api.treasury.shinkansen.finance/v1
URL
https://api.treasury.shinkansen.finance/v1/payout_orders
Auth
API key in header Shinkansen-Treasury-Api-Key

Query parameters

shinkansen_payout_order_idstring uuid

If present, filter by the identifier Shinkansen assigned to the payout order

external_idstring

If present, filter by the external ID of the transaction (defined bye customer)

recipient_idstring

If present, filter by the identifier for a natural or legal person

state[]PayoutOrderStateEnum[]

If present, filter by the state(s) of the payout order. Repeat the parameter to pass more than one value (?state[]=created&state[]=approved).

amountnumber

If present, filter by the exact amount given

upperbound_amountstring

If present, filter by amount less or equal than the given one

recipient_namestring

If present, filter by the recipient name

recipient_accountstring

If present, filter byt the recipient account

descriptionstring

If present, filter by the description set in the payout order

bank_account_currencystring

If present, filter by the currency of the bank account

bank_accountstring

If present, filter by the bank account

recipient_fin_idstring

If present, filter by the recipient fin id

gte_execution_datestring date-time

If present, filter by execution dates greater or equal than the given value

lte_execution_datestring date-time

If present, filter by execution dates less or equal than the given value

gte_inserted_atstring date-time

If present, filter by inserted dates greater or equal than the given value

lte_inserted_atstring date-time

If present, filter by inserted dates less or equal than the given value

tracking_keystring

If present, filter by the tracking key

reference_numberstring

If present, filter by the reference number

lte_idinteger

If present, filter by payout orders whose internal sequential id is less than or equal to the given value. Useful to keep a long paginated walk stable while new orders are being created.

page_sizeinteger

Maximum number of transactions to return per page (can't be greater than 100). Defaults to 50 if not specified.

pageinteger

Current page to fetch (defaults to 1 if not specified)

Response

Returns a paginated list of payout orders

Example response

{
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "current_offset": 0,
    "total_count": 10
  },
  "payout_orders": [
    {
      "shinkansen_payout_order_id": "8ddfed18-4e75-47ef-ae42-716cbe97d5a0",
      "recipient_fin_id_schema": "SHINKANSEN",
      "recipient_account": 30001288,
      "state": "rejected",
      "description": "test",
      "recipient_name": "Romulo Gallegos",
      "type": "wire_transfer",
      "reference_number": 1234567,
      "created_by": "api@shinkansen.finance",
      "bank_account": {
        "currency": "CLP",
        "financial_institution_id": "SIMULATED_BANK",
        "account": 1378783
      },
      "comments": {
        "count": 0
      },
      "inserted_at": "2024-04-30T21:41:13Z",
      "amount": 1,
      "recipient_id": "19154480-3",
      "external_id": "ff111124-dddd-dddd-dddd-472a7599decb",
      "recipient_fin_id": "SIMULATED_BANK",
      "execution_mode": "default",
      "payment_purpose_category": "default",
      "updated_at": "2025-04-30T21:41:13Z",
      "via_api": true,
      "payment_rail": "default",
      "po_connection": "default",
      "recipient_id_schema": "CLID",
      "execution_date": "2024-04-30T21:42:15Z",
      "tags": [],
      "recipient_account_type": "current_account",
      "error_message": null,
      "tracking_key": null,
      "recipient_email": "demos@shinkansen.cl"
    },
    {
      "shinkansen_payout_order_id": "3c1a7f92-55b1-4d0e-9a77-1f2b3c4d5e6f",
      "recipient_fin_id_schema": "SHINKANSEN",
      "recipient_account": 60001288,
      "state": "succeeded",
      "description": "test",
      "recipient_name": "Sonia Gallegos",
      "type": "wire_transfer",
      "reference_number": 1234568,
      "created_by": "api@shinkansen.finance",
      "bank_account": {
        "currency": "CLP",
        "financial_institution_id": "SIMULATED_BANK",
        "account": 1378783
      },
      "comments": {
        "count": 0
      },
      "inserted_at": "2024-04-30T21:41:13Z",
      "amount": 2,
      "recipient_id": "19154480-3",
      "external_id": "ff111124-dddd-dddd-dddd-472a7599decd",
      "recipient_fin_id": "SIMULATED_BANK",
      "execution_mode": "default",
      "payment_purpose_category": "default",
      "updated_at": "2025-04-30T21:41:13Z",
      "via_api": true,
      "payment_rail": "default",
      "po_connection": "default",
      "recipient_id_schema": "CLID",
      "execution_date": "2024-04-30T21:42:15Z",
      "tags": [],
      "recipient_account_type": "current_account",
      "error_message": null,
      "tracking_key": null,
      "recipient_email": "demos@shinkansen.cl",
      "payouts": [
        {
          "shinkansen_transaction_id": "e9a5a317-833c-4188-a54a-b041b67e7db8",
          "transaction_id": "aab63c75-1234-5678-9abc-def012345678",
          "state": "ok",
          "response_status": "ok",
          "response_message": "ok",
          "error_codes": [],
          "error_messages": []
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.