Page Comparison

Below shows how the Payment link flow Integration works:

• From your server, call our create Create Payment link, Validate Payment link, Initiate the payment link endpoint with the payment details.

• We'll return a link alias to a payment page. Redirect your customer to this link to make the payment.

• When the transaction is completed, we'll redirect the customer back to you.

Step 1: Call Create Payment Link Endpoint

...

Here are the details you'll need:

{
  "name": "Invoice Test 5",
  "description": "Test",
  "linkType": 1,
  "amountType": 1,
  "currencyCode": "GBP",
  "amountInfo": {
    "currencyCode": "GBP",
    "amount": 12
  }
}

"linkType": 0 - oneTime, 1 - reusable
"amountType": 0 - Static, 1 - Dynamic

{
  "value": {
    "id": "4e376b57-cbcb-4c69-8258-08dc7ef7dffe",
    "name": "Invoice Test 5",
    "description": "Test",
    "alias": "0-hvhmxp0",
    "link": "https://pay.leatherback.co/0-hvhmxp0",
    "amountInfo": {
      "currencyCode": "GBP",
      "amount": 12
    },
    "linkType": "Reuseable",
    "amountType": "Dynamic",
    "supportEmail": null,
    "logo": null,
    "status": "New",
    "createdDate": "2024-06-05T22:07:21.0548519+00:00",
    "environment": "Test"
  },
  "isSuccess": true,
  "error": "",
  "message": "Request Successful",
  "type": null,
  "title": null,
  "status": null,
  "detail": null,
  "instance": null
}

Step 2: Call Validate Payment Endpoint

Here are the details you'll need:

amountInfo{
  "amount": {
    "currencyCode": "GBP",
    "amount": 2
  },
  "channels": [
    "Card",
    "PayByTransfer",
    "PayByAccount"
  ]
}

{
  "value": {
    "isValid": true,
    "channels": [
      {
        "id": "9a69343e-c18d-4aeb-a0a2-0995b44596dc",
        "name": "Card",
        "alias": "Card",
        "description": null
      },
      {
        "id": "6bdaf37f-9518-44d6-aa79-fafb382aa5c7",
        "name": "PayByAccount",
        "alias": "PayByAccount",
        "description": null
      }
    ]
  },
  "isSuccess": true,
  "error": "",
  "message": "Request Successful",
  "type": null,
  "title": null,
  "status": null,
  "detail": null,
  "instance": null
} 

Step 3: Call Initiate Payment Endpoint

Here are the details you'll need:

{
  "channel": "PayByTransfer",
  "amount": 500,
  "currency": "NGN",
  "narration": "SHOE",
  "reference": "4f737265-27cb-40fd-84a6-f41d999a39d1",
  "link": {
    "alias": "0-mjlyfib"
  },
  "

...

userInformation": {
    "

...

firstName": "Ayobami",
    "lastName": "Queen",
    "phone": "08132681675",
    "emailAddress": 

...

"ayobamsy@yahoo.com"
  },
  "

...

paymentRequestProps": {
    "additionalProp1": "string",
    "

...

additionalProp2": "string",
    "

...

additionalProp3": 

...

"string"
  },
  "

...

metaData": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

• Channel: An array of payment channels to control what channels you want to make available to the user to make a payment with. Available channels include: "pay by card", "PayByTransfer", "pay with account"

• 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 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 narration: This is usually a description of items being purchased by a customer

• reference: This is an Id that uniquely identifies a channel type (this is derived from the Validate Payment endpoint response)

• alias: An alias allows users to access a page (node) or file at an alternative path. A redirect is moving a user to the correct file or page (node) because it no longer exists at a previous path. Alias lets you choose a nickname for your page, meaning a new URL that points to the content the same way the original URL does

• firstName: This is the first Name of the Customer

• lastName: This is the Last Name of the Customer

• phone: This is the phone number of the Customer

• emailAddress: This is the email address of the customer

• metadata (optional): An object containing any extra information you'd like to store alongside the transaction e.g {CVV

{
  "value": {
    "paymentStatus": "REQUIRE_USER_OFFLINE_ACTION",
    "message": "Payment Initiated",
    "bankAuthURL": null,
    "paymentItem": {
      "channel": "PayByTransfer",
      "message": "Payment Initiated",
      "amount": 500,
      "fees": 0,
      "currencyCodereference": "NGN4f737265-27cb-40fd-84a6-f41d999a39d1",
      "amountmetaData": {
500     },   "taxtransfer-info": {
    "isEnabled      "note": true"NILL",
           }"bank": "Providus",
  "name        "account_number": "Redmi9979314914",
          "descriptionaccount_name": "Redmi 11proMERCHANT(jkkffg)",
  "linkType        "expiration": 0,"2023-03-04T13:43:11.0447022Z",
          "metadatamode": {
  "banktransfer"
        }
      }
    }
  },
  "isSuccess": true,
  "additionalProp1error": "string",
  "message": "",
  "additionalProp2type": null,
  "stringtitle": null,
  "status": null,
  "additionalProp3detail": null,
  "stringinstance":   }
}'

null
}

Step 4: Call Authenticate Payment Endpoint

Here are the details you'll need:

{
  "referenceId": "4f737265-27cb-40fd-84a6-f41d999a39d1"
}

• reference:This is an Id that uniquely identifies a channel type (this is derived from the Validate Payment endpoint response)

...

...

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "

...

isSuccess": 

...

true,
  "error": "string",
  "message": "string",
  "

...

responseCode": "

...

string",
  "value": {
    "

...

status": "

...

string",
    "IsAuthenticationEnabled": true,
    "

...

Recommendation": "

...

string",
    "message": "string",
    "

...

authenticationhtml": "

...

string"
  },
  "additionalProp1": "string",
  "additionalProp2": "string",
  "

...

additionalProp3": "string"
}

Step 5: Call Finalize Payment Endpoint

...

Here are the details you'll need:

{
  "paymentReference": "string"
}

• paymentreference:This is an Id that uniquely identifies a payment made

{
  "type": "string",
  "title": "string",
  "status": 0,
  "amountInfodetail": {"string",
  "instance": "string",
  "isSuccess": true,
  "error": "string",
  "currencyCodemessage": "NGNstring",
  "responseCode": "string",
  "value": {
    "amountstatus": 5000"string",
    "message": "string"
  },
  "additionalProp1": "string",
    "linkTypeadditionalProp2": "Reuseablestring",
  "addi
}

Step 6: Call Transaction Reference Endpoint

Here are the details you'll need:

{
  "value": {
    "

...

paymentReference": "

...

836",
    "amount": {
      "

...

currencyCode": "

...

GBP",
      "amount": 1
 

...

   },
    "paymentStatus": "

...

SUCCESSFUL | FAILED | PENDING"
  },
  

...

"isSuccess": true,

...

...

"error": "",
  

...

"message": "

...

",
  

...

"type": null,

...

...

"title": null,
  

...

"status": null,

...

  "detail": null,

...

  "instance": null
}

...

Error

...

Cause

...

Solution

...

The {input field} is required

...

A mandatory field is empty

...

Ensure all mandatory fields and values are present.

...

payment link with given reference_id: notes already exists. Please create a payment link with a different reference_id

...

An existing reference id has been passed

...

Ensure that a unique reference id is used for all payment links.

\uD83D\uDCCB Related articles