GET PAYGETPAYsolutions.com

  • MAIN NAVIGATION
  • Introduction
  • Discounts & Prices
  • Wallet Balance Check
  • Reserved Account Numbers
  • Virtual Account Numbers
  • Bank Transfer
    • Account Name Enquiry
    • Send Money
    • Bank List & Codes
  • Payment Gateway
  • Transactions
    • Transaction Verification
    • Webhook Notification
    • Callback URL
  • Error/Response Codes
  • Back To Home Page

Download Mobile APP
  • Home Services Prices
  • My Account

    • Login
    • Register



RESERVED ACCOUNTS

GET PAY Reserved Account Number API allows you to create, assign or reserve Unique Bank account numbers to your users for automated wallet funding in your website.

Reserved accounts can be seen as another payment channel for your business since customers can now pay to the account number assigned to them and their wallet will be funded automatically.
Whenever money is sent to the dedicated Reserved account number, you will get notified via your Webhook URL and an instant credit into your GET PAY Account.

GET PAY Reserved Account API Integration

This section contains your RESTful API for GET PAY Reserved Accounts API integration. It enables Merchants to create and reserve bank account numbers for receiving payments on GET PAY.

 

AUTHENTICATION

The GET PAY API uses APIKey for Authentication for Reserved Accounts Creating.

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/


Creating Reserved Accounts

You Can Create GET PAY Reserved Accounts with the endpoint below:


Base URL: https://sandbox.getpaysolutions.com/api/v1/reserved-accounts

Body Parameters: as specified in the parameters below:

 

PARAMETERS Required/Optional TYPE DESCRIPTION
apikey R String Your Business APIkey Created at getpaysolutions.com.
Use Your Testkey on sandbox
accountReference R String This is a unique reference with which you can use to identify Your Customers.
firstName R String The First Name of The customer You are creating the Reserved Account Number for.
lastName R String The Last Name (Surname) of The customer You are creating the Reserved Account Number for.
customerEmail R String The Email Address of The customer You are creating the Reserved Account Number for.
customerPhone R Number The Phone number of The customer You are creating the Reserved Account Number for.
bvn O Number The BVN number of The customer You are creating the Reserved Account Number for. If not provided, your BVN as a merchant will be used.
bankCode O Number The Bank Code of the Specific Bank Aaccount number you preffer to open for your customers. The Available Partner Banks on GET PAY can be seen below.
currency O String This is the currency of the Account. We only accept NGN at the moment.
For this integration, "R" Means "required" and you must supply it while "O" means "Optional". You may wish to supply it or Not.

 

SAMPLE CODE



$host="https://sandbox.getpaysolutions.com/api/v1/reserved-accounts/?apikey=1234532fgf&firstName=GET&lastName=PAY&customerEmail=get@gmail.com&customerPhone=08012345678&accountReference=Unique111";



//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


{"data":{
	"Authencation":"6030c",
	"responseCode":"200",
	"status":"Completed",
	"service":"Account Number Reservation",
	"firstName":"Get",
	"lastName":"Pay",
	"customerEmail":"get@gmail",
	"customerPhone":"08012345678",
	"accountReference":"unique111",
	"businessID":"21555",
	"businessName":"GET PAY",
	"currency":"NGN",
	"AccountType":"static",
	"bankCode":"023",
	"bankName":"Providus Bank",
	 "accountNumber":"1234444",
	 "accountName":"GET PAY Solutions(Funding)"
	"dateTime":"2023-11-16 08:43 PM",
	"message":"Reserve Account Created Successfully"
	 
	},
	
	"accounts":
	       {"bankCode":"",
	        "bankName":"",
	        "accountNumber":"",
	         "accountName":""},
			}

 


AVAILABLE PARTNER BANKS

 

BANK CODE BANK NAME STATUS
286 Safe Haven Micro Finance Bank Active
013 GTBANK PLC Active
023 Providus Bank Active



OTHER SERVICES


SPONSORED ADS



Copyright © 2023 - GET PAY SOLUTIONS LIMITED. All Rights Reserved.