ListTempLinksResponse

successbooleanrequired

Example: true

data object[]required

Array [

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"}

client objectnullable

Client bound to this temporary payment link, when applicable.

iduuidrequired

Example: 4f0de7f2-7cd9-4ea2-bb82-f3118ddbe940

taxIdstringrequired

Example: 30712345678

namestringrequired

Example: Acme SA

paymentStatus object

Status of payments collected for this specific temporary link.

statusstringrequired

Collection status for this specific temporary link only.

Possible values: [unpaid, partial, paid, overpaid]

Example: partial

requestedAmountdecimalrequired

Target amount configured on the temporary link.

Example: 150

paidAmountdecimalrequired

Amount collected through completed payments for this temporary link.

Example: 75

remainingAmountdecimalrequired

Amount still pending on this temporary link.

Example: 75

paymentCountintegerrequired

Total number of payment attempts linked to this temporary link.

Example: 2

completedPaymentCountintegerrequired

Number of completed payments linked to this temporary link.

Example: 1

currencystringrequired

Currency of the temporary link amount.

Example: USD

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

]

pagination objectrequired

pageintegerrequired

Current page number

Example: 1

limitintegerrequired

Items per page

Example: 20

totalintegerrequired

Total number of items

Example: 150

totalPagesintegerrequired

Total number of pages

Example: 8

ListTempLinksResponse

{
  "success": true,
  "data": [
    {
      "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"
      },
      "client": {
        "id": "4f0de7f2-7cd9-4ea2-bb82-f3118ddbe940",
        "taxId": "30712345678",
        "name": "Acme SA"
      },
      "paymentStatus": {
        "status": "partial",
        "requestedAmount": 150,
        "paidAmount": 75,
        "remainingAmount": 75,
        "paymentCount": 2,
        "completedPaymentCount": 1,
        "currency": "USD"
      },
      "createdAt": "2025-01-01T10:00:00.000Z",
      "expiresAt": "2025-01-03T10:00:00.000Z",
      "paidAt": "2025-01-01T12:30:00.000Z",
      "cancelledAt": null
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}