commerce

Create a payment link

Create a Paystack-hosted checkout link for one amount (or priced items) and send it over any channel.

Pass amount (rands) for a free-amount link, or items ([{ product_id, quantity }]) and the total is priced from the product rows; amount is ignored when items are present, so a request can never name its own total.

Requires a connected Paystack account (Selling settings). mode: "test" in the response means the merchant's keys are test keys: the link will look like it collects and no money will move.

Send the returned checkout_url over WhatsApp, SMS or email with the messages API; payment lands as a commerce.order.paid webhook.

post/api/v1/commerce/payment-links

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/commerce/payment-links
  • Auth: HTTP bearer

Request body

amountnumber
customer_emailstring email required
descriptionstring

Example request

{
  "amount": 450,
  "customer_email": "sam@example.com",
  "description": "Deposit for Saturday booking"
}

Response

Success

okboolean required
modestring required

Example response

{
  "ok": true,
  "order": {
    "id": "0e336439-8c7a-49c6-9e96-20b1f8887a5a",
    "reference": "bt_9775b4c2d89ada56abeb55dd",
    "amount_cents": 45000,
    "checkout_url": "https://checkout.paystack.com/xglrxrmjurl91ln"
  },
  "mode": "test"
}

Changes

No recorded changes to this operation across all 1 revision of this API.