...
Get all Payment links Endpoint
| Panel |
|---|
|
Title: Get all Payment linklinks |
| Panel |
|---|
|
Description: This service endpoint may be used to get all payment link links associated with a Merchant’s Account |
| Panel |
|---|
|
URL: api : https://laas.leatherback.co/api/payment/payment-link/ |
First, you need to gather the payment details. Here are the details you'll need:
...
amount: The amount to charge the customer.
currency Code: A three-letter ISO code for the currency in which you want to accept the payment. A unique code that represents a defined business currency. E.g NGN=Nigerian Naira, USD =United state Dollars etc (Required) If you don't specify a value, we'll assume "NGN"
Tax Enabled: Specify if Tax/fees is applicable on the purchase value (true, false)
name: This is the name of the item to be purchased via the payment link
description: This is the description of the item to be purchased
link Type: This specify how often the payment link can be used. (Reusable, One-time)
metadata (optional): An object containing any extra information you'd like to store alongside the transaction e.g {CVV
| Panel |
|---|
|
Response Body Response code : 200 |
...
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 |
|---|
|
Sample Response Payload |
Below shows different sample response scenarios;
| Expand |
|---|
| title | Sample Response (Success) |
|---|
|
|
...
...
...
...
...
...
...
Invoice Test 5",
"description": " |
|
...
...
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": " |
|
...
...
12.00
},
"linkType": "Reuseable",
"amountType": "Dynamic",
"supportEmail": null,
"logo": null,
"status": "New",
"createdDate": " |
|
...
...
...
...
...
50.0680015",
"environment": "Test"
}
],
"pageParams": {
"pageNumber": 1,
"pageSize": 2,
"totalCount": 14
},
"isSuccess": true,
"error": "",
"message": "Request Successful",
" |
|
...
| Expand |
|---|
| title | Sample Response (Sample Response Payload - If no data) |
|---|
|
| Code Block |
|---|
| {
"items": [],
"pageParams": {
"pageNumber": 1,
"pageSize": 10,
|
|
...
"totalCount": 0
},
"isSuccess": |
|
...
...
...
...
...
...
...
...
| Expand |
|---|
| title | Sample Response Error (Bad Request) |
|---|
|
| Code Block |
|---|
| {
"type": "https://httpstatuses.io/400",
"title": "Bad Request",
"status": 400,
"traceId": "00-6c8cde6d25f77646deda7230015a88c0-d2be5f7d289728b2-00"
} |
|
\uD83D\uDCCB Related articles
...