Skip to main content
GET
Get a payment link
v1 · Base URL https://api.fintoc.com/v1 ❗️Consider that in some cases the API response may contain empty fields

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

Unique identifier of the payment link to retrieve.

Response

The payment link.

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"