{"info":{"_postman_id":"b464cb1b-26ea-4d9d-9022-d658f5d550d6","name":"PaymentBridge","description":"

This end point is created to allow merchants using the PaymentBridge virtual payment service to be able to generate virtual account numbers as well as fetch payment history for any of the generated account numbers

\n

Sandbox URL: https://paymentbridge.ng/api/sandbox

\n

Live URL: https://paymentbridge.ng/api/live

\n

Authentication

\n

Authenticate every calls by passing your PaymentBridge Merchant ID and your API Key that can be found on your PaymentBridge dashboard

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"12310405","collectionId":"b464cb1b-26ea-4d9d-9022-d658f5d550d6","publishedId":"2s9YC7TByJ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-09-17T22:42:01.000Z"},"item":[{"name":"create_virtual_account","id":"7a3713fd-e0b8-411b-b7e7-7cd8974f68b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"mid","value":"Merchant_ID","type":"text"},{"key":"key","value":"API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"account_name\":\"John Doe\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://paymentbridge.ng/api/sandbox/create_virtual_account","description":"

This endpoint allows you to create a virtual account

\n

Expected response:

\n
{\n\"status\": \"success\",\n\"message\": \"Operation successful\",\n\"data\": {\n\"bank\": \"PROVIDUS BANK\",\n\"account_name\": \"John Doe\",\n\"account_number\": \"9977881418\"\n}\n}\n
\n","urlObject":{"path":["create_virtual_account"],"host":["https://paymentbridge.ng/api/sandbox"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a3713fd-e0b8-411b-b7e7-7cd8974f68b8"},{"name":"create_disposable_account","id":"541e9adc-17be-45fd-ba8f-04e43b3abbda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"mid","value":"Merchant_ID","type":"text"},{"key":"key","value":"API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"account_name\":\"John Doe\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://paymentbridge.ng/api/sandbox/create_disposable_account","description":"

This endpoint allows you to create a disposable virtual account

\n

Disposable virtual accounts can only accept one time payments.

\n

A disposable virtual account expires 30 minutes after creating them if they do not recieve payments, likewise they expire immediately after receiving one time payment

\n

Expected response:

\n
{  \n \"status\": \"success\",  \n \"message\": \"Operation successful\",  \n \"data\": {  \n   \"bank\": \"PROVIDUS BANK\",  \n   \"account_name\": \"John Doe\",  \n   \"account_number\": \"9977881418\",\n   \"expires\":\"2023-12-01 23:30:00\"  \n }  \n}   \n\n
\n","urlObject":{"path":["create_disposable_account"],"host":["https://paymentbridge.ng/api/sandbox"],"query":[],"variable":[]}},"response":[],"_postman_id":"541e9adc-17be-45fd-ba8f-04e43b3abbda"},{"name":"get_accounts","id":"ad5c9a62-f85a-4d4b-b633-178f6e04b84b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"mid","value":"Merchant_ID","type":"text"},{"key":"key","value":"API_KEY","type":"text"}],"url":"https://paymentbridge.ng/api/sandbox/get_accounts","description":"

This endpoint allows you to fetch all virtual accounts you have created

\n

Expected response:

\n
{\n\"status\": \"success\",\n\"message\": \"Operation successful\",\n\"data\": [\n{\n\"bank\": \"PROVIDUS BANK\",\n\"account_name\": \"John Doe\",\n\"account_number\": \"9977842266\",\n\"date_created\": \"Sep 17, 2023, 01:23:56\"\n},\n{\n\"bank\": \"PROVIDUS BANK\",\n\"account_name\": \"John Mark\",\n\"account_number\": \"9977842266\",\n\"date_created\": \"Sep 17, 2023, 01:23:56\"\n}\n]\n}\n\n\n
\n","urlObject":{"path":["get_accounts"],"host":["https://paymentbridge.ng/api/sandbox"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad5c9a62-f85a-4d4b-b633-178f6e04b84b"},{"name":"payment_history","id":"ee5f8070-5149-44c2-a3df-1fc0e02381e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"mid","value":"Merchant_ID","type":"text"},{"key":"key","value":"API_KEY","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"account_number\":\"9988776655\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://paymentbridge.ng/api/sandbox/payment_history","description":"

This endpoint allows you to fetch all payments made by an account number

\n

Expected response:

\n
{\n\"status\": \"success\",\n\"message\": \"Operation successful\",\n\"data\": [\n{\n\"trx_id\": \"PABG-TRX-0001\",\n\"trx_type\": \"Deposit\",\n\"trx_date\": \"Sep 17, 2023, 22:36:40\",\n\"amount\": 1000,\n\"status\": \"Successful\",\n\"details\": {\n\"sessionId\": \"1234567890\",\n\"accountNumber\": \"9977599412\",\n\"tranRemarks\": \"FROM UBA/ CASAFINA CREDIT-EASY LOAN-NIP/SEYI OLUFEMI/CASAFI\",\n\"transactionAmount\": \"1000\",\n\"feeAmount\": \"0\",\n\"vatAmount\": \"0\",\n\"currency\": \"NGN\",\n\"initiationTranRef\": \"\",\n\"settlementId\": \"987654321\",\n\"sourceAccountNumber\": \"2093566866\",\n\"sourceAccountName\": \"CASAFINA CREDIT-EASY LOAN\",\n\"sourceBankName\": \"UNITED BANK FOR AFRICA\",\n\"channelId\": \"1\",\n\"tranDateTime\": \"2021-03-01 18:06:20.000\"\n}\n}\n}\n]\n}\n
\n","urlObject":{"path":["payment_history"],"host":["https://paymentbridge.ng/api/sandbox"],"query":[],"variable":[]}},"response":[],"_postman_id":"ee5f8070-5149-44c2-a3df-1fc0e02381e7"}],"event":[{"listen":"prerequest","script":{"id":"3f21e5ac-0824-4b89-a8cf-a556e83e4c48","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"90ca4c94-05b6-4a7c-851f-34229945e823","type":"text/javascript","exec":[""]}}],"variable":[{"key":"sandbox_url","value":"https://paymentbridge.ng/api/sandbox","type":"string"},{"key":"live_url","value":"https://paymentbridge.ng/api/live","type":"string"},{"key":"mid","value":"Merchant_ID","type":"string"},{"key":"key","value":"API_KEY","type":"string"}]}