Create a payment link

Creating a payment link.

POST https://api.ivorypay.io/v1/payment-links

Request Body

NameTypeDescription

name*

String

A name for the product/service you want to bundle into a payment link.

description*

String

A description for your payment link

baseFiat*

String

A local currency in which the item in your payment link will be priced

amount*

String

The price for the product/service you want to bundle into the payment link.

imageFile

Blob

An image file to give your customer a visual representation of the product/service.

successMessage

String

A custom message that will be sent to your customer after a successful payment

redirectLink

String

A URL to which your customer will be redirected after a successful payment.

{
    "success": true,
    "message": "Payment link was created successfully",
    "data": {
        "name": "Odogwu moves",
        "description": "Some moves by an Odogwu",
        "baseFiat": "NGN",
        "amount": 150,
        "successMessage": "An odogwu success message to my user",
        "imageFilePath": null,
        "businessId": "dd220826-16bf-46d2-9ecf-2b57c3081fb8",
        "userId": "9ca14b87-c683-4918-af56-b87315eab0f7",
        "reference": "B0yeo8JB9fj9Q7EHkPGhdtTf7jOydlFTWjEj",
        "environment": "TEST",
        "redirectLink": null,
        "customerId": null,
        "completedAt": "2022-10-04T18:15:47.642Z",
        "deletedAt": null,
        "uuid": "f677c75f-310b-4964-ab00-1ade5799f18e",
        "createdAt": "2022-10-04T18:15:47.642Z",
        "isActive": 1
    }
}

After creating a payment link, use the reference property to compose your shareable link of this form:

https://pl.ivorypay.io/pay/:your_reference

Last updated