PAYMENT GATEWAY
GET PAY API allows you to initiate a CARD Payment transaction by making calls from your server which returns a URL that when visited will call up our payment Modal, where Customers can enter their ATM card details for payment.
Please be informed that GET PAY will not be held liable for transactions done on your website with Stolen ATM Cards.
GET PAY Payment Gateway API Integration
This section contains your RESTful API for GET PAY Payment Gateway API integration. It enables Merchants to receive payment from their their customers using their ATM Card for payments.
AUTHENTICATION
The GET PAY API uses APIKey for Authentication for Bank Transer.
Please use your Testkey for Testing on sandbox, after a successful integration, then change to Your APIKEY for authentication
GET PAY ENVIRONMENTS
The GET PAY API Endpoint has the Sandbox environment and the Production Environment as seen Below:SANDBOX: https://sandbox.getpaysolutions.com/api/v1/
PRODUCTION: https://getpaysolutions.com/api/v1/
Initiate Card Payment
You Can Transfer Money from GET PAY with the endpoint below:Base URL: https://sandbox.getpaysolutions.com/api/v1/payment
Body Parameters: as specified in the parameters below:
Step One: You'll initiate the payment by calling our API with the collected payment details shown below.Step Two: After step one, You will get a response containing a paymeny Link which your customers need to visit to complete the transaction.
Step Three: Now all you need to do is redirect your customer to the link returned in paymentLink value of the response, and we'll display our checkout modal for them to complete the payment.
| PARAMETERS | Required/Optional | TYPE | DESCRIPTION |
| apikey | R | String | Your Business APIkey Created at getpaysolutions.com. Use Your Testkey on sandbox |
| firstName | R | String | The First Name of The customer making the payment. |
| lastName | R | String | The Last Name (Surname) of The customer making the payment. |
| customerEmail | R | String | The Email Address of The customer making the payment. |
| phone | R | Number | The Phone number of The customer making the payment. |
| amount | R | Number | The Amount of Money the customer is paying. |
| referenceID | R | String | This is a unique reference with which you can use to query and verify the status of the Transaction. Please do not used Hyphen (-) in your reference. |
| currency | O | String | This is the currency of the Amount. We only accept NGN and USD at the moment. If not provided, NGN will be the default curreny to be charged. |
| redirect_url | O | String | This is the URL of the page in your website where the the transaction will be directed to after payment, whether sucessful or not. We only accept NGN and USD at the moment. If not provided, your webhook URL will be notified. |
SAMPLE CODE
$host="https://sandbox.getpaysolutions.com/api/v1/payment/?apikey=1234532fgf&&firstName=GET&lastName=PAY&customerEmail=get@gmail.com&customerPhone=08012345678&referenceID=Unique111&redirect_url=yourwebsite.com/verify.php"; //Initialize cURL. $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $host); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); echo $data = curl_exec($ch); //Close the cURL handle. curl_close($ch); $result = json_decode($data);
EXPECTED RESPONSE
"responseCode" => $code, "paymentLink" =>$checkout_url, "service" =>$memo, "amount"=>$amount, "currency"=>$currencyCode, "customerEmail"=>$customerEmail, "customerPhone"=>$customerPhone, "referenceID"=>$referenceID, "businessID"=>$bizID, "dateTime"=>$dateTime, "message"=>$mgs );
{"data":{
"responseCode":"200",
"paymentLink":"link to visit to complete the payment",
"service":"CARD Payment",
"amount":"1000",
"currency":"NGN",
"customerEmail":"get@gmail.com",
"customerPhone":"08012345678",
"referenceID":"unique111",
"businessID":"1233",
"dateTime":"2023-11-16 08:43 PM",
"message":"Proceed With your Payment"},
"eventData":{"action":""}
}