Skip to main content

TempLinkDetails

idintegerrequired

Unique identifier for the temporary link

Example: 123
namestringrequired

Name of the temporary link

Example: Invoice #1234
urlurirequired

Full payment URL to share with customers

Example: https://getbasilic.com/pay/abc123xyz
shortUrluri

Short payment URL to share with customers

Example: https://getbasilic.com/t/abc123xyz
amountdecimalrequired

Payment amount

Example: 150
currencystringrequired

Currency code

Example: USD
statusstringrequired

Current status of the link

Possible values: [active, paid, expired, cancelled]

Example: active
paymentLinkIdinteger

Payment link template ID

Example: 17
paymentLinkNamestring

Payment link template name

Example: Standard Invoice Template
dueDatetimedate-time

Scheduled expiration timestamp of the temporary link

Example: 2025-01-03T10:00:00.000Z
formData object

Pre-filled form data

property name* FormValueObject
valuestringrequired

The actual value to be stored

labelstringrequired

Human-readable label for display

supportedPaymentsstring[]

Allowed payment methods

Possible values: [crypto, bank_transfer, credit_card, argentine_bank]

merchantIdstringnullable

Your internal reference ID

Example: ORDER_12345
redirectUrlurinullable

Single redirect URL used for both success and failure when configured.

Example: https://merchant.example/checkout/result
successUrlurinullable

Redirect URL used after a successful payment completion.

Example: https://merchant.example/checkout/success
failureUrlurinullable

Redirect URL used after a failed payment completion.

Example: https://merchant.example/checkout/failure
metadata object

Custom metadata

property name*any

Custom metadata

Example: {"order_id":"12345"}
createdAtdate-timerequired

Creation timestamp

Example: 2025-01-01T10:00:00.000Z
expiresAtdate-timerequired

Expiration timestamp

Example: 2025-01-03T10:00:00.000Z
paidAtdate-timenullable

Payment completion timestamp

Example: 2025-01-01T12:30:00.000Z
cancelledAtdate-timenullable

Cancellation timestamp

Example: null
TempLinkDetails
{
  "id": 123,
  "name": "Invoice #1234",
  "url": "https://getbasilic.com/pay/abc123xyz",
  "shortUrl": "https://getbasilic.com/t/abc123xyz",
  "amount": 150,
  "currency": "USD",
  "status": "active",
  "paymentLinkId": 17,
  "paymentLinkName": "Standard Invoice Template",
  "dueDatetime": "2025-01-03T10:00:00.000Z",
  "formData": {},
  "supportedPayments": [
    "crypto"
  ],
  "merchantId": "ORDER_12345",
  "redirectUrl": "https://merchant.example/checkout/result",
  "successUrl": "https://merchant.example/checkout/success",
  "failureUrl": "https://merchant.example/checkout/failure",
  "metadata": {
    "order_id": "12345"
  },
  "createdAt": "2025-01-01T10:00:00.000Z",
  "expiresAt": "2025-01-03T10:00:00.000Z",
  "paidAt": "2025-01-01T12:30:00.000Z",
  "cancelledAt": null
}