API endpoint mapping
Create a payment request
- Payment Link API
- Checkouts API
Key changes
Key changes
- Request body schema is identical — no changes required
- Only the URL path changes from
/payment-linksto/checkouts
List payment requests
- Payment Link API
- Checkouts API
Key changes
Key changes
- Response key changes from
paymentLinkstocheckouts - Pagination (
pageSize,pageToken,nextPageToken) is unchanged - Status filter values are unchanged
Retrieve a specific payment request
- Payment Link API
- Checkouts API
Key changes
Key changes
- Path parameter renamed from
paymentLinkIdtoid - ID format (24-character hexadecimal) is unchanged
Deactivate a payment request
- Payment Link API
- Checkouts API
Key changes
Key changes
- Path parameter renamed from
paymentLinkIdtoid - Behavior is identical — only
ACTIVEresources can be deactivated
Response schema mapping
Payment details
| Payment Link API Field | Checkouts API Field | Notes |
|---|---|---|
id | id | Same format (24-character hexadecimal) |
url | url | Same purpose |
status | status | Same values (ACTIVE, PROCESSING, DEACTIVATED, EXPIRED, COMPLETED, FAILED) |
amount | amount | Unchanged |
currency | currency | Unchanged |
network | network | Unchanged |
address | address | Unchanged |
tokenAddress | tokenAddress | Unchanged |
description | description | Unchanged |
metadata | metadata | Unchanged |
expiresAt | expiresAt | Unchanged |
successRedirectUrl | successRedirectUrl | Unchanged |
failRedirectUrl | failRedirectUrl | Unchanged |
createdAt | createdAt | Unchanged |
updatedAt | updatedAt | Unchanged |
settlement | settlement | Unchanged |
transactionHash | transactionHash | Unchanged |
Webhook event mapping
Updating your subscriptions
- Payment Link API subscription
- Checkouts API subscription
Event type mapping
| Payment Link API Event | Checkouts API Event |
|---|---|
payment_link.payment.success | checkout.payment.success |
payment_link.payment.failed | checkout.payment.failed |
payment_link.payment.expired | checkout.payment.expired |
Node.js implementation examples
- Payment Link API
- Checkouts API