Skip to main content

Payment Links

Payment links let you expose a hosted payment entry point without building your own checkout UI.

Implemented route families​

Authenticated route family:

  • POST /api/v1/payment_links
  • GET /api/v1/payment_links/{id}
  • POST /api/v1/payment_links/{id}/deactivate

Public access route:

  • GET /pay/{slug}

The public route resolves the link and redirects the customer to a checkout session URL.

POST /api/v1/payment_links

Authentication:

  • ApiKey or AppToken
  • write scope for payments

Example:

curl -X POST https://api.ikawaari.com/api/v1/payment_links \
  -H "Authorization: Bearer ik_test_or_app_token" \
  -H "Content-Type: application/json" \
  -d '{
    "line_items": [
      {
        "name": "Consultation fee",
        "amount": 25000,
        "currency": "XOF",
        "quantity": 1
      }
    ],
    "after_completion": {
      "type": "redirect",
      "redirect": {
        "url": "https://yoursite.com/thank-you"
      }
    }
  }'
GET /api/v1/payment_links/{id}
POST /api/v1/payment_links/{id}/deactivate

Public customer access​

GET /pay/{slug}

This public route resolves the slug, creates or retrieves the associated checkout session, and redirects the customer to the hosted checkout URL.

Operational note​

Payment links are part of the implemented checkout domain and are tightly related to:

  • hosted checkout sessions
  • merchant dashboard payment-link management
  • public checkout access via slug-based entry points