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 2 Next »

Title: Get unique Payment link

Description : This service may be used to get a unique payment link

URL: api /payment/payment-link/{id}

HTTP Method : GET

 

First, you pass the unique id associated to a payment link. 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

 

 

Response Body

Response code : 200

{
  "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-04T20:39:20.627Z",
    "environment": "string"
  },
  "additionalProp1": "string",
  "additionalProp2": "string",
  "additionalProp3": "string"
}

 

Highlight important information in a panel like this one. To edit this panel's color or style, select one of the options in the menu.

  • No labels