Create a charge
Creates a charge on an active subscription. The charge starts with status pending, and Fintoc collects the charge from the subscription’s bank account on the next collection cycle. In test mode, Fintoc simulates the collection and updates the charge status asynchronously after creation.
v1 · Base URL https://api.fintoc.com/v1Autorizaciones
Cuerpo
A positive integer in the smallest unit of currency (for example, 1000 for $1000 CLP, since CLP has no minor unit). The maximum depends on the bank of the subscription.
5000
Three-letter ISO 4217 currency code. CLP is the only supported currency.
CLP "CLP"
The id of the subscription to charge. The subscription must be active and match the live or test mode of the API key used.
"sub_m7N9rAWJS9dWDKEe"
Business on whose behalf the charge is collected. Required for organizations that collect charges on behalf of enrolled merchants.
Set of key-value pairs you can attach to the charge. Useful for storing additional information about the charge in a structured format.
Bank account that receives the funds of the charge. Only used for organizations with recipient accounts enabled; otherwise it is ignored.
Respuesta
The created charge, with status pending. In test mode, the charge status updates asynchronously after creation to simulate the collection.
A charge is a single collection from the bank account of a subscription. You create a charge on an active subscription, and Fintoc collects the charge from the subscription's bank account on the next collection cycle. A charge starts as pending and ends as succeeded, failed, or canceled.
Unique identifier of the charge.
"ch_o9YDuRzUez2GqV4x"
Type of the object. Always charge.
A positive integer in the smallest unit of currency (for example, 1000 for $1000 CLP, since CLP has no minor unit).
5000
ISO 8601 timestamp of when the charge was created.
"2021-05-17T17:04:10.284Z"
Three-letter ISO 4217 currency code. CLP is the only supported currency.
"CLP"
Reason why the charge failed. Always null unless status is failed. One of insufficient_funds (the bank account did not have enough funds), subscription_inactive (the subscription is no longer active at the bank), charge_amount_limit_exceeded (the amount exceeds the bank's per-charge limit), bank_account_unavailable (the bank account is closed, blocked, or could not be found), or other.
insufficient_funds, subscription_inactive, charge_amount_limit_exceeded, bank_account_unavailable, other, null "insufficient_funds"
Set of key-value pairs attached to the charge when it was created.
Mode of the object. live objects use real institution data, test objects use fake data for integration testing.
test, live "live"
Current state of the charge. One of pending (not yet sent to the bank), in_progress (being processed by the bank), succeeded, failed, or canceled.
pending, in_progress, succeeded, failed, canceled "succeeded"
Identifier of the subscription the charge belongs to.
"sub_nMNejK7BT8oGbvO4"
Bank account that receives the funds of the charge. Only present when the charge has a recipient account attached.