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

Authorizations

Authorization
string
header
required

Body

application/json
amount
integer
required

Amount to collect, in the smallest unit of currency. For example, 5000 represents 5000 CLP, since CLP has no minor unit, or 50.00 MXN. Must be greater than 0.

Example:

5000

currency
enum<string>
required

Three-letter ISO 4217 currency code. One of CLP (Chilean peso) or MXN (Mexican peso). Case-insensitive.

Available options:
CLP,
MXN
Example:

"CLP"

business_profile
object

Required if your organization identifies a business profile per payment. Enrolled merchant on whose behalf you collect the payment, used for category-based billing.

checkout
object

Checkout customization. Supports a single description key.

customer_email
string

Email address of your customer, used for transaction notifications, including refunds.

Example:

"customer@example.com"

expires_after_seconds
integer

Number of seconds after which the payment link expires. Must be greater than 0. If omitted, the payment link never expires.

Example:

86400

metadata
object

Set of key-value pairs you can attach to the payment link to store additional information in a structured format.

Example:
recipient_account
object

Required if your organization uses the Fintoc Reconciles schema without a default pool account. Destination bank account for the payments collected with the link. Available only in Chile. Do not send it if your organization uses Fintoc Collects, where Fintoc presets the account for you.

Response

Payment link created. Share the returned url with your customer to collect the payment.

id
string
required

Unique identifier of the payment link.

Example:

"plink_K2zwNNSxPyx8w3GZ"

object
any
required

Type of the object. Always payment_link.

amount
integer
required

Amount to collect, in the smallest unit of currency. For example, 5000 represents 5000 CLP, since CLP has no minor unit, or 50.00 MXN.

Example:

5000

checkout
object
required

Checkout customization. The description key holds the text shown next to the buy button, or null when you do not set it.

Example:
created_at
string<date-time>
required

ISO 8601 datetime in UTC of when the payment link was created.

Example:

"2024-04-04T15:23:11.474Z"

currency
enum<string>
required

Three-letter ISO 4217 currency code. One of CLP (Chilean peso) or MXN (Mexican peso).

Available options:
CLP,
MXN
Example:

"CLP"

customer_email
string | null
required

Email address of your customer, used for transaction notifications. null when not provided on creation.

Example:

"customer@example.com"

expires_at
string<date-time> | null
required

ISO 8601 datetime in UTC of when the payment link expires. null when the payment link does not expire.

Example:

"2024-04-05T15:23:11.474Z"

metadata
object
required

Set of key-value pairs attached to the payment link on creation.

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"

recipient_account
object | null
required

Destination bank account for the payments collected with the link. null unless your organization sent it on creation.

status
enum<string>
required

Status of the payment link. One of active (accepts payments), expired (the expiration date passed), or canceled (you canceled the link).

Available options:
active,
expired,
canceled
Example:

"active"

url
string
required

URL of the page where your customer pays.

Example:

"https://pay.fintoc.com/plink_K2zwNNSxPyx8w3GZ"