v1
latestOpenAPI 3.1.02026-07-228956435.8 KBList payout resources
Lists the resources that a payout disburses or discounts: payment intents, charges, or refunds. The response item schema depends on resource_type: payment_intent returns payment intents, charge returns charges, and refund and refund_adjustment return refunds.
Path parameters
Unique identifier of the payout whose resources to list.
Query parameters
Type of resources to list. One of payment_intent (payment intents the payout disburses), charge (charges the payout disburses), refund (refunds discounted from the payout amount), or refund_adjustment (refund amounts the payout credits back after a failed refund).
Page number to retrieve. Starts at 1.
Number of resources per page. Defaults to 30. The maximum is 300.
Response
Paginated list of the payout's resources, with the item schema matching resource_type. The Link and X-Total-Count headers carry the pagination information.
Example response
[
{
"id": "pi_BO381oEATXonG6bj",
"amount": 100000,
"created_at": "2021-10-15T15:23:11.474Z",
"currency": "CLP",
"customer_email": "jon.snow@example.com",
"error_reason": "insufficient_funds",
"metadata": {
"order_id": "9182"
},
"mode": "live",
"payment_method": "pm_1x7vKQ8oEATXonG6",
"payment_type": "bank_transfer",
"payment_type_options": {},
"recipient_account": {
"holder_id": "111111111",
"institution_id": "cl_banco_de_chile",
"number": "123456789",
"type": "checking_account"
},
"reference_id": "90123712",
"sender_account": {
"holder_id": "111111111",
"institution_id": "cl_banco_estado",
"number": "123456789",
"type": "checking_account"
},
"status": "succeeded",
"subscription": "sub_dJOd4hcZby9XK1Lm",
"transaction_date": "2021-10-15T15:24:15.474Z",
"widget_token": "pi_BO381oEATXonG6bj_sec_aBcDeFgHiJkLmNoP"
}
]