{"info":{"_postman_id":"ff461be5-5dfe-4044-86e7-94e4efbc0e30","name":"Access Power","description":"

A sandbox documentation for developers to integrate directly

Variables

secreteKey: Your secret key value can be gotten from your dashboard->settings on API keys tab. Set the value in variables.
\n
apiUrl: There are two values for apiUrl. One for sandbox, the other for production. By default, apiUrl is set to sandbox - https://uat.dashboard.tiqpayment.com. To use production url, set apiUrl value to https://dashboard.tiqpayment.com
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"23414377","collectionId":"ff461be5-5dfe-4044-86e7-94e4efbc0e30","publishedId":"2sA3kYjL65","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-31T16:55:58.000Z"},"item":[{"name":"Transactions","item":[{"name":"Initiate Transaction","event":[{"listen":"test","script":{"id":"d270c00e-2995-4def-965d-399e3806aa55","exec":[""],"type":"text/javascript","packages":{}}}],"id":"31e52b74-057b-4d10-9a5a-719a3ed73772","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"test@accesspower.com\",\r\n \"amount\": 1000,\r\n \"reference\": \"m7asq884412834441ddh\",\r\n \"redirectUrl\": \"https://your-web-uri/checkout/redirect\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://uat.dashboard.tiqpayment.com/api/v1/transaction/initiate","description":"

Initiate Payment

This endpoint is used to initiate a payment and retrieve the payment URL, permit code, reference, and channel reference.

Request Body

email (string, optional): The email of the user initiating the payment.
\n
amount (number, required): The amount of the payment.
\n
reference (string, required): A reference for the payment.
\n
redirectUrl (string, optional): The URL to redirect after payment initiation.
\n

Response

The response returns a JSON object with the following properties:

data (object):
\n
- payment_url (string): The URL for the payment.
  \n
- permit_code (string): The permit code for the payment.
  \n
- reference (string): The reference for the payment.
  \n
- channelReference (string): The channel reference for the payment.
  \n
\n
message (string): A message related to the response.
\n
status (boolean): The status of the response.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzM4NCJ9.eyJzdWIiOiJtaWNoZWFsYWtpbnRvbGExMDZwb2dAZ21haWwuLmNvbSIsImlhdCI6MTcxNjE4ODM1MywiZXhwIjoxNzMxNzQwMzUzfQ.ubkxihRb5qvFVIYY_SOvx_5YGIJ8CU_6VzT1Dfcx6slMEmK9_XSf-_Fou7-84YDk"}]},"isInherited":true,"source":{"_postman_id":"e897b5f7-5906-4193-bf9d-fdd36c2fa08d","id":"e897b5f7-5906-4193-bf9d-fdd36c2fa08d","name":"Transactions","type":"folder"}},"urlObject":{"path":["api","v1","transaction","initiate"],"host":["https://uat.dashboard.tiqpayment.com"],"query":[],"variable":[]}},"response":[{"id":"22eb1117-773e-49b9-aaff-02e6c19a62bf","name":"Successful","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"test@accesspower.com\",\r\n \"amount\": 1000,\r\n \"reference\": \"m7asq8844ww834449ddh\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://uat.dashboard.tiqpayment.com/api/v1/payments/initiate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Strict-Transport-Security","value":"max-age=31536000 ; includeSubDomains"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Mon, 29 Jul 2024 14:16:08 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"payment_url\": \"http://95.179.202.250:8081/payment-gate-web/payment?permit_code=acdfedef-8471-4fba-88f3-ec7a619ee42e\",\n \"permit_code\": \"acdfedef-8471-4fba-88f3-ec7a619ee42e\",\n \"reference\": \"acdfedef-8471-4fba-88f3-ec7a619ee42e\",\n \"channelReference\": \"m7asq8844ww834449ddh\"\n },\n \"message\": \"Authorization URL created\",\n \"status\": true\n}"}],"_postman_id":"31e52b74-057b-4d10-9a5a-719a3ed73772"}],"id":"e897b5f7-5906-4193-bf9d-fdd36c2fa08d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJhbGciOiJIUzM4NCJ9.eyJzdWIiOiJtaWNoZWFsYWtpbnRvbGExMDZwb2dAZ21haWwuLmNvbSIsImlhdCI6MTcxNjE4ODM1MywiZXhwIjoxNzMxNzQwMzUzfQ.ubkxihRb5qvFVIYY_SOvx_5YGIJ8CU_6VzT1Dfcx6slMEmK9_XSf-_Fou7-84YDk"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"dd708007-8bdb-4838-a76f-4b895cdb5b40","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"94394fa2-225d-4b58-88aa-38c48ec9e315","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"e897b5f7-5906-4193-bf9d-fdd36c2fa08d","description":""}],"event":[{"listen":"prerequest","script":{"id":"0c5dec06-516d-4e46-b5bc-c48cd9be1ac6","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"d886aa9c-687b-4938-a516-db648c38159c","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"apiUrl","value":"https://uat.dashboard.tiqpayment.com"},{"key":"secretKey","value":"eyJhbGciOiJIUzM4NCJ9.eyJzdWIiOiJtaWNoZWFsYWtpbnRvbGExMDZwb2dAZ21haWwuLmNvbSIsImlhdCI6MTcxNjE4ODM1MywiZXhwIjoxNzMxNzQwMzUzfQ.ubkxihRb5qvFVIYY_SOvx_5YGIJ8CU_6VzT1Dfcx6slMEmK9_XSf-_Fou7-84YDk","type":"string"}]}