Introduction
API endpoint
https://api.bleyt.com/v1
Welcome to Bleyt Wallet! Our goal is to give access to financial opportunity anywhere in emerging markets. Great products don’t make you think.
To get started, you need to create a merchant account here.
Our API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Getting Started
Glide API uses API keys to authenticate requests. You can view and manage your API keys once you get registered.
Test mode secret keys have the prefix sk-test- and live mode secret keys have the prefix sk-live-.
You need to authenticate via bearer auth (e.g., for a cross-origin request), use -H “Authorization: Bearer sk-test-0iqL8YF9RbHPMeNtMAIWxYlaIFWOLvqAzwyQYIR5XbiZ”.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Before you begin, you will need to create an account by getting registered as a merchant.
Merchant type
We have only Platinum merchant
- Platinum merchants that need end-to-end service of Bleyt. We handle both the bank and wallet transactions.
Login
You can login as a merchant.
curl --location --request POST 'https://api.bleyt.com/v1/merchant/login' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "[email protected]",
"password": "123456"
}'
{
"status": true,
"merchant": {
"id": "3d289bc5-7d8e-4412-b5eb-6df373b09d15",
"firstName": "Demo",
"lastName": "User",
"email": "[email protected]",
"phoneNumber": "09014514808",
"callbackURL": null,
"businessName": "Neyosoft",
"businessType": "FINANCIAL-SERVICES",
"merchantType": "PLATINUM",
"walletReservationCharge": 20,
"bvnVerificationCharge": 40,
"walletToWalletTransfer": 20,
"airtimeCharge": 10,
"transferCharges": {
"max5000": 20,
"max50000": 35,
"min50000": 52
},
"mode": "SANDBOX",
"sandboxCallbackURL": null,
"createdAt": "2020-09-08T00:29:54.801Z",
"updatedAt": "2020-09-08T00:31:07.419Z"
}
}
Request Parameters
Parameter | Description |
---|---|
email Required |
email user registered with. |
password Required |
password user registered with. |
Get Merchant Keys
You can retrieve your keys by making this request.
curl --location --request POST 'https://api.bleyt.com/v1/merchant/my-access-keys' \
--header 'X-Access-Token: B6fFiTjb6s8tf1DOLjxfdjpB1lEs0EDZjDBjyLndAOLtY6Sc' \
--header 'X-Refresh-Token: f9cNFz9E-HI8Y1Q8k3T-J8IYkgYA6AaEEqDYy_tzpnE9C06x' \
--header 'Content-Type: application/json' \
--data-raw '{
"merchantId":"4565bd15-g41b-4a0c-d1c9-78417d126387"
}'
{
"privateKey": "sk-test-1G4yQKzNBEcFBEsBJFILsIYyrM5SQkhWZo85C7hhsC7wUUrS",
"publicKey": "pk-test-2IeIeOpkrN4m61eJPTQZbZYdmp9va15HAgqq9bTeuDfK97dW"
}
Request Parameters
Parameter | Description |
---|---|
merchantId Required |
merchantId can be gotten from login endpoint. |
X-Access-Token Required |
X-Access-Token, this is part of the Header Response from the login endpoint. |
X-Refresh-Token Required |
X-Refresh-Token, this is part of the Header Response from the login endpoint. |
Note Keys are gotten once the account is activated.
Update Profile
To complete to the merchant sign up process, these details should be provided. Your account will need to be verified but you can continue your development with the test keys.
curl --location --request PUT 'https://api.bleyt.com/v1/merchant/complete-merchant-registration' \
--form '[email protected]/Users/kenlizzy/desjtop/pack.pdf' \
--form 'directorsBVN=22212345678' \
--form 'merchantId=7b885802-576a-4ac2-9f3d-9169e98e13a9'
{
"status": true,
"message": "Your Documents have been uploaded and Pending Review"
}
Request Parameters
Parameter | Description |
---|---|
cac_pack Required |
Your CAC pack, not just the certificate. |
directorsBVN Required |
BVN of the director. |
merchantId Required |
Merchant ID from the verify account response . |
Note You need to perform a form upload. Once details are in place, your account will be taken active.
Password Reset Request
Merchant can perform a password reset request, a code will be sent to the registered email for password reset.
curl --location --request POST 'https://api.bleyt.com/v1/merchant/request-merchant-password-change' \
--header 'Content-Type: application/json' \
--data-raw '{
"email":"[email protected]"
}'
{
"message": "Your Reset code has been sent to your email. It expires in 24 hours"
}
Request Parameters
Parameter | Description |
---|---|
email Required |
Email address of the merchant. |
Password Reset
Changing the password is easy, supply the code and the new password.
curl --location --request POST 'https://api.bleyt.com/v1/merchant/change-merchant-password' \
--header 'Content-Type: application/json' \
--data-raw '{
"email":"[email protected]"
}'
{
"message": "Your Reset code has been sent to your email. It expires in 24 hours"
}
Request Parameters
Parameter | Description |
---|---|
email Required |
Email address of the merchant. |
Merchants
Manage the merchant activities from this area and get details and balance of your account.
Get Balance
curl --location --request GET 'https://api.bleyt.com/v1/merchant/wallet' \
--header 'Authorization: Bearer ${{secret}}'
{
"wallet": {
"email": "[email protected]",
"id": "3c6d6308-f144-41cf-aefd-f2e1d9fe3c88",
"lastName": "Lizy",
"firstName": "Ken",
"bankName": "Providus Bank",
"bankCode": "101",
"createdAt": "2020-06-09T04:43:33.060Z",
"updatedAt": "2020-06-09T04:43:33.060Z",
"accountName": " BG-Ken Lizy",
"accountNumber": "4000021706",
"bookedBalance": 0,
"availableBalance": 0,
"accountReference": "7432RbW9KfR194mgfVInb61uuS"
}
}
Fund Merchant Wallet
Fund your merchant wallet, in Production you will need to make a bank transfer to the account number provided.
curl --location --request POST 'https://api.bleyt.com/v1/merchant/fund-wallet' \
--header 'Authorization: Bearer ${{secret}}'
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 4000
}'
{
"status": true,
"message": "Transaction completed successfully"
}
Request arguments
Parameter | Description |
---|---|
amount REQUIRED |
Amount to fund the wallet with |
To fund your account in production, you need to make a transfer to your account number
and your waller will be funded automatically.
Update Merchant Profile
Update merchant profile
curl --location --request PATCH 'https://api.bleyt.com/v1/merchant/profile' \
--header 'Authorization: Bearer {{secret_key}}' \
--raw ' {
"firstName": "Ronke",
"lastName": "Akinlabi",
"email": "[email protected]",
"phoneNumber": "+2347012345678",
"callbackURL": "https://freecallback.merchantendpoint.com",
}
'
{
"status": true,
"message": "Profile successfully updated"
}
Request arguments
Parameter | Description |
---|---|
firstName OPTIONAL |
First name of merchant |
lastName OPTIONAL |
Last name of merchant |
phoneNumber OPTIONAL |
Phone number of the merchant |
callbackURL OPTIONAL |
Callback to hit for responses of account related functions |
Merchant Transactions
curl --location --request GET 'https://api.bleyt.com/v1/merchant/transactions?page=1&type=ALL' \
--header 'Authorization: Bearer {{secret_key}}'
Returns all transactions performed by a merchant.
{
"transactions": [
{
"id": "14705c0e-b0cb-4529-b0f2-c96928c3a5a5",
"category": "WALLET_RESERVATION",
"currency": "NGN",
"amount": 20,
"metadata": {
"firstName": "Jane",
"lastName": "Doe",
"email": "[email protected]",
"phoneNumber": "08032348203",
"dateOfBirth": "1991-09-13",
"currency": "NGN"
},
"balance_after": 1990,
"balance_before": 2010,
"reference": "f3NgweBIT6umVANVXoU6Z8djq",
"source": "Merchant Wallet f4a13185-db3a-4132-b728-d28d7dfa96ee",
"destination": null,
"type": "DEBIT",
"description": "New wallet (9a1a21d3-5b74-4c6a-a003-a086f8638b3b) was created for Jane Doe",
"createdAt": "2020-05-31T13:09:01.072Z",
"updatedAt": "2020-05-31T13:09:01.072Z"
},
{
"id": "a496bd63-0f1c-4f57-99cb-e79342249acf",
"category": "BANK_TRANSFER",
"currency": "NGN",
"amount": 60,
"metadata": {
"accountName": "SHOLA ADE",
"accountNumber": "0067420233",
"bankName": "GTBank Plc",
"bankCode": "000013",
"reference": "000023200531130603005008306436",
"amount": 50,
"currency": "NGN",
"fee_amount": 15,
"fee_currency": "NGN",
"narration": "BLEYT"
},
"balance_after": 2050,
"balance_before": 2110,
"reference": "2430fb20-a337-11ea-8983-bd3feb1ae594",
"source": "Merchant Wallet f4a13185-db3a-4132-b728-d28d7dfa96ee",
"destination": "000013/0067420233",
"type": "DEBIT",
"description": "Transfer completed.",
"createdAt": "2020-05-31T12:06:27.182Z",
"updatedAt": "2020-05-31T12:06:27.182Z"
},
{
"id": "c37a5008-a387-4cd2-81e8-47e55b555461",
"category": "AIRTIME_PURCHASE",
"currency": "NGN",
"amount": 60,
"metadata": {
"status": 201,
"message": "Operation Successful, Recharge created, Reference : 791b8ae0-a32f-11ea-a0d7-010c9003432d",
"reference": "791b8ae0-a32f-11ea-a0d7-010c9003432d",
"code": "RECHARGE_COMPLETE",
"paid_amount": 50,
"paid_currency": "NGN",
"topup_amount": 50,
"topup_currency": "NGN",
"target": "2348032338443",
"product_id": "MFIN-5-OR",
"time": "2020-05-31T11:11:30.179Z",
"country": "Nigeria",
"operator_name": "MTN",
"completed_in": 1249,
"customer_reference": "HyDLXvnwou9bi3VOEDY1UaCPK",
"api_transactionid": "2020053112112947401025197",
"pin_based": false
},
"balance_after": 2170,
"balance_before": 2230,
"reference": "ISBWXbSUUa5CTQWpveGPcrISe",
"source": null,
"destination": "Phone number: 08032338443",
"type": "DEBIT",
"description": "50 Airtime was transfered to 08032338443",
"createdAt": "2020-05-31T11:11:30.579Z",
"updatedAt": "2020-05-31T11:11:30.579Z"
}
],
"metadata": {
"page": 1,
"totalRecords": 9,
"totalPages": 1
}
}
URL Request arguments
Parameter | Description |
---|---|
page OPTIONAL |
Handle pagination of customer records. |
type OPTIONAL |
Type of transactions to be retrieved. ALL, DEBIT CREDIT. |
Customers
Customers are the individual profiles very similar to wallet.
Get All Customers
Get all customers or wallet created under your account.
curl --location --request GET 'https://api.bleyt.com/v1/customer?page=1' \
--header 'Authorization: Bearer ${{secret}}'
{
"customers": [
{
"id": "99b4348e-18d3-4b04-9636-9e9a8c220397",
"firstName": "Joe",
"lastName": "Shalay",
"email": "[email protected]",
"phoneNumber": "08012345678",
"dateOfBirth": "1987-07-15",
"createdAt": "2020-06-09T13:09:56.056Z",
"updatedAt": "2020-06-09T13:09:56.056Z"
}
],
"metadata": {
"page": 1,
"totalRecords": 1,
"totalPages": 1
}
}
Get A Customer
Get a single customer or wallet created under your account.
curl --location --request GET 'https://api.bleyt.com/v1/wallet/customer?customerId=dbbd8544-02d7-4079-1844-c519cbb0652c' \
--header 'Authorization: Bearer ${{secret}}'
{
"wallet": {
"email": "[email protected]",
"id": "dbbd8544-02d7-4079-1844-c519cbb0652c",
"lastName": " ",
"firstName": "Shalaye Limited",
"status": "ACTIVE",
"bankName": "Providus Bank",
"bankCode": "101",
"createdAt": "2020-08-18T14:27:29.846Z",
"updatedAt": "2020-08-18T14:27:29.846Z",
"accountName": "BG-Shalaye Limited",
"accountNumber": "2000000413",
"bookedBalance": 0,
"availableBalance": 0,
"accountReference": "cXmhnjO6snKbHatjlcp7Pb2mr"
}
}
Request arguments
Parameter | Description |
---|---|
customerId Required |
Id of the customer to get details. |
Update Customer Profile
Update customer profile, change the initial customer details
curl --location --request PUT 'https://api.bleyt.com/v1/customer/99b4348e-18d3-4b04-9636-9e9a8c220397' \
--header 'Authorization: Bearer {{secret_key}}'
{
"status": true,
"customer": {
"firstName": "Lizzy",
"lastName": "Ken",
"email": "[email protected]",
"phoneNumber": "08012345678",
"dateOfBirth": "1995-09-13"
}
}
Request arguments
Parameter | Description |
---|---|
customerId Required |
Id of the customer to update. |
firstName Required |
First name of customer |
lastName Required |
Last name of customer |
phoneNumber Required |
Phone number of the customer |
metadata Optional |
Key value pair can be passed with custom data |
Wallets
Wallet to hold all your customers funds or perfom other activities.
List Wallets
curl --location --request GET 'https://api.bleyt.com/v1/wallet' \
--header 'Authorization: Bearer {{secret_key}}'
Get all wallets created under a merchant account.
{
"wallets": [
{
"email": "[email protected]",
"id": "dfde3802-6ac5-40ee-908f-ffde159b4c9a",
"lastName": "Shalay",
"firstName": "Joe",
"bankName": "Providus Bank",
"bankCode": "101",
"createdAt": "2020-06-09T13:09:57.325Z",
"updatedAt": "2020-06-09T13:09:57.325Z",
"accountName": "BG-Ken-Joe Shalay",
"accountNumber": "2000014180",
"bookedBalance": 0,
"availableBalance": 0,
"accountReference": "KB1mjdcAYXM9irHkYTcr0uFLo"
}
]
}
Create Wallet
curl --location --request POST 'https://api.bleyt.com/v1/wallet' \
--header 'Authorization: Bearer ${{secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"firstName": "Joe",
"lastName": "Shalay",
"email": "[email protected]",
"phoneNumber": "08012345678",
"dateOfBirth": "1987-07-15",
"bvn": "22241907542"
}'
{
"status": true,
"customer": {
"fullName": "Joe Shalay",
"id": "99b4348e-18d3-4b04-9636-9e9a8c220397",
"email": "[email protected]",
"firstName": "Joe",
"lastName": "Shalay",
"currency": "NGN",
"phoneNumber": "08012345678",
"dateOfBirth": "1987-07-15",
"BvnId": "c8082cf5-a4b9-4612-977d-f261e6f69447",
"MerchantId": "bc264a05-da66-4fed-a19b-506455d800aa",
"updatedAt": "2020-06-09T13:09:56.056Z",
"createdAt": "2020-06-09T13:09:56.056Z"
},
"wallet": {
"id": "dfde3802-6ac5-40ee-908f-ffde159b4c9a",
"email": "[email protected]",
"currency": "NGN",
"walletable": "Customers",
"walletableId": "99b4348e-18d3-4b04-9636-9e9a8c220397",
"bankName": "Providus Bank",
"bankCode": "101",
"accountName": "BG-Ken-Joe Shalay",
"accountNumber": "2000014180",
"accountReference": "KB1mjdcAYXM9irHkYTcr0uFLo",
"reservationReference": "32TH5J7AVARBKZ42YZXV",
"updatedAt": "2020-06-09T13:09:57.325Z",
"createdAt": "2020-06-09T13:09:57.325Z",
"bookedBalance": 0,
"availableBalance": 0,
"transactionPin": null
}
}
Request arguments
Parameter | Description |
---|---|
firstName Required |
Firstname of the customer. |
lastName Required |
Lastname of the customer. |
email Optional |
email of the customer. |
phoneNumber Required |
phone number of the customer. |
dateOfBirth Required |
date of birth of the customer, we need this to perform KYC on customer. |
bvn Optional |
BVN of the customer, we need this to perform KYC on customer. |
Set Transaction PIN
curl --location --request PUT 'https://api.bleyt.com/v1/wallet/transaction-pin' \
--header 'Authorization: Bearer {{secret_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"customerId": "d16b7593-61f1-4fcd-8a23-6fc014e2331a",
"pin": "1234"
}'
{
"status": true,
"message": "Wallet transaction PIN successfully set."
}
Request arguments
Parameter | Description |
---|---|
customerId Required |
Id of the customer to set the PIN for. |
pin Required |
PIN for customer transactions. |
Credit Wallet
curl --location --request POST 'https://api.bleyt.com/v1/wallet/credit' \
--header 'Authorization: Bearer {{secret_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 700,
"reference": "tkhgnfjdn562jjs",
"customerId": "99b4348e-18d3-4b04-9636-9e9a8c220397"
}'
Merchant can credit a customer wallet using this endpoint.
{
"status": true,
"message": "Customer wallet successfully credited!"
}
Request arguments
Parameter | Description |
---|---|
reference OPTIONAL |
Supply a unique transaction reference. |
amount Required |
The amount to credit, unit in Naira. |
customerId Required |
Customer Id to be credited. |
Debit Wallet
curl --location --request POST 'https://api.bleyt.com/v1/wallet/debit' \
--header 'Authorization: Bearer {{secret_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 400,
"reference": "tkhgnfjdn562tripe",
"customerId": "99b4348e-18d3-4b04-9636-9e9a8c220397"
}'
Merchant can debit a customer wallet using this endpoint.
{
"status": true,
"message": "Customer wallet successfully debited!"
}
Request arguments
Parameter | Description |
---|---|
reference OPTIONAL |
Supply a unique transaction reference. |
amount Required |
The amount to debit, unit in Naira. |
customerId Required |
Customer Id to be debited. |
Customer Transactions
curl --location --request GET 'https://api.bleyt.com/v1/wallet/transactions?customerId=95b4348e-18d3-4b04-9636-9e9a8c220397&page=1&type=ALL' \
--header 'Authorization: Bearer {{secret_key}}'
Returns all transactions performed by a customer.
{
"transactions": [
{
"id": "eb2b73aa-f042-409a-963c-b34955ebfc9e",
"userId": "99b4348e-18d3-4b04-9636-9e9a8c220397",
"category": "WALLET_DEBITED_BY_MERCHANT",
"currency": "NGN",
"amount": 270,
"metadata": null,
"balance_after": 3230,
"balance_before": 3500,
"reference": "agoOiMCU5fApZjjwTjd0D6zcR",
"source": "Merchant Account",
"destination": null,
"type": "DEBIT",
"description": "Account was debited by Merchant",
"createdAt": "2020-06-10T08:51:02.277Z",
"updatedAt": "2020-06-10T08:51:02.277Z"
},
{
"id": "d349ffb8-cc68-4cac-97ed-71f43ef46043",
"userId": "99b4348e-18d3-4b04-9636-9e9a8c220397",
"category": "WALLET_CREDITED_BY_MERCHANT",
"currency": "NGN",
"amount": 700,
"metadata": null,
"balance_after": 3500,
"balance_before": 2800,
"reference": "B9K23BmYWdXBbAnhx064xK29V",
"source": "From Merchant wallet 049a4c9c-9294-4b9b-82bc-f3f7a428bd49",
"destination": null,
"type": "CREDIT",
"description": "700 Fund transfered to your wallet from the Merchant wallet",
"createdAt": "2020-06-10T08:09:51.665Z",
"updatedAt": "2020-06-10T08:09:51.665Z"
},
{
"id": "ab3e243e-1980-4938-80c2-8fc6959192fe",
"userId": "99b4348e-18d3-4b04-9636-9e9a8c220397",
"category": "WALLET_CREDITED_BY_MERCHANT",
"currency": "NGN",
"amount": 700,
"metadata": null,
"balance_after": 2800,
"balance_before": 2100,
"reference": "TRtaFNAXbqLQk0uAzAOHK7m16",
"source": "From Merchant wallet 049a4c9c-9294-4b9b-82bc-f3f7a428bd49",
"destination": null,
"type": "CREDIT",
"description": "700 Fund transfered to your wallet from the Merchant wallet",
"createdAt": "2020-06-10T08:09:49.748Z",
"updatedAt": "2020-06-10T08:09:49.748Z"
},
{
"id": "281eb27e-6842-4aeb-bfca-c177b90677a7",
"userId": "99b4348e-18d3-4b04-9636-9e9a8c220397",
"category": "WALLET_CREDITED_BY_MERCHANT",
"currency": "NGN",
"amount": 700,
"metadata": null,
"balance_after": 2100,
"balance_before": 1400,
"reference": "yEbog2U3Z2gbsE0SIca817ens",
"source": "From Merchant wallet 049a4c9c-9294-4b9b-82bc-f3f7a428bd49",
"destination": null,
"type": "CREDIT",
"description": "700 Fund transfered to your wallet from the Merchant wallet",
"createdAt": "2020-06-10T08:09:46.633Z",
"updatedAt": "2020-06-10T08:09:46.633Z"
},
{
"id": "b07ced76-741f-4762-960e-69c26ffb4bcf",
"userId": "99b4348e-18d3-4b04-9636-9e9a8c220397",
"category": "WALLET_CREDITED_BY_MERCHANT",
"currency": "NGN",
"amount": 700,
"metadata": null,
"balance_after": 1400,
"balance_before": 700,
"reference": "ekUU896ltYuhI5np5eIuuES64",
"source": "From Merchant wallet 049a4c9c-9294-4b9b-82bc-f3f7a428bd49",
"destination": null,
"type": "CREDIT",
"description": "700 Fund transfered to your wallet from the Merchant wallet",
"createdAt": "2020-06-09T18:27:55.792Z",
"updatedAt": "2020-06-09T18:27:55.792Z"
},
{
"id": "f70ce2f7-178d-42df-8027-a76ce8d6de75",
"userId": "99b4348e-18d3-4b04-9636-9e9a8c220397",
"category": "WALLET_CREDITED_BY_MERCHANT",
"currency": "NGN",
"amount": 700,
"metadata": null,
"balance_after": 700,
"balance_before": 0,
"reference": "bn5wpgs99VuC0GFDODXBUn3kh",
"source": "From Merchant wallet 049a4c9c-9294-4b9b-82bc-f3f7a428bd49",
"destination": null,
"type": "CREDIT",
"description": "700 Fund transfered to your wallet from the Merchant wallet",
"createdAt": "2020-06-09T14:48:47.568Z",
"updatedAt": "2020-06-09T14:48:47.568Z"
}
],
"metadata": {
"page": 1,
"totalRecords": 6,
"totalPages": 1
}
}
URL Request arguments
Parameter | Description |
---|---|
customerId Required |
Customer Id - for a specific customer. |
page OPTIONAL |
Handle pagination of customer records. |
type OPTIONAL |
Type of transactions to be retrieved. ALL, DEBIT CREDIT. |
Transfers
Make seemless transfers from wallet to wallet or to any bank account in Nigeria
Wallet to wallet
Move funds between wallets.
curl --location --request POST 'https://api.bleyt.com/v1/transfer/wallet' \
--header 'Authorization: Bearer {{secret_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 500,
"fromCustomerId": "8d2b99e0-6f72-46bf-8615-47415894bd1e",
"toCustomerId": "e132292b-f858-4052-ad87-b20eec9fcbbd"
}'
Merchant can credit a customer wallet using this endpoint.
{
"status": true,
"message": "Transfer completed successfully"
}
Request arguments
Parameter | Description |
---|---|
fromCustomerId Required |
Provide the source customer id. |
toCustomerId Required |
Provide destination customer id to be credited. |
amount Required |
The amount to debit and credit, unit in Naira. |
Batch Wallet to wallet
Move funds from the merchant wallet to multiple customer wallets with a single call.
curl --location --request POST 'https://api.bleyt.com/v1/wallet/batch-credit-customer-wallet' \
--header 'Authorization: Bearer {{secret_key}}' \
--header 'Content-Type: application/json' \
--data-raw '[
{
"amount": 2000,
"customerId": "1149d065-c5c9-4382-aec6-323090f31d9d"
},
{
"amount": 500,
"customerId": "c938a018-8987-4411-97c5-e456868741e8"
}
]'
Merchant can credit multiple customer wallets using this endpoint.
{
"status": true,
"data": {
"accepted": [
{
"amount": 2000,
"customerId": "1149d065-c5c9-4382-aec6-323090f31d9d"
}
],
"rejected": [
{
"amount": 500,
"customerId": "c938a018-8987-4411-97c5-e456868741e8"
}
]
},
"message": "Transaction completed successfully"
}
Request arguments
Parameter | Description |
---|---|
customerId Required |
Provide the customer id to be credited. |
amount Required |
The amount to debit and credit, unit in Naira. |
Batch Customer Wallet to wallets
Move funds from a customer wallet to multiple customer wallets with a single call.
curl --location --request POST 'https://api.bleyt.com/v1/wallet/customer-batch-credit-customer-wallet' \
--header 'Authorization: Bearer {{secret_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"customerId": "1149d065-c5c9-4382-aec6-323090f31d9d",
"recipients": [
{
"amount": 200,
"customerId": "ce43795c-f90f-40cf-b46e-1e1c49abf110"
},
{
"amount": 500,
"customerId": "c938a018-8987-4411-97c5-e456868741e8"
}
]
}'
Merchant can credit multiple customer wallets using this endpoint.
{
"status": true,
"data": {
"accepted": [
{
"amount": 2000,
"customerId": "1149d065-c5c9-4382-aec6-323090f31d9d"
}
],
"rejected": [
{
"amount": 500,
"customerId": "c938a018-8987-4411-97c5-e456868741e8"
}
]
},
"message": "Transaction completed successfully"
}
Request arguments
Parameter | Description |
---|---|
customerId Required |
Provide the customer id to be debited - the sender. |
customerId Required |
Provide the customer ids to be credited under the recipients array - the Recipients. |
amount Required |
The amount to debit and credit, unit in Naira. |
Resolve Bank Account
curl --location --request GET 'https://api.bleyt.com/v1/transfer/account/details?sortCode=000013&accountNumber=0067121232' \
--header 'Authorization: Bearer {{secret_key}}' \
--header 'Content-Type: application/json' \
Merchant can credit a customer wallet using this endpoint.
{
"account": {
"accountNumber": "0067121232",
"accountName": "STONE ATWINE",
"bankCode": "000013",
"bankName": "GTBank Plc",
"transactionFee": 15,
"transactionCurrency": "NGN",
"destinationCurrency": "NGN"
}
}
Request arguments
Parameter | Description |
---|---|
sortCode Required |
Bank ShortCode. |
accountNumber Required |
Account Number to be resolved. |
Bank Transfer from Merchant
Send money to bank account from the merchant wallet
curl --location --request POST 'https://api.bleyt.com/v1/transfer/bank' \
--header 'Authorization: Bearer {{secret_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 50,
"sortCode": "000013",
"accountNumber": "0067121232"
}'
Merchant can credit a customer wallet using this endpoint.
{
"transfer": {
"status": 201,
"message": "Operation Successful",
"success": true,
"operator_name": "GTBank Plc",
"customer_reference": "btQtozDrYewPYuiS562Dnk4ma",
"custom_details": {
"accountName": "STONE ATWINE",
"accountNumber": "0067121232",
"bankName": "GTBank Plc",
"bankCode": "000013",
"reference": "000023200530020913005008252272",
"amount": 50,
"currency": "NGN",
"fee_amount": 25,
"fee_currency": "NGN",
"narration": "BLEYT"
}
}
}
Request arguments
Parameter | Description |
---|---|
accountNumber Required |
Bank account of the reciever. |
sortCode Required |
Shorcode of the destination bank. |
amount Required |
The amount to transfer, unit in Naira. |
Bank Transfer from Customer Wallet
Move funds from a customer wallet to bank account.
curl --location --request POST 'https://api.bleyt.com/v1/transfer/bank/customer' \
--header 'Authorization: Bearer {{secret_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 5000,
"sortCode": "000021",
"narration": "Free for all now",
"accountNumber": "0167421242",
"accountName": "Stone Atwine",
"customerId": "9fcc865e-883d-4ff9-8a3c-9dc6e67a602e",
"metadata": {
"customer_name": "Shola Musa",
"customer_id": "20",
"customer_email": "[email protected]"
}
}'
{
"status": true,
"message": "Transfer successful",
"transfer": {
"status": 201,
"success": true,
"transactionReference": "akWIvSEXD1bbZ4yj0LmNhq1Ys"
}
}
Request arguments
Parameter | Description |
---|---|
amount Required |
The amount to debit the customer wallet with and transfer to the bank, unit in Naira. |
sortCode Required |
code used to identify the destination bank. This code is on List bank. |
narration Required |
Narration or reason why the transfer is taking place. |
accountNumber Required |
Destination Account number, account number to send the funds to. |
accountName Required |
Destination Account Name to Disburse the funds to. Get this by resolving the name |
customerId Required |
Customer ID - customer’s wallet to be debited. |
metadata Optional |
Custom data to send data which will be saved as part of the transaction |
List of Banks
List of Banks
curl --location --request GET 'https://api.bleyt.com/v1/transfer/banks' \
--header 'Authorization: Bearer {{secret_key}}' \
--header 'Content-Type: application/json' \
{
"banks": [
{
"sortCode": "090133",
"name": " AL-Barakah Microfinance Bank"
},
{
"sortCode": "090270",
"name": "AB MICROFINANCE BANK"
},
{
"sortCode": "090260",
"name": "ABOVE ONLY MICROFINANCE BANK"
},
{
"sortCode": "090197",
"name": "ABU MICROFINANCE BANK"
},
{
"sortCode": "100052",
"name": "ACCESS YELLO & BETA"
},
{
"sortCode": "090268",
"name": "ADEYEMI COLLEGE STAFF MICROFINANCE BANK"
},
{
"sortCode": "090292",
"name": "AFEKHAFE MICROFINANCE BANK"
},
{
"sortCode": "100028",
"name": "AG Mortgage Bank"
},
{
"sortCode": "090259",
"name": "ALEKUN MICROFINANCE BANK"
},
{
"sortCode": "090297",
"name": "ALERT MICROFINANCE BANK"
},
{
"sortCode": "090169",
"name": "ALPHA KAPITAL MICROFINANCE BANK"
},
{
"sortCode": "090116",
"name": "AMML MFB"
},
{
"sortCode": "090282",
"name": "ARISE MICROFINANCE BANK"
},
{
"sortCode": "090001",
"name": "ASOSavings & Loans"
},
{
"sortCode": "090287",
"name": "ASSETMATRIX MICROFINANCE BANK"
},
{
"sortCode": "090172",
"name": "ASTRAPOLARIS MICROFINANCE BANK"
},
{
"sortCode": "090264",
"name": "AUCHI MICROFINANCE BANK"
},
{
"sortCode": "070010",
"name": "Abbey Mortgage Bank"
},
{
"sortCode": "000014",
"name": "Access Bank"
},
{
"sortCode": "000005",
"name": "Access Bank (Diamond)"
},
{
"sortCode": "100013",
"name": "AccessMobile"
},
{
"sortCode": "090134",
"name": "Accion Microfinance Bank"
},
{
"sortCode": "090160",
"name": "Addosser Microfinance Bank"
},
{
"sortCode": "090131",
"name": "Allworkers Microfinance Bank"
},
{
"sortCode": "090143",
"name": "Apeks Microfinance Bank"
},
{
"sortCode": "090188",
"name": "BAINES CREDIT MICROFINANCE BANK"
},
{
"sortCode": "090326",
"name": "BALOGUN GAMBARI MICROFINANCE BANK"
},
{
"sortCode": "090127",
"name": "BC Kash Microfinance Bank"
},
{
"sortCode": "090176",
"name": "BOSAK MICROFINANCE BANK"
},
{
"sortCode": "090308",
"name": "BRIGHTWAY MICROFINANCE BANK"
},
{
"sortCode": "090117",
"name": "Boctrust Microfinance Bank"
},
{
"sortCode": "090148",
"name": "Bowen Microfinance Bank"
},
{
"sortCode": "070015",
"name": "Brent Mortgage Bank"
},
{
"sortCode": "090154",
"name": "CEMCS MICROFINANCE BANK"
},
{
"sortCode": "090144",
"name": "CIT Microfinance Bank"
},
{
"sortCode": "100005",
"name": "Cellulant"
},
{
"sortCode": "090141",
"name": "Chikum Microfinance Bank"
},
{
"sortCode": "000009",
"name": "Citi Bank"
},
{
"sortCode": "090130",
"name": "Consumer Microfinance Bank"
},
{
"sortCode": "100032",
"name": "Contec Global Infotech Limited (NowNow)"
},
{
"sortCode": "060001",
"name": "Coronation Merchant Bank"
},
{
"sortCode": "070006",
"name": "Covenant MFB"
},
{
"sortCode": "090159",
"name": "Credit Afrique Microfinance Bank"
},
{
"sortCode": "090167",
"name": "DAYLIGHT MICROFINANCE BANK"
},
{
"sortCode": "090273",
"name": "EMERALD MICROFINANCE BANK"
},
{
"sortCode": "090166",
"name": "ESO-E MICROFINANCE BANK"
},
{
"sortCode": "100021",
"name": "Eartholeum"
},
{
"sortCode": "100030",
"name": "EcoMobile"
},
{
"sortCode": "000010",
"name": "Ecobank Bank"
},
{
"sortCode": "100008",
"name": "Ecobank Xpress Account"
},
{
"sortCode": "090097",
"name": "Ekondo MFB"
},
{
"sortCode": "090114",
"name": "Empire trust MFB"
},
{
"sortCode": "000019",
"name": "Enterprise Bank"
},
{
"sortCode": "090179",
"name": "FAST MICROFINANCE BANK"
},
{
"sortCode": "060002",
"name": "FBN Merchant Bank"
},
{
"sortCode": "090107",
"name": "FBN Mortgages Limited"
},
{
"sortCode": "100014",
"name": "FBNMobile"
},
{
"sortCode": "100031",
"name": "FCMB Mobile"
},
{
"sortCode": "090290",
"name": "FCT MICROFINANCE BANK"
},
{
"sortCode": "100001",
"name": "FET"
},
{
"sortCode": "090153",
"name": "FFS Microfinance Bank"
},
{
"sortCode": "090285",
"name": "FIRST OPTION MICROFINANCE BANK"
},
{
"sortCode": "400001",
"name": "FSDH Merchant Bank"
},
{
"sortCode": "000007",
"name": "Fidelity Bank"
},
{
"sortCode": "100019",
"name": "Fidelity Mobile"
},
{
"sortCode": "090126",
"name": "Fidfund Microfinance Bank"
},
{
"sortCode": "090111",
"name": "FinaTrust Microfinance Bank"
},
{
"sortCode": "000016",
"name": "First Bank of Nigeria"
},
{
"sortCode": "000003",
"name": "First City Monument Bank"
},
{
"sortCode": "070014",
"name": "First Generation Mortgage Bank"
},
{
"name": "Flutterwave Technology Solutions Limited"
},
{
"sortCode": "070002",
"name": "Fortis Microfinance Bank"
},
{
"sortCode": "100016",
"name": "FortisMobile"
},
{
"sortCode": "090145",
"name": "Fullrange Microfinance Bank"
},
{
"sortCode": "090158",
"name": "Futo Microfinance Bank"
},
{
"sortCode": "000027",
"name": "GLOBUS BANK"
},
{
"sortCode": "090278",
"name": "GLORY MICROFINANCE BANK"
},
{
"sortCode": "090178",
"name": "GREENBANK MICROFINANCE BANK"
},
{
"sortCode": "090195",
"name": "GROOMING MICROFINANCE BANK"
},
{
"sortCode": "000013",
"name": "GTBank Plc"
},
{
"sortCode": "100009",
"name": "GTMobile"
},
{
"sortCode": "070009",
"name": "Gateway Mortgage Bank"
},
{
"sortCode": "090122",
"name": "Gowans Microfinance Bank"
},
{
"sortCode": "070017",
"name": "HAGGAI MORTGAGE BANK LIMITED"
},
{
"sortCode": "090175",
"name": "HIGHSTREET MICROFINANCE BANK"
},
{
"sortCode": "090147",
"name": "Hackman Microfinance Bank"
},
{
"sortCode": "090121",
"name": "Hasal Microfinance Bank"
},
{
"sortCode": "100017",
"name": "Hedonmark"
},
{
"sortCode": "000020",
"name": "Heritage"
},
{
"sortCode": "090118",
"name": "IBILE Microfinance Bank"
},
{
"sortCode": "090324",
"name": "IKENNE MICROFINANCE BANK"
},
{
"sortCode": "090275",
"name": "IKIRE MICROFINANCE BANK"
},
{
"sortCode": "090258",
"name": "IMO STATE MICROFINANCE BANK"
},
{
"sortCode": "090149",
"name": "IRL Microfinance Bank"
},
{
"sortCode": "100024",
"name": "Imperial Homes Mortgage Bank"
},
{
"sortCode": "090157",
"name": "Infinity Microfinance Bank"
},
{
"sortCode": "070016",
"name": "Infinity Trust Mortgage Bank"
},
{
"sortCode": "100029",
"name": "Innovectives Kesh"
},
{
"sortCode": "100027",
"name": "Intellifin"
},
{
"sortCode": "000006",
"name": "JAIZ Bank"
},
{
"sortCode": "090003",
"name": "JubileeLife Microfinance Bank"
},
{
"sortCode": "100015",
"name": "Kegow"
},
{
"sortCode": "000002",
"name": "Keystone Bank"
},
{
"sortCode": "090177",
"name": "LAPO MICROFINANCE BANK"
},
{
"sortCode": "090271",
"name": "LAVENDER MICROFINANCE BANK"
},
{
"sortCode": "070012",
"name": "Lagos Building Investment Company"
},
{
"sortCode": "090171",
"name": "MAINSTREET MICROFINANCE BANK"
},
{
"sortCode": "070019",
"name": "MAYFRESH MORTGAGE BANK"
},
{
"sortCode": "090280",
"name": "MEGAPRAISE MICROFINANCE BANK"
},
{
"sortCode": "090113",
"name": "MICROVIS MICROFINANCE BANK"
},
{
"sortCode": "090281",
"name": "MINT-FINEX MICROFINANCE BANK"
},
{
"sortCode": "090136",
"name": "Microcred Microfinance Bank"
},
{
"sortCode": "100011",
"name": "Mkudi"
},
{
"sortCode": "090129",
"name": "Money Trust Microfinance Bank"
},
{
"sortCode": "100020",
"name": "MoneyBox"
},
{
"sortCode": "090151",
"name": "Mutual Trust Microfinance Bank"
},
{
"sortCode": "090205",
"name": "NEW DAWN MICROFINANCE BANK"
},
{
"sortCode": "090263",
"name": "NIGERIAN NAVY MICROFINANCE BANK"
},
{
"sortCode": "999999",
"name": "NIP Virtual Bank"
},
{
"sortCode": "090194",
"name": "NIRSAL NATIONAL MICROFINANCE BANK"
},
{
"sortCode": "090283",
"name": "NNEW WOMEN MICROFINANCE BANK"
},
{
"sortCode": "060003",
"name": "NOVA MERCHANT BANK"
},
{
"sortCode": "070001",
"name": "NPF MicroFinance Bank"
},
{
"sortCode": "090128",
"name": "Ndiorah Microfinance Bank"
},
{
"sortCode": "090108",
"name": "New Prudential Bank"
},
{
"sortCode": "090272",
"name": "OLABISI ONABANJO UNIVERSITY MICROFINANCE"
},
{
"sortCode": "090295",
"name": "OMIYE MICROFINANCE BANK"
},
{
"sortCode": "090119",
"name": "Ohafia Microfinance Bank"
},
{
"sortCode": "090161",
"name": "Okpoga Microfinance Bank"
},
{
"sortCode": "070007",
"name": "Omoluabi savings and loans"
},
{
"sortCode": "100026",
"name": "One Finance"
},
{
"sortCode": "100033",
"name": "PALMPAY"
},
{
"sortCode": "090317",
"name": "PATRICKGOLD MICROFINANCE BANK"
},
{
"sortCode": "090196",
"name": "PENNYWISE MICROFINANCE BANK"
},
{
"sortCode": "090289",
"name": "PILLAR MICROFINANCE BANK"
},
{
"sortCode": "090296",
"name": "POLYUNWANA MICROFINANCE BANK"
},
{
"sortCode": "090274",
"name": "PRESTIGE MICROFINANCE BANK"
},
{
"sortCode": "090303",
"name": "PURPLEMONEY MICROFINANCE BANK"
},
{
"sortCode": "100002",
"name": "Paga"
},
{
"sortCode": "070008",
"name": "Page Microfinance Bank"
},
{
"sortCode": "100003",
"name": "Parkway-ReadyCash"
},
{
"sortCode": "090004",
"name": "Parralex Microfinance bank"
},
{
"sortCode": "110001",
"name": "PayAttitude Online"
},
{
"sortCode": "100004",
"name": "Paycom"
},
{
"sortCode": "090137",
"name": "PecanTrust Microfinance Bank"
},
{
"sortCode": "090135",
"name": "Personal Trust Microfinance Bank"
},
{
"sortCode": "070013",
"name": "Platinum Mortgage Bank"
},
{
"sortCode": "000023",
"name": "Providus Bank "
},
{
"sortCode": "090261",
"name": "QUICKFUND MICROFINANCE BANK"
},
{
"sortCode": "090198",
"name": "RENMONEY MICROFINANCE BANK"
},
{
"sortCode": "090322",
"name": "REPHIDIM MICROFINANCE BANK"
},
{
"sortCode": "000024",
"name": "Rand Merchant Bank"
},
{
"sortCode": "070011",
"name": "Refuge Mortgage Bank"
},
{
"sortCode": "090125",
"name": "Regent Microfinance Bank"
},
{
"sortCode": "090132",
"name": "Richway Microfinance Bank"
},
{
"sortCode": "090138",
"name": "Royal Exchange Microfinance Bank"
},
{
"sortCode": "090286",
"name": "SAFE HAVEN MICROFINANCE BANK"
},
{
"sortCode": "090325",
"name": "SPARKLE"
},
{
"sortCode": "090262",
"name": "STELLAS MICROFINANCE BANK"
},
{
"sortCode": "090305",
"name": "SULSPAP MICROFINANCE BANK"
},
{
"sortCode": "090006",
"name": "SafeTrust "
},
{
"sortCode": "090140",
"name": "Sagamu Microfinance Bank"
},
{
"sortCode": "090112",
"name": "Seed Capital Microfinance Bank"
},
{
"sortCode": "000008",
"name": "Skye Bank"
},
{
"sortCode": "000012",
"name": "StanbicIBTC Bank"
},
{
"sortCode": "100007",
"name": "StanbicMobileMoney"
},
{
"sortCode": "000021",
"name": "StandardChartered"
},
{
"sortCode": "000001",
"name": "Sterling Bank"
},
{
"sortCode": "100022",
"name": "Sterling Mobile"
},
{
"sortCode": "000022",
"name": "Suntrust Bank"
},
{
"sortCode": "000026",
"name": "TAJ BANK"
},
{
"sortCode": "090115",
"name": "TCF MFB"
},
{
"sortCode": "000025",
"name": "TITAN TRUST BANK"
},
{
"sortCode": "090327",
"name": "TRUST MICROFINANCE BANK"
},
{
"sortCode": "090276",
"name": "TRUSTFUND MICROFINANCE BANK"
},
{
"sortCode": "100023",
"name": "TagPay"
},
{
"sortCode": "100010",
"name": "TeasyMobile"
},
{
"sortCode": "090146",
"name": "Trident Microfinance Bank"
},
{
"name": "Trustbond Mortgage Bank"
},
{
"sortCode": "090251",
"name": "UNIVERSITY OF NIGERIA, NSUKKA MICROFINANCE BANK"
},
{
"sortCode": "000018",
"name": "Union Bank"
},
{
"sortCode": "000004",
"name": "United Bank for Africa"
},
{
"sortCode": "000011",
"name": "Unity Bank"
},
{
"sortCode": "090110",
"name": "VFD MFB"
},
{
"sortCode": "100012",
"name": "VTNetworks"
},
{
"sortCode": "090123",
"name": "Verite Microfinance Bank"
},
{
"sortCode": "090150",
"name": "Virtue Microfinance Bank"
},
{
"sortCode": "090139",
"name": "Visa Microfinance Bank"
},
{
"sortCode": "000017",
"name": "Wema Bank"
},
{
"sortCode": "090120",
"name": "Wetland Microfinance Bank"
},
{
"sortCode": "090124",
"name": "Xslnce Microfinance Bank"
},
{
"sortCode": "090142",
"name": "Yes Microfinance Bank"
},
{
"sortCode": "000015",
"name": "Zenith Bank Plc"
},
{
"sortCode": "100018",
"name": "ZenithMobile"
},
{
"sortCode": "100025",
"name": "Zinternet Nigera Limited"
},
{
"sortCode": "090156",
"name": "e-Barcs Microfinance Bank"
},
{
"sortCode": "100006",
"name": "eTranzact"
}
]
}
Physical Cards
You can issue physical cards using this endpoint. The customer will be created and linked to a card.
Issue Card
Create a card for a wallet holder.
curl --location --request POST 'https://api.bleyt.com/v1/card' \
--header 'Authorization: Bearer {{secret_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"address1": "10 Sonola Street, Osogbo",
"address2": "20 Sonola Street, Osogbo",
"customerId": "c938a018-8987-4411-97c5-e456868741e8"
}'
Merchant can credit a customer wallet using this endpoint.
{
"status": true,
"message": "Card created successfully."
}
Request arguments
Parameter | Description |
---|---|
CustomerId Required |
Provide the customer Id. |
address 1 Required |
Address 1 of the customer. |
address 2 Required |
Address 2 of the customer - you can supply address 1 if the customer has only 1 address. |
Activate Card
Move funds from the merchant wallet to multiple customer wallets with a single call.
curl --location --request POST 'https://api.bleyt.com/v1/card/activate' \
--header 'Authorization: Bearer {{secret_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"last6": "000352",
"customerId": "c938a018-8987-4411-97c5-e456868741e8"
}'
{
"status": true,
"message": "Card activated successfully."
}
Request arguments
Parameter | Description |
---|---|
last6 Required |
Provide the last 6 digits of the card to be activated. |
customerId Required |
Customer Id of the cardholder. |
Card Balance
Balance on Card
curl --location --request GET 'https://api.bleyt.com/v1/card/balance?last6=000352' \
--header 'Authorization: Bearer {{secret_key}}' \
--header 'Content-Type: application/json' \
{
"status": true,
"data": {
"id": "b2c1552e-f8e0-4e58-8a1a-d62ddde08133",
"ledgerBalance": "120000",
"availableBalance": "6723",
"goodsLimit": "1400000",
"goodsNrTransLimit": "5",
"cashLimit": "0",
"cashNrTransLimit": "0",
"paymentLimit": "1400000",
"paymentNrTransLimit": "5",
"cardNotPresentLimit": "1400000",
"depositCreditLimit": "1000000",
"updatedAt": "2020-10-19T15:25:13.501Z",
"createdAt": "2020-10-19T15:25:13.501Z",
"deletedAt": null
}
}
Request arguments
Parameter | Description |
---|---|
last6 Required |
Provide the last 6 digits of the card to be activated. |
Fund Card
curl --location --request POST 'https://api.bleyt.com/v1/card/fund' \
--header 'Authorization: Bearer {{secret_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"amount": 50,
"last6": "000352",
"customerId": "c938a018-8987-4411-97c5-e456868741e8"
}'
{
"status": true,
"message": "Card funded successfully."
}
Request arguments
Parameter | Description |
---|---|
last6 Required |
Provide the last 6 digits of the card to be activated. |
customerId Required |
Customer Id of the cardholder. |
amount Required |
Amount to load on card. |
Webhooks
Webhooks allows glide application to receive real-time, push notification of events from the bank.
You need to insert this endpoint on the bank dashboard.
We need this to process your customer transfers.
When a transaction is processed successfully on Bleyt, a webhook notification is sent to the webhook URL configured on the merchant’s dashboard. merchant when a transaction has been processed successfully.
You should respond to an event with a 200 OK. We consider this an acknowledgement by your application. If your application responds with any status outside of the 200, we will consider it unacknowledged and continue to send it every hour for 72 hours. You don’t need to send a request body or some other parameter as we do not need it, we only pay attention to the status code you respond with.
Events
=> Create Wallet or Customer
{
"event": "customer_account_created",
"data": {
"customer": {
"bvn": "45678912345",
"dateOfBirth": "1990-03-02",
"phoneNumber": "08051829345",
"currency": "NGN",
"email": "[email protected]",
"lastName": "Aje",
"firstName": "Door",
"BVNLastName": "Aje",
"BVNFirstName": "Door",
"nameMatch": true
},
"wallet": {
"id": "f914fbd1-9bf6-477b-b2a8-41b2951c11fe",
"currency": "NGN",
"bankName": "Providus Bank",
"bankCode": "000023",
"accountName": "BS-Door Aje",
"accountNumber": "4470201429",
"accountReference": "E1XCRR3rQR7cKcVM2IKJ3PIRu"
}
}
}
=> Credit Customer
{
"event": "customer_wallet_credited",
"data": {
"amount": 1000,
"reference": "16215280339874",
"customerId": "2ce7ff5d-6136-46ba-8fd7-43666f3e50d9",
"customer_wallet_id": "60ad4371-ff5e-470e-bea7-18b370b09fdf"
}
}
=> Debit Customer
{
"event": "customer_wallet_debited",
"data": {
"amount": 100,
"reference": "1621528564914",
"customerId": "19de65aa-e704-3fe6-8646-b9111dfb1007",
"customer_wallet_id": "63fdfc4b-f2be-4660-b6c2-cfd884a6ebaf"
}
}
=> Bank Transfer
{
"event": "bank_transfer",
"data": {
"amount": 1000,
"reference": "9yHetfsKJQIdZjwF9Y5oUSBFdyFpmDNDi8ts",
"fee": 12.5,
"destination": "0400554498/000013",
"description": "Transfer of NGN 1000 to Door Peen (0400554498/GTBANK PLC)"
}
}
Errors
Glide API uses conventional HTTP response codes to indicate errors, and includes more detailed information on the exact nature of an error in the HTTP response.
HTTP response codes
Response code | Meaning |
---|---|
200 OK |
All is well. |
400 Bad Request |
Your request has missing arguments or is malformed. |
401 Unauthorized |
Your request is not authenticated. |
403 Forbidden |
Your request is authenticated but has insufficient permissions. |
405 Method Not Allowed |
You are using an incorrect HTTP verb. Double check whether it should be POST /GET /DELETE /etc. |
404 Page Not Found |
The endpoint requested does not exist. |
406 Not Acceptable |
Your application does not accept the content format returned according to the Accept headers sent in the request. |
429 Too Many Requests |
Your application is exceeding its rate limit. Back off, buddy. :p |
500 Internal Server Error |
Something is wrong on our end. Whoopsie. |
504 Gateway Timeout |
Something has timed out on our end. Whoopsie. |
Authentication errors
Errors pertaining to authentication are standard errors.