Blog

Parkway

Parkway RAILs

Get demo

Contact Us

API Service URL

You are Welcome to the official Parkway Rails Documentation

Welcome

Technical Documentation for the Parkway RAILs API

Introduction

General Flow

Benefit of Parkway Rails

🆕 Changelog

This endpoint is called to get a bearer token to authenticate all API calls

Retrieve Bearer Token

Check Base Wallet Balance

Transfer money from Base Wallet to Bank Account

Transfer To Bank Account

This endpoint is called to get the statement of the partners 'Base' Wallet/Account

Base Wallet Statement

This method is called to create customer wallet with an account which would be activated with OTP

Create Customer Wallet

This endpoint is utilized immediately after creating the customer wallet which is inactive with the otp sent to the customer via sms to activate the wallet.

Activate Customer Wallet

This endpoint is utilized immediately for deactivating customer wallet

Deactivate Customer Wallet

If for any reason Customer did not recieve OTP through SMS to activate Wallet within five(5) minutes. This endpoint can be used trigger a new OTP SMS

Resend OTP to activate Customers Wallet

This endpoint is utilized to add multiple account to a customer wallet created with customer unique phone number which returns a sub wallet account number.

Add Account to Wallet

This endpoint is utilized to update Customer Wallet owner details with BVN.

Update Customer Wallet Owner with BVN

This endpoint is used with the unique customer wallet account number generated for each customer to retrieve ledger and available balance.

Get Wallet Balance

This endpoint is utilized to fund customer unique account number created.

Fund Wallet

Fund Wallet Transaction Status Check

This endpoint is utilized to charge or debit customer wallet for funds.

Charge and Debit  Customber Wallet

This endpoint is utilized to check the status of a debit and charge request on a customer wallet

Charge Status Check

This endpoint is utilized to perform Customer wallet to wallet transfer. 


Wallet to Wallet Transfer

 This endpoint allows the retrieval of the status of a wallet-to-wallet transfer transaction between two accounts associated with a provider. It enables the verification of the current status of a  specific transfer transaction using the transaction reference provided.  

Status Check for Wallet to Wallet Transfers

This endpoint is used to verify a Bank Account Number using the CBN bank code.

Bank Account Name Enquiry

This endpoint is utilized to debit and initiate customer wallet transfer to a verified bank account using the account name enquiry endpoint.

Wallet Transfer to Bank Account

This endpoint is utilized to get a transaction statement and retrieve a list of transaction on a wallet

Transaction Statement / Transaction List (⚠ deprecated)

Transaction Statement

This endpoint is utilized to search wallets you have created (Including the owner information of the wallet). it comes with filters to streamline your search

Search/Filter Created Wallet

This endpoint is utilized to find wallet using fields(mobile, email, firstName, lastName) or a combination of them

Find wallets

This endpoints provides the sum total balance of all Customer wallets balance.

Wallets Pool Balances

Integration Modalities for Callback/Inbound Bank Transfer Transaction Callback

This endpoint is to enable customer card to be linked to the customer Wallet account per partner institutions

Parkway RAILs API

Service Endpoints

Response Codes

API Service URL