Skip to main content
POST
/
v1
/
ext
/
collections
/
payment-link
Create a Payment Link - Checkout Widget
curl --request POST \
  --url https://staging-api.liquidity.walletos.xyz/v1/ext/collections/payment-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "USD",
  "expiredAt": "2025-05-01T00:00:00Z",
  "name": "second payment",
  "amount": 15.75,
  "amountLocked": true,
  "redirectTo": "https://example.com/thank-you",
  "customerPays": false,
  "customUrlPath": "pay-now",
  "dataCollections": [
    "Name",
    "Email"
  ],
  "customFields": [
    "Referral Code",
    "Notes"
  ],
  "isOpenLink": true,
  "acceptedPaymentOptions": [
    "card",
    "google_pay",
    "apple_pay",
    "cashapp"
  ]
}
'
{
  "data": {
    "url": "https://sandbox.checkout.centryos.xyz/page/sATA3BiyVi42g3OgrD54ANNllMXtA",
    "application": {
      "id": "b837dcf1-6c68-4cbb-a01d-3ad144f80060",
      "token": "sATA3BiyVi42g3OgrD54ANNllMXtA",
      "expiredAt": "2025-05-01T00:00:00.000Z",
      "valid": true
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
currency
string
required

The currency code for the payment (e.g., "USD", "NGN")

​
expiredAt
string<date-time>
required

The expiration date and time for the payment link

​
name
string
required

The name or title of the payment link

​
amount
number
required

The payment amount

​
amountLocked
boolean

Whether the amount is locked and cannot be changed by the customer

​
redirectTo
string<uri>

URL to redirect to after successful payment

​
customerPays
boolean

Whether the customer pays the processing fee

​
customUrlPath
string

Custom URL path for the payment link

​
dataCollections
string[]

Array of data collection fields to include in the payment form

​
customFields
string[]

Array of custom fields to include in the payment form

​
isOpenLink
boolean

Whether this is an open payment link (customers can enter any amount)

​
acceptedPaymentOptions
string[]

Array of accepted payment methods

​
externalId
string

External reference ID for the payment link

​
collectionAccountId
string

The collection account ID to receive the payment

​
cartItems
object[]

Response

200 - application/json

OK

The response is of type object.