Skip to main content

API endpoint mapping

Create a payment request

  • Request body schema is identical — no changes required
  • Only the URL path changes from /payment-links to /checkouts

List payment requests

  • Response key changes from paymentLinks to checkouts
  • Pagination (pageSize, pageToken, nextPageToken) is unchanged
  • Status filter values are unchanged

Retrieve a specific payment request

  • Path parameter renamed from paymentLinkId to id
  • ID format (24-character hexadecimal) is unchanged

Deactivate a payment request

  • Path parameter renamed from paymentLinkId to id
  • Behavior is identical — only ACTIVE resources can be deactivated

Response schema mapping

Payment details

Payment Link API FieldCheckouts API FieldNotes
ididSame format (24-character hexadecimal)
urlurlSame purpose
statusstatusSame values (ACTIVE, PROCESSING, DEACTIVATED, EXPIRED, COMPLETED, FAILED)
amountamountUnchanged
currencycurrencyUnchanged
networknetworkUnchanged
addressaddressUnchanged
tokenAddresstokenAddressUnchanged
descriptiondescriptionUnchanged
metadatametadataUnchanged
expiresAtexpiresAtUnchanged
successRedirectUrlsuccessRedirectUrlUnchanged
failRedirectUrlfailRedirectUrlUnchanged
createdAtcreatedAtUnchanged
updatedAtupdatedAtUnchanged
settlementsettlementUnchanged
transactionHashtransactionHashUnchanged

Webhook event mapping

Updating your subscriptions

Event type mapping

Payment Link API EventCheckouts API Event
payment_link.payment.successcheckout.payment.success
payment_link.payment.failedcheckout.payment.failed
payment_link.payment.expiredcheckout.payment.expired

Node.js implementation examples