...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
| Panel | ||
|---|---|---|
| ||
GBP Bank Account Integration Process |
Currently, on the Leatherback Platform, This payment method is only supported by in GBP Currency. The process below can be followed to integrate the GBP Bank Account ;
Step 1: Call Validate Payment Endpoint
| Panel | ||
|---|---|---|
| ||
Title: Validate Payment |
| Panel | ||
|---|---|---|
| ||
Description: This endpoint gives the available payment channel available for a given currency |
| Panel | ||
|---|---|---|
| ||
URL: |
| Panel | ||
|---|---|---|
| ||
HTTP Method: POST | ||
| Panel | ||
| ||
Headers : authorization Set value to Bearer
|
First, you need to gather and Pass on the details below.
| Panel | ||
|---|---|---|
| ||
Request Body |
| Code Block | ||
|---|---|---|
| ||
{
"amount": {
"currencyCode": "GBP",
"amount": 5000
},
"channels": [
"string"
]
} |
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, GBP =Great Britain Pounds
| Panel | ||
|---|---|---|
| ||
Response Body Response code: 200 |
| Code Block | ||
|---|---|---|
| ||
{
"value": {
"isValid": true,
"channels": [
{
"id": "2d60ca92-8f2f-486a-aa21-35cc9434898f",
"name": "Card",
"alias": "Card",
"description": null
},
{
"id": "a470390f-4d10-4a9b-922b-8fd960b4b595",
"name": "PayByAccount",
"alias": "PayByAccount",
"description": null
}
]
},
"isSuccess": true,
"error": "",
"message": "Request Successful",
"type": null,
"title": null,
"status": null,
"detail": null,
"instance": null
} |
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
From Response above the available Payment channels for GBP Currency { “Card” , “PayByAccount”) |
...
Step 2: Call Initiate Payment Endpoint
| Panel | ||
|---|---|---|
| ||
Title: Initiate Payment |
| Panel | ||
|---|---|---|
| ||
Description: This endpoint is used to initiate a payment transaction irrespective of the channel |
| Panel | ||
|---|---|---|
| ||
Title: Initiate Payment URL: |
| Panel | |||||
|---|---|---|---|---|---|
| Description : This endpoint is used to initiate a payment transaction irrespective of the channel
| ||||
HTTP Method: POST |
First, you need to gather the transaction and Customer details as shown below:
| Note |
|---|
NB: Link Alias is passed when you are processing a Payment link transaction |
| Panel |
|---|
...
First, you need to gather the transaction and Customer details as shown below:
| Note |
|---|
NB: Link Alias is passed when you are processing a Payment link transaction |
| Panel | ||
|---|---|---|
| ||
Request Body |
| Code Block | ||
|---|---|---|
| ||
| ||
URL: api /payment/pay/Initiate |
| Panel | ||
|---|---|---|
| ||
HTTP Method : POST |
...
| bgColor | #79E2F2 |
|---|
Headers : authorization Set value to Bearer SECRET_KEY
| |
Request Body |
| Code Block | ||
|---|---|---|
| ||
{ "currencyCode": "GBP", "amount": 1, "channel": "PayByAccount", "currency": "GBP", "link": { "alias": "0-k2tmbuy" }, "channeluserInformation": "PayByAccount", { "currencyfirstName": "GBPDave", "linklastName": {"MC", "aliasemailAddress": "0-k2tmbuy"mcdave@test.com", }, "userInformationphone": {"070000000" } "firstName"“metaData”: "Dave",{ "lastName": "MC",“return-url”: “https://access.leatherback.co” "emailAddress": "mcdave@test.com", "phone": "070000000" } } }, } |
| Info |
|---|
If you don’t want the redirect, the page will close automatically. To utilize this option, the authURL response from the initiate, Change the redirect params to false before loading the URL. |
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: ["Card", "PaybyAccount" ]. In this case, you will pass PaybyAccount PayByAccount as Channel ValueamountAmount: The amount to charge the customer for the transaction (Required)currency CodeCurrencyCode: 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, GBP =Great Britain Pounds etc(Required)narration:This is usually a description of items being purchased by a customer, etc. (Required)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 (This is only Mandatory when initiating a Payment Link transaction)firstName:This is the first Name of the Customer (Required)lastName:This is the Last Name of the Customer (Required)phone:This is the phone number of the Customer (Required)emailAddress: This is the email address of the customer (Required)
| Panel | ||
|---|---|---|
| ||
Sample Response Body Response code : 200 |
| Code Block | ||
|---|---|---|
| ||
{
"value": {
"paymentStatus": "REQUIRE_BANK_AUTH",
"message": "Payment initiated successfully. Kindly click on the link to complete your payment",
"paymentItem": {
"channel": "PayByAccount",
"message": "Payment initiated successfully. Kindly click on the link to complete your payment",
"amount": 1,
"fees": 0,
"reference": "TZ2ZFLPMU39GDPG",
"paymentReference": "TZ2ZFLPMU39GDPG",
"metaData": {
"AuthUrl": "https://cdnpay.plaidleatherback.com/link/v2/stable/link.html?isWebview=false&token=link-development-39c7f73c-0b44-43b9-b3e3-d2cae8e1dc45co/open-banking?link_token=link-sandbox-d0f8470d-adfc-4015-922e-5a2fc1e671f8&client_url=https://access.leatherback.co&lb_reference=LZRD9QKSQ3MTIXCSPG&redirect=true
"
}
}
},
"isSuccess": true
} |
...
Step 3: Call GET Transaction Status
| Panel | ||
|---|---|---|
| ||
Title: Get Transaction Status Endpoint |
| Panel | ||
|---|---|---|
| ||
Description: This endpoint is used to get transaction status. |
| Panel | ||
|---|---|---|
| ||
URL: api : |
| Panel | ||
|---|---|---|
| ||
HTTP Method: GET | ||
| Panel | ||
| ||
Headers : authorization Set value to Bearer
|
Pass the Payment Reference: "TVI1HLDDNATWSPG" from the response gotten from the Initiate Payment End point above
| Panel | ||
|---|---|---|
| ||
Sample Response Body Response code : 200 |
| Code Block | ||
|---|---|---|
| ||
{
"value": {
"paymentReference": "TVI1HLDDNATWSPGTUBJRGMSDFT9DPG",
"amount": {
"currencyCode": "NGNGBP",
"amount": 100.005000
},
"paymentStatus": “SUCCESSFUL” 0| “FAILED” | “PENDING”
},
"isSuccess": true,
"error": "",
"message": "",
"type": null,
"title": null,
"status": null,
"detail": null,
"instance": null
}
|
\uD83D\uDCCB Related articles
...