Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 19 Current »

Title: Get all Payment links

Description: This endpoint may be used to get all payment links associated with a Merchant’s Account

URL: https://laas.leatherback.co/api/payment/payment-link/

HTTP Method : GET

 Table below shows expected Parameters;

Element

Description

Type

Example

pageSize

The number of items display on a single page,

Integer | query Params

Default: 10

page

pageNumber

The current page of the items returned

Integer | query Params

Default: 1

 Sample Response Payload

Below shows different sample response scenarios;

 Sample Response (Success)
{
    "items": [
        {
            "id": "dbb018fc-7b03-4fa7-8274-08dc7ef7dffe",
            "name": "Invoice Test 5",
            "description": "Test",
            "alias": "0-z0bituv",
            "link": "https://pay.leatherback.co/0-z0bituv",
            "amountInfo": {
                "currencyCode": "NGN",
                "amount": 120.00
            },
            "linkType": "Reuseable",
            "amountType": "Dynamic",
            "supportEmail": null,
            "logo": null,
            "status": "Active",
            "createdDate": "2024-06-18T13:21:10.7721355",
            "environment": "Test"
        },
        {
            "id": "a53e8c12-9ac3-4032-8273-08dc7ef7dffe",
            "name": "Invoice Test 5",
            "description": "Test",
            "alias": "0-rbqcxwx",
            "link": "https://pay.leatherback.co/0-rbqcxwx",
            "amountInfo": {
                "currencyCode": "GBP",
                "amount": 12.00
            },
            "linkType": "Reuseable",
            "amountType": "Dynamic",
            "supportEmail": null,
            "logo": null,
            "status": "New",
            "createdDate": "2024-06-18T13:20:50.0680015",
            "environment": "Test"
        }
    ],
    "pageParams": {
        "pageNumber": 1,
        "pageSize": 2,
        "totalCount": 14
    },
    "isSuccess": true,
    "error": "",
    "message": "Request Successful",
    "responseCode": null
}

 

 Sample Response (Sample Response Payload - If no data)

{
    "items": [],
    "pageParams": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalCount": 0
    },
    "isSuccess": true,
    "error": "",
    "message": "Request Successful",
    "responseCode": null
}
 Sample Response Error (Bad Request)
{
    "type": "https://httpstatuses.io/400",
    "title": "Bad Request",
    "status": 400,
    "traceId": "00-6c8cde6d25f77646deda7230015a88c0-d2be5f7d289728b2-00"
}
  • No labels

Leatherback 2024