Online Payments

Create a payment intent

To Create a Payment IntentAPI, specify the necessary details such as currency, payment method, and amount.

curl -L '{{PRODUCTION_API_URL}}/v1/payment-intents' \
    -H '{{ACCOUNT_HEADER}}-account: {{MERCHANT_ACCOUNT_ID}}' \
    -H 'Content-Type: application/json' \
    -H '{{ACCOUNT_HEADER}}-api-key: {{SECRET_KEY}}' \
    -d '{
      "amount": 1000,
      "currency": "usd",
      "payment_method_types": [
        "card"
      ],
      "confirm": true,
      "payment_method_id": "{{PAYMENT_METHOD_ID}}"
              }'

Best practices when creating a payment intent

• Create a Payment IntentAPI at the beginning of the checkout process, once you know the total amount. If the amount changes, you can Update a Payment IntentAPI as needed.
• If the checkout process is interrupted and later resumed, reuse the existing payment intent instead of creating a new one. Reusing the payment intent helps in monitoring any failed payment attempts and keeps the transaction history organized for each cart or session.

Confirm the payment

In order to confirm a payment intent, the payment method details or a payment_method_id must be specified. You can confirm at creation by setting confirm=true in the request body.

If the payment intent status is requires_payment_method, you'll need to attach a payment method using the Confirm a Payment IntentAPI endpoint.

curl -L '{{PRODUCTION_API_URL}}/v1/payment-intents/{{PAYMENT_INTENT_ID}}/confirm' \
    -H '{{ACCOUNT_HEADER}}-account: {{MERCHANT_ACCOUNT_ID}}' \
    -H 'Content-Type: application/json' \
    -H '{{ACCOUNT_HEADER}}-api-key: {{SECRET_KEY}}' \
    -d '{
      "payment_method_id": "{{PAYMENT_METHOD_ID}}"
          }'