A customer email linked to a Checkout Session. This is used to notify a user in case of a refund. If you plan on using the refunds product, you must include this field in your request
If you create a session without providing a customer_email, this field will be null in the response and no emails will be sent for that Checkout Session.
expires_at
string
UTC Timestamp that indicates when the session will expire. Defaults to 24 hours after the creation of the payment session
mode
string
Indicates whether the Checkout Session is in live mode or in test mode.
session_token
string
Temporary token to configure the widget.
status
string
Session status. Can be either created, in_progress, finishedor expired
metadata
hash
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
If you create a payment without providing metadata, this field will be null when receiving notifications about the final status.
payment_method_options
hash
Optional array of settings for each available Payment Method
business_profile
hash
Optional object to identify enrolled merchants for category-based pricing.
Payment Intent Options
Use these options to configure the Payment Intent Payment Method when creating a Checkout Session
Attribute
Type
Description
recipient_account
string
Object that points to the recipient account. Take a look at the Recipient Acccount object table below to learn more. If you use Fintoc Collects for payments, omit this object during payment creation for better stability.
sender_account
string
Object that points to the sender account. Take a look at the Sender Acccount object table below to learn more.
When you receive final payment status notifications, sender_account may be null if the user abandoned the payment before specifying a sender account.
Recipient Object
Attribute
Type
Description
holder_id
string
Identifier of the owner of the account. In Chile, the value corresponds to a RUT and in Mexico it's either an RFC or CURP. The editable field indicates whether the user is allowed to change the preset username or not.
number
string
Account number. Does not include hyphens or prefixed zeros
type
string
Account type. It can be checking_account or sight_account
institution_id
string
Account's institution id. You can learn more about institutions and their ids here
Sender Object
Attribute
Type
Description
holder_id
object
Identifier of the owner of the account. In Chile, it corresponds to a RUT and in Mexico it's either an RFC or CURP.
institution_id
string
Account's institution id. You can learn more about institutions and their ids here
Business Profile Object
Attribute
Type
Description
category
string
Identifier of the category of the enrolled merchant. In Chile, it corresponds to a 6 character SII activity code.
tax_id
string
Enrolled merchant's tax identifier. In Chile, it corresponds to a RUT.