When sending requests to the developer API, make sure you provide the secret key with the header, \"x-api-key\" so that we know the requests are from you.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"37634476","collectionId":"a5000206-60fd-4342-8762-9e0d45117b48","publishedId":"2sAYBd88Fu","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-12-09T15:08:41.000Z"},"item":[{"name":"Payment","item":[{"name":"Get Fee","id":"6b0a6ccb-816b-45af-bb94-30ee1e8a0cf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{vault:x-api-key}}","type":"text"}],"url":"{{base_url}}/api/v2/payment/fee?paymentMethod=payment-link&amount=1000","description":"payment-link
\nvirtual-account
\n🚨 IMPORTANT 🚨: The reference provided in the request payload is returned as collectionAccount.reference in the webhook payload.
Fixed
\nUnderPayment
\nOverPayment
\nvalidityInMinutes -> integer
\nname -> string
\ndescription -> string
\ntemporary
\npermanent
\n🚨 IMPORTANT 🚨: The reference provided in the request payload is returned as collectionAccount.reference in the webhook payload.
Fixed
\nUnderPayment
\nOverPayment
\nvalidityInMinutes -> integer
\ntype -> string
\ntemporary
\npermanent
\nBefore calling this endpoint, make sure you have called the Get Fee endpoint to check the fee for the transaction.
\nSettled Balance v Balance
\nWhen you recieve money via virtual account or payment link, we do not settle the money into your account immediately, but after 24hrs, therefore, the amount you can transfer out is settledBalance, but the total money you have in your wallet is the balance.
\n","urlObject":{"path":["api","v2","wallet"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"4c1a97ac-c43c-4a8a-9684-1dad4d4cb14e","name":"200 Success Response","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"OPSECK_WN0bbL6N1hYz-4f4d98b7-d83b-4367-b71a-fb3c6f56c55c","type":"text"}],"url":"{{base_url}}/api/v2/wallet"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"384"},{"key":"ETag","value":"W/\"180-kEJXOGqqs5JLkrzHzzEHDICeWW0\""},{"key":"Date","value":"Thu, 30 Jan 2025 12:18:19 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Wallet retrieved successfully\",\n \"data\": {\n \"id\": \"8b3deecf-1111-4108-a1ab-4ca07096b125\",\n \"createdAt\": \"2025-01-07T19:16:32.160Z\",\n \"updatedAt\": \"2025-01-30T12:15:44.753Z\",\n \"deletedAt\": null,\n \"businessId\": null,\n \"userId\": \"e1268626-9575-4905-b9e4-2d31642673b5\",\n \"tier\": \"one\",\n \"currency\": \"ngn\",\n \"balance\": 0,\n \"settledBalance\": 0,\n \"lastWithdrawal\": 0,\n \"lastDeposit\": 0\n },\n \"state\": \"success\",\n \"status\": 200\n}"}],"_postman_id":"b0c2dac1-d579-4aad-8bca-5a6d929354a5"},{"name":"Get Bank Account Details","id":"832f12f4-c174-46a2-b2a0-84d1e261d87e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{vault:x-api-key}}","type":"text"}],"url":"{{base_url}}/api/v2/wallet/bank-account-details?accountNumber=0550171581&accountBankCode=000013","urlObject":{"path":["api","v2","wallet","bank-account-details"],"host":["{{base_url}}"],"query":[{"key":"accountNumber","value":"0550171581"},{"key":"accountBankCode","value":"000013"}],"variable":[]}},"response":[{"id":"243f9cd9-ca25-4d08-8ef9-bd73ca0f9aea","name":"200 Success Response","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"accountNumber\": \"1100033670\",\n \"accountBankCode\": \"120001\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v2/wallet/bank-account-details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"115"},{"key":"ETag","value":"W/\"73-95AXqxdyLcT50qHqo7GNjU+2x2g\""},{"key":"Date","value":"Wed, 23 Oct 2024 11:13:01 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Successfully retrieved bank account details\",\n \"data\": {\n \"name\": \"DOE JOHN\"\n },\n \"state\": \"success\",\n \"status\": 200\n}"}],"_postman_id":"832f12f4-c174-46a2-b2a0-84d1e261d87e"},{"name":"Transfer To Bank","id":"81868f66-29d7-481f-aa63-0f24d8d29358","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{vault:x-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountNumber\": \"0550171581\",\n \"bankCode\": \"000013\",\n \"amount\": 100,\n \"reference\": \"1234567\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v2/wallet/transfer-to-bank","description":"successful
\nfailed
\nreversed
\npending
\npayment-received
\nairtime-purchased
\ntransfer-completed
\nsuccessful
\nfailed
\nreversed
\npending
\npayment-received
\nairtime-purchased
\ntransfer-completed
\nWhen sending you webhooks, we use the webhook token that you provide us as a secret to create a SHA512 hash of the payload and send the hash to you in the header \"x-onionpay-signature\", you can use this signature to ensure that the webhook is coming from us.
\nWebhooks will continue to be resent if you do not respond with a status 200 response code, so make sure that upon receiving the webhook, you respond with a status 200.
\n","_postman_id":"f5548767-b63c-465d-b6c5-74392047db94","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"a5000206-60fd-4342-8762-9e0d45117b48","id":"a5000206-60fd-4342-8762-9e0d45117b48","name":"Onion Pay Developers API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"6e9ff398-80ee-453c-8860-c7329076b033","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"a54d792d-6d2d-408b-9b41-4ba59fbd3f85","type":"text/javascript","packages":{},"exec":[""]}}]}