Skip to main content

Payment API

Info

Use these endpoints for in-app SmartPay payments. They support custom metadata and return that metadata after a successful payment.

Warning

Payment routes use HMAC headers, not bearer tokens: X-API-Key-ID, X-Timestamp, and X-Signature.

Endpoints​

Process Payment

POST /api/v1/payment

Process an in-app SmartPay payment and attach arbitrary metadata

Verify Card

POST /api/v1/payment/verify-card

Same behavior as the POS verify-card endpoint

Refund

POST /api/v1/payment/refund

Same behavior as the POS refund endpoint

Lookup Card

POST /api/v1/payment/lookup-card

Same behavior as the POS lookup-card endpoint

Notes​

  • POST /api/v1/payment is for in-app payments, not POS terminal payments.
  • terminal_id is not used on this route.
  • Custom metadata can be any valid JSON object, array, string, number, boolean, or null and is echoed back in the success response.
  • POST /api/v1/payment/verify-account is also available and mirrors the POS account verification route.