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.

Create a payment link

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 '{
    "amount": 25000,
    "currency": "XOF",
    "country": "SN",
    "feeMode": "merchant_pays",
    "description": "Consultation fee",
    "paymentMethodTypes": ["mobile_money", "card"],
    "isSingleUse": false
  }'

Parameter	Type	Description
amount	integer:int64	Link amount in the smallest currency unit.
currency	string	Link currency.
country	string	Country code for the associated checkout.
feeMode	string	Fee mode, default merchant_pays.
description	string	Customer-facing description.
paymentMethodTypes	string[]	Offered methods.
expiresAt	string:date-time	Optional expiration date.
isSingleUse	boolean	Makes the link single-use.

Retrieve a payment link

GET /api/v1/payment_links/{id}

Deactivate a payment link

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

Related sections

• Checkout Sessions
• Payments Overview
• Route Families