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.
Query parameters
If present, filter by Shinkansen transaction ID
If present, filter by the external ID of the transaction (defined bye customer)
If present, filter by the identifier for a natural or legal person
If present, filter by the state of the payout order
If present, filter by the exact amount given
If present, filter by amount less or equal than the given one
If present, filter by the recipient name
If present, filter byt the recipient account
If present, filter by the description set in the payout order
If present, filter by the currency of the bank account
If present, filter by the bank account
If present, filter by the recipient fin id
If present, filter by execution dates greater or equal than the given value
If present, filter by execution dates less or equal than the given value
If present, filter by inserted dates greater or equal than the given value
If present, filter by inserted dates less or equal than the given value
If present, filter by the tracking key
If present, filter by the reference number
If present, filter by the Shinkansen transaction ID of an individual payout within the order. Useful for finding the payout order associated with a specific payout transaction.
Maximum number of transactions to return per page (can't be greater than 100)
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": [
{
"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"
},
{
"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": []
}
]
}
]
}