Checkout Session Object

{
  "id": "cs_li5531onlFDi235",
  "created_at": "2021-10-15T15:22:11.474Z",
  "object": "checkout_session",
  "currency": "clp",
  "amount": 1200,
  "customer_email": "[email protected]",
  "expires_at": "2024-11-12T14:41:25Z",
  "mode": "live",
  "status": "finished",
  "session_token": "cs_li5531onlFDi235_sec_a4xK32BanKWYn",
  "country": 'cl',
  "cancel_url": "https://merchant.com/987654321",
  "success_url": "https://merchant.com/success",
  "redirect_url": "https://pay.fintoc.com/payment?checkout_sesion=cs_li5531onlFDi235",
  "metadata": {
    "order_id": "#12513"
  },
  "payment_resource":{
    "payment_intent":{
        "id":"pi_B4kdYzSVREeMAPv0",
        "mode":"live",
        "amount":1200,
        "object":"payment_intent",
        "status":"succeeded",
       	"currency":"CLP",
        "metadata":{
            "order_id":"#12513",
            },
        "created_at":"2024-11-12T14:41:29Z",
        "error_reason":null,
        "reference_id":"426686855",
        "widget_token":null,
        "customer_email":null,
        "sender_account":{
            "type":"checking_account",
            "number":"227110011",
            "holder_id":"123456789",
            "institution_id":"cl_banco_estado"
            },
        "transaction_date":"2024-12-24T12:22:33Z",
        "recipient_account":{
            "type":"checking_account",
            "number":"922358017",
            "holder_id":"771433855",
            "institution_id":"cl_banco_security"
            }
        }
    },
  "payment_method_options": {
    "payment_intent": {
      "recipient_account": {
        "type":"checking_account",
        "number":"922358017",
        "holder_id":"771433855",
        "institution_id":"cl_banco_security"
		    },
      "sender_account": {
        "holder_id": {
          "editable": "false",
          "value": "12345678-9"
        },
        "institution_id": {
          "value": "cl_banco_estado"
        }
      }
    },
  "business_profile": {
    "name":"Merchant Name",
    "category": "009613",
    "tax_id": "774981120"
  	},
 }

Attribute

Type

Description

id

string

Unique identifier for the Checkout Session

created_at

string

Checkout Session's creation date, using ISO 8601

object

string

Identifier for the type of object. Its value for Checkout Session will always correspond to checkout_session

currency

string

Currency ISO code. For now, we only support CLP and MXN.

amount

integer

Amount to pay, represented as an integer. This value must always be greater than 0

customer_email

string

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

success_url

string

URL to redirect the user in case of payment succeeded.

cancel_url

string

URL to redirect the user in case they decide to cancel the payment and return to your website.

redirect_url

string

URL to redirect the user to complete the payment using the Fintoc widget.

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_resource

object

Payment resource associated to the session once the payment is finished. If the session has not finished or expired, this field will be null

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

AttributeTypeDescription
holder_idstringIdentifier 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.
numberstringAccount number. Does not include hyphens or prefixed zeros
typestringAccount type. It can be checking_account or sight_account
institution_idstringAccount'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 the user's phone number.

institution_id

string

Only for CL 🇨🇱
Account's institution id. You can learn more about institutions and their ids here


Business Profile Object

AttributeTypeDescription
namestringEnrolled merchant´s name. If set, will be shown as the "Recipient" on the succeeded payment screen.
categorystringIdentifier of the category of the enrolled merchant. In Chile, it corresponds to a 6 character SII activity code.
tax_idstringEnrolled merchant's tax identifier. In Chile, it corresponds to a RUT.