Payment Intent represents a payment transaction in the Fintoc API, containing details about the payment status, amounts, and accounts involved.
{
"id": "pi_BO381oEATXonG6bj",
"object": "payment_intent",
"amount": 1000,
"created_at": "2021-10-15T15:23:11.474Z",
"currency": "CLP",
"customer_email": "felipe@example.com",
"error_reason": null,
"metadata": {},
"mode": "live",
"recipient_account": {
"holder_id": "183917137",
"number": "123456",
"type": "checking_account",
"institution_id": "cl_banco_de_chile"
},
"reference_id": "90123712",
"sender_account": {
"holder_id": "192769065",
"number": "123456",
"type": "checking_account",
"institution_id": "cl_banco_estado"
},
"status": "created",
"transaction_date": "2021-10-15T15:24:15.474Z",
"widget_token": "pi_BO381oEATXonG6bj_sec_a4xK32BanKWYn"
}
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the Payment Intent. |
object | string | Identifier for the type of object. Its value for Payment Intents will always correspond to payment_intent. |
amount | integer | Amount to pay, represented as an integer. This value must always be greater than 0. |
business_profile | hash | Optional object to identify multiple enrolled merchants for category-based pricing. |
created_at | string | Payment Intent creation date in ISO 8601 format. |
currency | string | Currency ISO code. Currently supports CLP and MXN only. |
customer_email | string | Customer email linked to the Payment Intent for refund notifications. Required for the refunds product; returns null if not provided. |
error_reason | string | Error code explaining the Payment Intent failure, if available. |
metadata | hash | Set of key-value pairs for storing additional structured information. Returns null if not provided during creation. |
mode | string | Indicates whether the Payment Intent operates in live or test mode. |
recipient_account | object | Object referencing the recipient account. Omit during payment creation when using Fintoc Collects for improved stability. |
reference_id | string | Operation number from the sender account’s bank. May be null for delayed confirmations or abandoned payments. |
sender_account | object | Object referencing the sender account. May be null if the user abandoned the payment before specifying a sender. |
status | string | Payment status. Can be created, in_progress, succeeded, failed, pending, requires_action, expired, or rejected. |
transaction_date | string | Bank authorization date in ISO 8601 format. May be null in final status notifications. |
widget_token | string | Temporary token to configure the widget. Returned only when creating the Payment Intent; thereafter always null. |
Recipient Account and Sender Account objects
| Attribute | Type | Description |
|---|---|---|
holder_id | string | Account owner identifier (RUT in Chile; RFC or CURP in Mexico). |
number | string | Account number without hyphens or prefixed zeros. |
type | string | Account type: checking_account or sight_account. |
institution_id | string | Account institution identifier. |
Business Profile object
| Attribute | Type | Description |
|---|---|---|
category | string | Sub-merchant category identifier (6-character SII activity code in Chile). |
name | string | Enrolled merchant name. Displayed as “Recipient” on the succeeded payment screen. |
tax_id | string | Enrolled merchant tax identifier (RUT in Chile). |