Create a payment intent
Creates a payment intent in the live or test mode of the API key used. A payment intent represents your intention of collecting a payment from a customer, in CLP for Chilean organizations or MXN for Mexican organizations. The response includes a widget_token, only returned on creation, used to initialize the Fintoc widget so the customer can complete the payment.
v1 · Base URL https://api.fintoc.com/v1
Autorizaciones
Cuerpo
A positive integer representing the amount to pay, 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
Three-letter ISO 4217 currency code. One of CLP or MXN. Must match the currency of your organization's country.
CLP, MXN "CLP"
Email address of the customer. Fintoc uses it for payment notifications, including refund notices. Invalid addresses are discarded without failing the request.
"jon.snow@example.com"
ISO 8601 datetime in UTC or Unix timestamp of when the payment expires and can no longer be paid. Must be in the future, and only valid when payment_type is cash. Defaults to 3 days after creation.
"2024-12-31T23:59:59Z"
Set of key-value pairs you can attach to the payment intent. Supports up to 50 keys, with key names up to 40 characters and values up to 500 characters. Arrays and nested objects are not allowed.
Payment type the customer uses to pay. One of bank_transfer (bank transfer in Chile and Mexico) or cash (cash deposit at a sale point, Mexico only). Defaults to bank_transfer.
bank_transfer, cash Bank account that receives the payment. Chile only, and only if your organization uses direct payments; organizations that collect through Fintoc must omit it.
Numeric reference attached to the SPEI transfer. Mexico only.
Bank account the customer pays from. Chile only. Fintoc uses it to validate transfer limits when creating the payment intent.
Respuesta
Payment intent created. The widget_token is only returned in this response.
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.