Versions Compared

Version Old Version 17 New Version Current
Changes made by

Leatherback (Unlicensed)

Leatherback (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
bgColor#79E2F2

Title: Get all Payment linklinks

Panel
bgColor#F4F5F7

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

Panel
bgColor#F4F5F7

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

Headers : authorization key string : X-API Set value to : SECRET_KEYBase URL: https://laas.leatherback.co
Panel
bgColor#F4F5F7

HTTP Method : GET

Panel
bgColor#F4F5F7
Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFC400

 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

Panel
bgColor#FFC400

Query Request Params Sample Response Payload

Below shows different sample response scenarios;

 

 

Panel
bgColor#FFC400

Response Body Response code : 200

...

languagejs

...

Expand
titleSample Response (Success)
Code Block
languagejs

...

filterParam
string
(query)
filterParam
pageSize
integer($int32)
(query)
pageSize
pageNumber
integer($int32)
(query)

{
    "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
}

 

Expand
titleSample Response (Sample Response Payload - If no data)

Code Block
languagejs
{
    "items": [],
    "pageParams": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalCount":

...

0
    },
    "isSuccess": true,
    "error": "",
    "message": "Request Successful",
    "responseCode": null
}

Expand
titleSample Response Error (Bad Request)
Code Block
languagejs
{
    "type": "https://httpstatuses.io/400",
    "title": "Bad Request",
    "status": 400,
    "traceId": "00-6c8cde6d25f77646deda7230015a88c0-d2be5f7d289728b2-00"
}

...