The Checkout Session object represents the flow your customer goes through to complete a payment or enrollment. It holds the amount, currency, payment method configuration, and the redirect URLs your customer uses to complete the session. The session tracks its status through created, in_progress, finished, and expired.
Attribute
Type
Description
id
string
Unique identifier for the Checkout Session.
object
string
Identifier for the type of object. Its value is always checkout_session.
amount
integer
Amount to charge for the session, as a positive integer in the smallest currency unit (for example, 1000 for $1000 CLP, since CLP has no minor unit). Present on payment and subscription flows, and omitted on the setup flow. See currencies.
business_profile
object
Details that identify enrolled merchants for category-based pricing. See the Business Profile Object section below for its fields.
cancel_url
string
URL to redirect your customer to if they cancel the Checkout Session and return to your website.
created_at
string
ISO 8601 datetime in UTC for when the session was created.
currency
string
Three-letter ISO 4217 currency code, uppercase. Must be a currency Fintoc supports in the customer's country; see the currencies page for the full list.
customer
object
The Customer associated with the session. See the Customer Object section below for its fields.
customer_email
string
Email Fintoc notifies if a refund occurs. Set this field if you use refunds.If you create a session without customer_email, this field is null and Fintoc sends no emails for the session.
expires_at
string
ISO 8601 datetime in UTC for when the session expires. Defaults to 24 hours after the session is created.
flow
string
Type of flow the session uses. One of payment, setup, or subscription.
line_items
array
Items on the session. For subscription sessions, these items define the recurring charges. This field is null when the session does not use line items.
metadata
object
Set of key-value pairs that you can attach to an object. Useful for storing additional information about the object in a structured format.If you create a session without metadata, this field is null in the notifications about the final status.
mode
string
Indicates whether the Checkout Session is in live mode or in test mode.
payment_method
string
ID of the saved payment method used for the session, when the customer pays with a saved method. Prefixed with pm_. This field is null otherwise.
payment_method_options
object
Set of settings for each enabled payment method type, keyed by the type (for example, bank_transfer). See the Bank Transfer Options section below for its fields.
payment_method_types
array
Array of payment method types enabled for the session. For payment flows, one or more of bank_transfer or card. For setup and subscription flows, one or more of pac (Chilean automatic debit), direct_debit (Mexican direct debit), or card. The available values depend on the customer's country.
payment_resource
object
Payment resource associated with the session once the payment finishes. Contains a payment_intent; see the Payment Intent Object reference for its fields. If the session has not finished or expired, this field is null.
redirect_url
string
URL to redirect your customer to so they complete the Checkout Session using the Fintoc widget.
save_payment_method
string
Indicates whether the customer can save the payment method for future payments. One of enabled or disabled. Defaults to disabled.
session_token
string
Temporary token used to configure the widget. This field is null when you send success_url and cancel_url while creating the session.
status
string
Session status. One of created, in_progress, finished, or expired.
subscription
string
ID of the subscription created during a subscription flow. Prefixed with sub_. This field is null for other flows.
success_url
string
URL to redirect your customer to after the Checkout Session completes successfully.
ui_mode
string
Indicates the user interface of the checkout. The available options are hosted, with a redirect to a Fintoc-hosted page, and embedded, for embedded buttons like Apple Pay.
The customer attribute contains the Customer associated with the session, with the following fields:
Attribute
Type
Description
id
string
Unique identifier for the Customer. Prefixed with cus_.
object
string
Object type. Always customer.
email
string
Customer's email address.
metadata
object
Set of key-value pairs attached to the customer.
name
string
Customer's full name or business name.
tax_id
nullable object
Customer tax identifier. Null when not provided. See the Customer object for the tax_id.type and tax_id.value fields.
Bank Transfer Options
A bank_transfer payment involves the following account objects:
Attribute
Type
Description
recipient_account
object
Recipient account for the transfer. See the Recipient Account Object section below for its fields. If you use Fintoc Collects, omit this object during payment creation.
sender_account
object
Sender account for the transfer. See the Sender Account Object section below for its fields.
When you receive final payment status notifications, sender_account is null if the customer abandoned the payment before specifying a sender account.
Recipient Account Object
Attribute
Type
Description
holder_id
string
Identifier of the owner of the account. In Chile, it corresponds to a Chilean tax ID (RUT), and in Mexico it is either a Mexican tax ID (RFC) or a Mexican personal ID (CURP).
institution_id
string
Account's institution id. Learn more about institutions and their ids in the institutions reference.
number
string
Account number. Does not include hyphens or prefixed zeros.
type
string
Account type. One of checking_account or sight_account.
Sender Account Object
Attribute
Type
Description
holder_id
string
Identifier of the owner of the account. In Chile, it corresponds to a Chilean tax ID (RUT), and in Mexico it is a Mexican tax ID (RFC) or a Mexican personal ID (CURP).
institution_id
string
Account's institution id. Learn more about institutions and their ids in the institutions reference.
number
string
Account number. Does not include hyphens or prefixed zeros.
type
string
Account type. One of checking_account or sight_account.
Business Profile Object
Attribute
Type
Description
category
string
Identifier of the category of the enrolled merchant. In Chile, it corresponds to a 6-character Servicio de Impuestos Internos (SII) activity code.
name
string
Enrolled merchant's name. If set, Fintoc shows it as the "Recipient" on the succeeded payment screen.
tax_id
string
Enrolled merchant's tax identifier. In Chile, it corresponds to a RUT.