Skip to main content
POST
/
v1
/
ext
/
collections
/
payment-link
Create a Payment Link
curl --request POST \
  --url https://staging-api.liquidity.walletos.xyz/v1/ext/collections/payment-link \
  --header 'Content-Type: application/json' \
  --data '
{
  "currency": "USD",
  "expiredAt": "2025-12-31T23:59:59Z",
  "name": "Invoice Payment #12345",
  "amount": 100,
  "redirectTo": "https://example.com/thank-you",
  "amountLocked": true,
  "customerPays": false,
  "customUrlPath": "pay-now",
  "dataCollections": [
    "Phone"
  ],
  "customFields": [
    "Notes",
    "Reference Number"
  ],
  "isOpenLink": true,
  "acceptedPaymentOptions": [
    "card",
    "cashapp",
    "google_pay"
  ],
  "externalId": "acc_123456789",
  "cartItems": [
    {
      "name": "Product name",
      "description": "Product description",
      "qty": 1,
      "price": 500,
      "currency": "USD",
      "productId": "prod_123"
    }
  ],
  "advancedConfig": {
    "websiteUrl": "https://example.com",
    "webhookPath": "/v1/cb/payment-successful",
    "webhookSecret": "your-webhook-secret"
  }
}
'
{
  "data": {
    "url": "https://sandbox.checkout.centryos.xyz/sATA3BiyVi42g3OgrD54ANNllMXtA",
    "application": {
      "id": "b837dcf1-6c68-4cbb-a01d-3ad144f80060",
      "token": "sATA3BiyVi42g3OgrD54ANNllMXtA",
      "expiredAt": "2025-05-01T00:00:00.000Z",
      "valid": true
    }
  }
}

Body

application/json
​
currency
string
required

Currency code for the payment

Example:

"USD"

​
expiredAt
string<date-time>
required

Expiration date and time for the payment link

Example:

"2025-12-31T23:59:59Z"

​
name
string
required

Name or title of the payment link

Example:

"Invoice Payment #12345"

​
amount
number
required

Payment amount

Example:

100

​
redirectTo
string<uri>
required

URL to redirect to after successful payment

Example:

"https://example.com/thank-you"

​
amountLocked
boolean

Whether the amount can be modified by the customer

Example:

true

​
customerPays
boolean

Whether the customer pays the processing fee

Example:

false

​
customUrlPath
string

Custom URL path for the payment link

Example:

"pay-now"

​
dataCollections
string[]

Additional data fields to collect (email, name included by default)

Example:
["Phone"]
​
customFields
string[]

Custom fields for the payment form

Example:
["Notes", "Reference Number"]
​
isOpenLink
boolean

If false, link expires after first use

Example:

true

​
acceptedPaymentOptions
enum<string>[]

Accepted payment methods

Available options:
card,
cashapp,
google_pay,
apple_pay
Example:
["card", "cashapp", "google_pay"]
​
externalId
string

End user account ID for linking payments

Example:

"acc_123456789"

​
cartItems
object[]

List of cart items for ecommerce checkout

​
advancedConfig
object

Advanced webhook configuration

Response

200 - application/json

Success

​
data
object