Fetch a payment link

Fetch the details of a single payment link by id.

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

Path Parameters

{
    "success": true,
    "message": "Query successful",
    "data": {
        "uuid": "03455f1b-1fc6-4def-bc1d-f2ec7a3a1bd5",
        "name": "Odogwu things",
        "description": "Some ultimate thing",
        "imageFilePath": null,
        "reference": "RRz2HwXrNkPzV89rM3x9lC9UbsugqTgHG9i9",
        "amount": 10,
        "baseFiat": "USD",
        "environment": "TEST",
        "redirectLink": null,
        "successMessage": "My custom success message to my user",
        "businessId": "16085511-9ddb-45bf-96d7-a800037dd251",
        "userId": "1ff97ac4-10f7-44be-be96-78cef60083a2",
        "customerId": null,
        "completedAt": "2022-07-13T16:43:52.459Z",
        "deletedAt": null,
        "createdAt": "2022-07-13T16:43:52.459Z",
        "isActive": 1,
        "business": {
            "uuid": "16085511-9ddb-45bf-96d7-a800037dd251",
            "name": "Odogwu Compass",
            "description": null,
            "logoImagePath": null,
            "email": "nwakasistephendr421@gmail.com",
            "phoneNumber": "+2347030934884",
            "address": null,
            "countryId": "b8b65ddf-668a-4f57-a5b4-fe138dde37ee",
            "industryId": null,
            "staffSize": null,
            "website": null,
            "supportEmail": null,
            "twitter": null,
            "facebook": null,
            "instagram": null,
            "webhookUrl": null,
            "userId": "1ff97ac4-10f7-44be-be96-78cef60083a2",
            "isVerified": false,
            "type": "registered",
            "status": "active",
            "suspensionReason": null,
            "testPublicAddress": "Gzob8QJRxsvKMahWBeDkmEUf27NbVrS3rAd2iwBT6zWr",
            "livePublicAddress": null,
            "context": "TEST",
            "createdAt": "2022-07-08T19:40:07.002Z"
        }
    }
}

Last updated