Get payment link by ID (Partner API)

Server URLloading...

GET

/partner_api/payment_links/{id}

Send

Authorization

Path

Retrieves a payment link by its ID with real-time payment availability status.

Key Information:

• Returns the same structure as the create endpoint
• canReceivePayments field reflects current link status
• Use this endpoint to check if a link can accept new payments before directing customers

Authentication:

• Requires API key headers X-API-KEY and X-API-KEY-ID

Access Control:

• Only returns payment links that belong to the authenticated business

Use Cases:

• Verify link availability before sharing with customers
• Check payment link status in your application
• Validate single-use links before reuse

Path Parameters

Response Body

curl -X GET "https://example.com/partner_api/payment_links/497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "id": "string",  "storeId": "string",  "title": "string",  "amount": {    "amount": 0,    "currency": "XOF"  },  "allowMultiplePayments": true,  "canReceivePayments": true,  "link": "http://example.com"}