{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ae2af79a-65d9-4ac9-930c-5614514eee47","name":"DPO Pay API Collection (v7)","description":"## Overview\n\nThis collection contains example requests for **DPO Pay (Direct Pay Online) Public API – Version 7 (v7)**.\n\nIt was **generated from publicly accessible Confluence documentation** and is intended to help developers explore the API, prototype integrations, and validate request/response shapes.\n\n> **Important:** Request bodies and values in this collection are **illustrative examples** based on documentation snippets. You must replace placeholders with your own merchant credentials and production-ready values before using in a live integration. \n  \n\n---\n\n## Purpose\n\nUse this collection to:\n\n- Authenticate and obtain session/context (where required)\n    \n- Initiate and manage transactions\n    \n- Query transaction status and reports\n    \n- Work with Super Wallet functions (where enabled for your account)\n    \n\n## Intended audience\n\n- Merchants / integrators building payment and payout flows\n    \n- QA / support engineers troubleshooting transactions\n    \n- Developers validating request formats during onboarding\n    \n\n---\n\n## Base URL(s)\n\nRequests in this collection currently reference multiple hosts (see **Known issues / TODO before publish**). The most common production base URL in this collection is:\n\n- **Production:** `https://secure.3gdirectpay.com/API/v7`\n    \n\nSome requests also use `.../API/v7/index.php` and one auth path uses `.../API/v7/Auth`.\n\nIf your organization provides different **sandbox/UAT** base URLs, set them in the environment variables and update requests to reference variables (recommended).\n\n---\n\n## Authentication prerequisites\n\nDPO Pay v7 uses **merchant credentials/tokens** issued by DPO. Before sending requests, ensure you have:\n\n- Merchant/company token and any required API credentials\n    \n- Any account configuration required for the features you plan to use (e.g., Super Wallet, tokenized payments)\n    \n\nThis collection includes requests such as **Auth** / **UserAuth** that relate to authentication. Exact requirements can vary by account and feature—confirm the correct credential set and required XML fields for your merchant profile.\n\n---\n\n## Using the provided Postman Environment & variables\n\nAn environment is available in this workspace: [New Environment](https://environment/43162886-312cf890-9e8e-4611-8373-070886fa6b7d).\n\n### Recommended variables\n\nFor a publish-ready consumer experience, we recommend driving hostnames and common identifiers via variables, e.g.:\n\n- `baseUrl` (e.g., `https://secure.3gdirectpay.com/API/v7`)\n    \n- `companyToken` / `merchantToken`\n    \n- `transactionToken`\n    \n- `dpoRef`\n    \n- `serviceType` / `serviceDescription`\n    \n\nThen update request URLs and XML bodies to reference variables like:\n\n- `{{baseUrl}}`\n    \n- `{{companyToken}}`\n    \n\n> Note: This collection was generated from Confluence and currently contains **hard-coded URLs** in requests; see Known issues. \n  \n\n---\n\n## Folder guide\n\n- **Super Wallet(v7)**: wallet/account actions such as creating an account, adding/removing mobile details, and related account operations.\n    \n- **Transaction operations (v7)**: core transaction lifecycle actions—create/update/verify/query transactions, refunds, logs, counts, and reporting endpoints.\n    \n- **Merchant operations (V7)**: merchant-level authentication and company/merchant details.\n    \n- **Transaction payment options (V7)**: retrieve payment options and perform tokenized charges for card/mobile.\n    \n\n---\n\n## Common workflows\n\n### 1) Authenticate / establish context\n\n1. Run **Auth** (or **UserAuth**, depending on your flow/account configuration)\n    \n2. Capture any returned token(s) and store them as environment variables for later requests\n    \n\n### 2) Initiate and manage a transaction\n\n1. Create/initialize a transaction (endpoint names may vary)\n    \n2. Use **Verify Transaction Token - verifyToken (V7)** to validate the transaction token when required\n    \n3. Query status using **getTransactionByRef**, **Search by DPO ref V7**, or **getTransactions**\n    \n\n### 3) Reporting\n\n1. Use **fetchReports(V7)** / **generateReport(V7)** / **editReport(V7)** as applicable\n    \n2. Use counts/frequency endpoints (e.g., **getTransactionsCount**, **getTransactionsFrequency**) for analytics-style queries\n    \n\n---\n\n## Notes / disclaimers\n\n- This collection was **generated from Confluence** documentation and may not reflect the latest behavior if the upstream docs change.\n    \n- XML payloads are based on documentation examples and may include placeholders.\n    \n- Some endpoints/features may be restricted by region, merchant profile, or product enablement.\n    \n\n---\n\n## Known issues / TODO before publish\n\n### Non-production hostnames detected\n\n**Dev host (****`3g.rogersm.dev.directpay.online`****)**\n\n- editReport(V7)\n    \n- generateReport(V7)\n    \n- fetchReports(V7)\n    \n- GetMobilePaymentOptionsByCompanyToken(V7)\n    \n\n**Sandbox host (****`secure1.sandbox.directpay.online`****)**\n\n- createAccount(V7)\n    \n- addMobile\n    \n- pullAccount(V7)\n    \n- chargeTokenCreditCard(V7)\n    \n- ChargeTokenMobile (V7)\n    \n\n---\n\n### Recommended remediation\n\n1. **Introduce environment variables**  \n    Use `{{baseUrl}}` (and optionally `{{authBaseUrl}}`) and update all request URLs accordingly.\n    \n2. **Confirm host usage**  \n    Verify which endpoints use sandbox vs production hosts, and document this clearly.\n    \n3. **Resolve placeholders**  \n    Replace placeholder requests (e.g. `activateAccount (TBC)`) with final request definitions, or clearly mark them as not implemented.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"43162886","team":8434813,"collectionId":"ae2af79a-65d9-4ac9-930c-5614514eee47","publishedId":"2sBXiknWnS","public":true,"publicUrl":"https://documenter-api.postman.tech/view/43162886/2sBXiknWnS","privateUrl":"https://go.postman.co/documentation/43162886-ae2af79a-65d9-4ac9-930c-5614514eee47","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Official Postman collection for DPO Pay Public API v7, including XML request examples for transaction operations, merchant operations, payment options, and Super Wallet workflows"},{"name":"title","value":"DPO Pay API v7 (Direct Pay Online) — Postman Collection (XML)"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/37a31e79-d588-4b13-bed7-bc002ce499af/RFBPX1BheV9ieV9OZXR3b3JrX0xvZ29fMy5qcGc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/184071fc-0cc4-4e95-950e-1a7d1c241b6b/RFBPX1BheV9ieV9OZXR3b3JrX0xvZ29fMy5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.14","publishDate":"2026-03-26T05:31:05.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"DPO Pay API v7 (Direct Pay Online) — Postman Collection (XML)","description":"Official Postman collection for DPO Pay Public API v7, including XML request examples for transaction operations, merchant operations, payment options, and Super Wallet workflows"},"logos":{"logoLight":"https://content.pstmn.io/184071fc-0cc4-4e95-950e-1a7d1c241b6b/RFBPX1BheV9ieV9OZXR3b3JrX0xvZ29fMy5wbmc=","logoDark":"https://content.pstmn.io/37a31e79-d588-4b13-bed7-bc002ce499af/RFBPX1BheV9ieV9OZXR3b3JrX0xvZ29fMy5qcGc="}},"statusCode":200},"environments":[],"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/2cc01f31a63398d1cb444d28ae9481c483d93a5ab52ca2ff5dc1f94488330285","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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBXiknWnS"}