Step 1: Get Payment link Information by Alias
...
| Panel | ||
|---|---|---|
| ||
Description : This service endpoint may be used to get a unique payment link by passing an Alias |
| Panel | ||
|---|---|---|
| ||
URL: api /payment/payment-link/by-alias/{alias} |
| Panel | ||
|---|---|---|
| ||
HTTP Method : GET |
First, you pass the alias associated to a payment link. Here are the details you'll need:
| Code Block |
|---|
Alias |
...
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)
...
:
...
| Panel | ||
|---|---|---|
| ||
Response Body Response code : 200 |
| Code Block |
|---|
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"isSuccess": true,
"error": "string",
"message": "string",
"responseCode": "string",
"value": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"alias": "string",
"link": "string",
"amountInfo": {
"currencyCode": "string",
"amount": 0
},
"linkType": "string",
"status": "string",
"createdDate": "2023-03-04T21:03:06.094Z",
"environment": "string"
},
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
} |
...
\uD83D\uDCCB Related articles
| Filter by label (Content by label) | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|