Fetch payment links

Fetch a paginated list of payment links.

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

Query Parameters

NameTypeDescription

limit

Number

The number of records per page. Defaults to 100.

page

Number

The current page. Defaults to 1.

{
    "success": true,
    "message": "Query successful",
    "data": {
        "records": [
            {
                "uuid": "f677c75f-310b-4964-ab00-1ade5799f18e",
                "name": "Odogwu moves",
                "description": "Some moves by an Odogwu",
                "imageFilePath": null,
                "reference": "B0yeo8JB9fj9Q7EHkPGhdtTf7jOydlFTWjEj",
                "amount": 150,
                "baseFiat": "NGN",
                "environment": "TEST",
                "redirectLink": null,
                "successMessage": "An odogwu success message to my user",
                "businessId": "dd220826-16bf-46d2-9ecf-2b57c3081fb8",
                "userId": "9ca14b87-c683-4918-af56-b87315eab0f7",
                "customerId": null,
                "completedAt": "2022-10-04T18:15:47.642Z",
                "deletedAt": null,
                "createdAt": "2022-10-04T18:15:47.642Z",
                "isActive": 1
            },
            {
                "uuid": "74e39585-f8a2-4ab1-a72a-cb26704cf131",
                "name": "Odogwu moves",
                "description": "Some moves by an Odogwu",
                "imageFilePath": null,
                "reference": "19foLuOcvRJUu2tJ5lOAOuZDo16y1BCqhvtT",
                "amount": 150,
                "baseFiat": "NGN",
                "environment": "TEST",
                "redirectLink": null,
                "successMessage": "An odogwu success message to my user",
                "businessId": "da47d362-1f12-4688-acd9-f652f028b6fe",
                "userId": "43522ee1-5f0e-4b49-bf1a-b04f9dcd4428",
                "customerId": null,
                "completedAt": "2022-08-30T09:07:57.797Z",
                "deletedAt": null,
                "createdAt": "2022-08-30T09:07:57.797Z",
                "isActive": 1
            }
        ],
        "count": 23
    }
}

Last updated