{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"4274621e-9585-4e85-a8f2-0c7e7fd073f6","name":"RoutePay Payment API Documentation","description":"## Overview\n\nThe **RoutePay Payment API** allows merchants to **initiate, process, and verify payments** for services such as **airtime and data bundles**. It also provides **KYC (BVN) verification**.\n\nThis documentation covers authentication, request payloads, response objects, and payment status handling.\n\n**Note:** Always verify the transaction status before confirming to your users.\n\n<img src=\"https://content.pstmn.io/c7378714-793f-449c-8068-952877275a00/aW1hZ2UucG5n\" width=\"636\" height=\"651\">\n\n## **Environments**\n\n- **Sandbox:** `https://apidev.routepay.com`\n    \n- **Production:** `https://api.routepay.com`\n    \n\n## Dev Tools\n\nThe client Id and SecretKey generated from the merchant portal can be passed to the developer for the integration of routepay payment api. The developer can use the postman documentation below, it also provides sample source code in the language of your choice.\n\nIn the test environment, use the following card details to test for approved payment and declined payment:\n\nPayment Approved:\n\nCard Number: `\"4111111111111111\"`\n\nExpiry Date: 05/2050\n\nCVV: 123\n\nPayment Declined:\n\nCard Number: `\"4242424242424242\"`\n\nExpiry Date: 05/2050\n\nCVV: 123\n\n### Payment Status\n\n| **Status** | **Description** |\n| --- | --- |\n| 0 | Successful |\n| 550 | Failed |\n| 250 | Pending |\n| 260 | Processing |\n| 210 | AlreadyProcessed |\n| 220 | Cancelled |\n\nYou must always query the transaction to determine the status of the payment. A payment is considered successful only when the HttpStatusCode = 200, PaymentStatus = 0 and Description = Successful.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"2198647","team":337688,"collectionId":"4274621e-9585-4e85-a8f2-0c7e7fd073f6","publishedId":"2s847ETFBW","public":true,"publicUrl":"https://documenter-api.postman.tech/view/2198647/2s847ETFBW","privateUrl":"https://go.postman.co/documentation/2198647-4274621e-9585-4e85-a8f2-0c7e7fd073f6","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2022-10-18T04:12:22.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Test","id":"107263f3-7333-4588-b327-8beaacde0bca","owner":"2198647","values":[{"key":"ClientId","value":"KvzzjGWKzSNKAew","enabled":true,"type":"secret"},{"key":"ClientSecret","value":"KJKYufntfGtlEDJWgzxPwNgIPHCXoj","enabled":true,"type":"secret"},{"key":"Env","value":"qa","enabled":true,"type":"default"},{"key":"accessToken","value":"","enabled":true,"type":"any"},{"key":"transactionReference","value":"","enabled":true,"type":"default"},{"key":"baseUrl","value":"https://api{{Env}}.routepay.com","enabled":true,"type":"default"},{"key":"userAccessToken","value":"eyJhbGciOiJSUzI1NiIsImtpZCI6IjNDMTMwRjdBNUY4MEUxNUMwQkI1OTE4REI4QzBFQjFGNzM0QUE4ODRSUzI1NiIsInR5cCI6ImF0K2p3dCIsIng1dCI6IlBCTVBlbC1BNFZ3THRaR051TURySDNOS3FJUSJ9.eyJuYmYiOjE3NDU1NjkzNjksImV4cCI6MTc0NTU3MjM2OSwiaXNzIjoiaHR0cHM6Ly9hdXRocWEucm91dGVwYXkuY29tIiwiYXVkIjpbIlJvdXRlUGF5LkJpbGxzUGF5bWVudEFwaSIsIlJvdXRlUGF5Lk1lcmNoYW50QXBpIl0sInN1YiI6IjU2NWIxNWJkLWQ0MWItNGU5Yy04Y2U5LWMwNTY3NWIxNDU0NCIsImF1dGhfdGltZSI6MTc0NTU2OTM2OSwiaWRwIjoiaHR0cHM6Ly9hdXRocWEucm91dGVwYXkuY29tIiwicm9sZSI6IkN1c3RvbWVyIiwic291cmNlIjoiQmlsbHNQb3J0YWwiLCJqdGkiOiIwNTVjNDYwYi1kNTA4LTQ0YzUtYTMwMC0zZmIyNjU4ZDkwZWIiLCJzaWQiOiI1ZjVhODc0MC00OGJkLTQ2NDUtOTU3Zi1iMjY1OWE5OGI0MGYiLCJpYXQiOjE3NDU1NjkzNjksInNjb3BlIjpbIlJvdXRlUGF5LkJpbGxzUGF5bWVudC5yZWFkIiwiUm91dGVQYXkuQmlsbHNQYXltZW50LndyaXRlIiwiUm91dGVQYXkuTWVyY2hhbnRBcGkucmVhZCIsIlJvdXRlUGF5Lk1lcmNoYW50QXBpLndyaXRlIl0sImFtciI6WyJwd2QiXX0.W9WyRwTG2dFptSgx0wBJkCUHFokRs7jYgnZ9xrz98RX7nMJHPGxYaD1jlyGyOvu06dw3vBxuLGEi0YD7Pfaze5hYsBAArlb1ZLnN8AaHT8ZgyYt3mTlAxyZH772X-xXLolkLCbQYQslruvtib6whdljBbP0cSLDmbfEmCihz8rYftyMh9EGwZ_DL_reByo3CVfkMizH6rIGdpKRnmaUBQvv4khu8ZsPKk9mtlaqzd5Wpl_Qd4ZtQnreUB7BoyRHv9UJ0RcDay8d4CSh45PDUTJHdkZUGh57JBDhEXpjBTCDZRHBIPavEPAvf51iVA-tmvwbhj11huEmcgMqGP14MQw","enabled":true,"type":"default"},{"key":"random4char","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/8752e69825d989bda8c05582e6409cf62eacc26f6af4dcd5d8345ed4199f8a5f","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Test","value":"2198647-107263f3-7333-4588-b327-8beaacde0bca"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s847ETFBW"}