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

Title: Get all Payment link

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

URL: api /payment/payment-link/

HTTP Method : GET

 

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

 

 

Response Body

Response code : 200

{
    "value": {
        "id": "d574c37c-cf55-46a5-9556-08db1c659f7d",
        "name": "REDMI",
        "description": "JJ",
        "alias": "0-mjlyfib",
        "link": "https://app-aaaspaymentlink-dev.azurewebsites.net/0-mjlyfib",
        "amountInfo": {
            "currencyCode": "NGN",
            "amount": 5000
        },
        "linkType": "Reuseable",
        "status": "New",
        "createdDate": "2023-03-04T04:04:59.6635547+00:00",
        "environment": "Test"
    },
    "isSuccess": true,
    "error": "",
    "message": "Request Successful",
    "type": null,
    "title": null,
    "status": null,
    "detail": null,
    "instance": null
}

 

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