List 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.
v1 · Base URL https://api.fintoc.com/v1Authorizations
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).
charge, payment_intent, refund, refund_adjustment 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.
- Option 1
- Option 2
- Option 3
Unique identifier of the payment intent.
"pi_BO381oEATXonG6bj"
Type of the object. Always payment_intent.
Amount of the payment intent, in the smallest unit of the currency (for example, 100000 for 100000 CLP, since CLP has no minor unit, or 7050 for 70.50 MXN).
100000
ISO 8601 timestamp of when the payment intent was created.
"2021-10-15T15:23:11.474Z"
Three-letter ISO 4217 currency code of the payment intent. One of CLP or MXN.
CLP, MXN "CLP"
Customer associated with the payment intent, when it was created from a checkout session with a customer. null otherwise.
Email address of the customer that receives payment notifications. null when not provided.
"jon.snow@example.com"
Reason why the payment failed, was rejected, or expired. null while the payment is in progress and when it succeeds.
"insufficient_funds"
ISO 8601 timestamp of when the payment expires and can no longer be paid. Only set for cash payments; null otherwise.
Set of key-value pairs attached to the payment intent.
Mode of the object. live objects use real institution data, test objects use fake data for integration testing.
test, live "live"
Action the customer must complete to continue the payment, as reported by the widget. null when no action is pending.
Identifier of the payment method used to pay, when the payment intent comes from a checkout session or a subscription. null otherwise.
"pm_1x7vKQ8oEATXonG6"
Payment type used to pay, such as bank_transfer or cash.
"bank_transfer"
Options specific to the payment type. For card payments, the object contains a card object. For cash payments, the object contains a cash object with the reference_number, barcode_url, and voucher_url of the payment. For bank transfers, the object is empty.
Bank account that receives the payment. null for cash payments.
Identifier of the transfer assigned by the institution. null until the transfer is executed.
"90123712"
Bank account the customer pays from. null until Fintoc identifies the sender.
Status of the payment intent. One of created (the customer has not started the payment), in_progress (the customer is paying), succeeded (the money reached the recipient account), rejected (the institution rejected the transfer), failed (the payment could not be completed), expired (the payment intent expired before being paid), or pending (the final status is not yet known; only used if your organization has the pending status enabled).
created, failed, succeeded, rejected, in_progress, pending, expired "succeeded"
Identifier of the subscription that originated the payment intent. null for one-off payments.
"sub_dJOd4hcZby9XK1Lm"
ISO 8601 timestamp of when the institution executed the transfer. null until the transfer is executed.
"2021-10-15T15:24:15.474Z"
Token used to initialize the Fintoc widget for this payment intent. Only returned when the payment intent is created; null in every other response.
"pi_BO381oEATXonG6bj_sec_aBcDeFgHiJkLmNoP"
Profile of the business that collects the payment, when provided. null otherwise.