Payment Instructions

Payment instructions guide customers through the cryptocurrency payment process. The payment gateway generates specific instructions for each payment including wallet addresses and amounts.

Getting Payment Instructions

Authenticated Request

GET /api/payment/{paymentId}/provider/{provider}/method/{method}
Authorization: Bearer YOUR_TOKEN

Authentication: OAuth2 token or Client Token with payments.user-instructions.get scope.

Public Checkout Request

From the checkout page (signature-validated):

GET /api/checkout/payment/{paymentId}/provider/{provider}/method/{method}

This public endpoint validates the checkout URL signature and expiration before returning instructions.

Available Payment Methods

To see which payment methods are available for a specific payment:

GET /api/checkout/{paymentId}/payment-methods

Returns the list of cryptocurrencies and payment methods configured for the merchant's payment application based on their currencyWhitelist.

Payment Flow

  1. Customer opens the checkout URL
  2. Customer selects a cryptocurrency
  3. System generates a unique payment address
  4. Customer sends the exact amount to the address
  5. System monitors the blockchain for the transaction
  6. Payment status updates as confirmations are received

Displaying Instructions

When building a custom checkout experience, display these key elements:

  • Payment address — the blockchain address to send funds to
  • Exact amount — the cryptocurrency amount to send
  • QR code — for easy mobile wallet scanning
  • Expiration timer — time remaining to complete payment
  • Confirmation status — real-time blockchain confirmation count

Best Practices

  1. Show the exact amount clearly — customers must send the precise amount
  2. Provide copy functionality — easy one-click address copying
  3. Display expiration — show a countdown timer
  4. Clarify network fees — note that network fees are separate
  5. Mobile optimization — large QR codes, tap-to-copy

Next Steps