Skip to content

hitchpay.io Get API keys

Getting Started

Overview

Authentication

Generate Access Token
Refresh Access Token

Wallet

Get Wallet Balance

Customer Enrollment & KYC

Enroll Customer
Get Customer
List Customers
Update Customer
Delete Customer
Submit KYC
Retrieve KYC State
Errors

VIRTUAL ACCOUNTS

Overview
Generate Bank Account
Get Customer Accounts
Get Account Collections
Get Collection by Reference

CARDS

Overview
Issue Card
List Cards
Get Card
Get Card Secure Details
Fund Card
Withdraw from Card
Freeze Card
Unfreeze Card
Terminate Card
Get Card Transactions
Errors

DYNAMIC PAYMENTS

Create Dynamic Account
Retrieve Dynamic Payment

Checkout Payments

Initiate Payment
Verify Payment
List Payments
Inline Checkout SDK

PAYOUT

NGN Payout

BILLS PAYMENT

Overview
Get Billers
Verify Customer Biller
Data/Internet
- Get Data Plans
- Buy Databundle
Cable TV
- Get Cable Plans
- Pay Cable TV
Buy Airtime
Pay Electricity
Get Transaction Status
Errors

GLOBAL PAYMENT (CROSS-BORDER)

Overview
Supported Countries
Supported Channels
Supported Networks
Get Exchange Rate
Initiate Global Transfer
Get Transfer Status
Initiate Global Collections
List Transactions

Identity

Nigeria
- Overview
- Verify BVN
- Verify NIN
- Errors

Webhooks

Overview & Signature Verification
Payment Success Event
Payment Failed Event
Customer Profile Update
KYC Status Update
Transfer Status Update
Global Payment Status Update
Bill Payment Status Update
Bank Account Status Update
Bank Collection Status Update
Card Issuance Status Update
Card Transaction Update
Card Funding Status Update
Card Status Change Update

Simulator

Overview
Activate Account
Simulate Transfer
Simulate NG Identity

BILLS PAYMENT

Data/Internet

Purchase a data bundle for a phone number, using a package_id from Get Data Plans.

PreviousVerify Customer Biller NextGet Data Plans

Questions? Email developers@hitchpay.ng. Also on GitBook.