Skip to main content
POST
Expire a payment intent
v1 · Base URL https://api.fintoc.com/v1

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

The id of the payment intent to expire.

Response

The expired payment intent, with status expired and error_reason manually_expired.

id
string
required

Unique identifier of the payment intent.

Example:

"pi_BO381oEATXonG6bj"

object
any
required

Type of the object. Always payment_intent.

amount
integer
required

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).

Example:

100000

created_at
string<date-time>
required

ISO 8601 timestamp of when the payment intent was created.

Example:

"2021-10-15T15:23:11.474Z"

currency
enum<string>
required

Three-letter ISO 4217 currency code of the payment intent. One of CLP or MXN.

Available options:
CLP,
MXN
Example:

"CLP"

customer
object | null
required

Customer associated with the payment intent, when it was created from a checkout session with a customer. null otherwise.

customer_email
string | null
required

Email address of the customer that receives payment notifications. null when not provided.

Example:

"jon.snow@example.com"

error_reason
string | null
required

Reason why the payment failed, was rejected, or expired. null while the payment is in progress and when it succeeds.

Example:

"insufficient_funds"

expires_at
string<date-time> | null
required

ISO 8601 timestamp of when the payment expires and can no longer be paid. Only set for cash payments; null otherwise.

metadata
object
required

Set of key-value pairs attached to the payment intent.

Example:
mode
enum<string>
required

Mode of the object. live objects use real institution data, test objects use fake data for integration testing.

Available options:
test,
live
Example:

"live"

next_action
object | null
required

Action the customer must complete to continue the payment, as reported by the widget. null when no action is pending.

payment_method
string | null
required

Identifier of the payment method used to pay, when the payment intent comes from a checkout session or a subscription. null otherwise.

Example:

"pm_1x7vKQ8oEATXonG6"

payment_type
string
required

Payment type used to pay, such as bank_transfer or cash.

Example:

"bank_transfer"

payment_type_options
object
required

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.

Example:
recipient_account
object | null
required

Bank account that receives the payment. null for cash payments.

reference_id
string | null
required

Identifier of the transfer assigned by the institution. null until the transfer is executed.

Example:

"90123712"

sender_account
object | null
required

Bank account the customer pays from. null until Fintoc identifies the sender.

status
enum<string>
required

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).

Available options:
created,
failed,
succeeded,
rejected,
in_progress,
pending,
expired
Example:

"succeeded"

subscription
string | null
required

Identifier of the subscription that originated the payment intent. null for one-off payments.

Example:

"sub_dJOd4hcZby9XK1Lm"

transaction_date
string<date-time> | null
required

ISO 8601 timestamp of when the institution executed the transfer. null until the transfer is executed.

Example:

"2021-10-15T15:24:15.474Z"

widget_token
string | null
required

Token used to initialize the Fintoc widget for this payment intent. Only returned when the payment intent is created; null in every other response.

Example:

"pi_BO381oEATXonG6bj_sec_aBcDeFgHiJkLmNoP"

business_profile
object | null

Profile of the business that collects the payment, when provided. null otherwise.