xPay Payments

Use the xPay Payments APIs to manage transactions within the xPay Network, including:

Opening a new xPay transaction (Execute xPay)
Retrieving your available balance per currency (Get Balance)

These endpoints are typically used by platforms that need to initiate xPay payments programmatically and confirm available funds before executing or settling transactions.

Start Here — API Collection

For a complete, interactive view of all endpoints, flows, and sample requests, explore the official Transaction Operations API Collection:

DPO Pay Transaction Operations API Collection

Explore full API workflows, test calls, and view sample payloads.

xPay Payments Workflow

Use this interactive recipe to execute xPay transactions and retrieve account balances using the DPO Pay v6 API. The workflow demonstrates how to submit an xPay request, then verify the resulting balance using the same single-endpoint XML interface.

It’s designed for merchants and platforms that need to automate payouts, monitor available funds, and integrate xPay operations into production payment flows.

When to use xPay Payments

Use this category when you need to:

Initiate an xPay transaction against your company balance in a specific currency (docs.dpopay.com)
Check whether sufficient funds are available before initiating a payment or processing an outgoing transaction (docs.dpopay.com)
Build operational tooling (e.g., dashboards, reconciliations, internal finance flows) that require balance visibility

Available operations

Execute xPay

Purpose: Opens a new xPay transaction according to your company balance and currency. (docs.dpopay.com)

Typical flow:

Confirm you have sufficient balance (optional but recommended)
Submit an Execute xPay request to open the transaction
Handle the response and store the transaction reference for tracking/reconciliation

API reference: Execute xPay (operation: executeXpay) (docs.dpopay.com)

Get Balance

Purpose: Retrieves your available balance for a specific currency. (docs.dpopay.com)

Typical flow:

Request balance for the required currency
Use the response to validate whether the account can support the transaction amount
Proceed to Execute xPay (or present an error/alternative path if funds are insufficient)

API reference: Get Balance (operation: getBalance) (docs.dpopay.com)

Request and response format

The xPay Payments operations use an XML request body (application/xml). (docs.dpopay.com)
In your docs set, keep the overview lightweight, and rely on the API reference pages for the full schema and examples.

Suggested callouts to include on the page:

Authentication: Use the standard authentication approach defined for the DPO Pay API (same as other v6 endpoints).
Currency handling: Always specify the intended currency explicitly when checking balance and creating a transaction.
Operational readiness: Log and store the returned transaction references for auditability and reconciliation.

Common implementation patterns

Pattern A: Balance-first execution (recommended)

Get Balance for currency
Validate available funds
Execute xPay
Store response references and status

Pattern B: Direct execution (simpler)

Execute xPay
If unsuccessful due to balance constraints, handle the failure and retry after replenishment (or route to an alternative flow)

Related reference sections

For supporting implementation details, link developers to:

Gateway Response Codes (v6)
Verify Token Response Codes (v6)

(Exactly like the menu items you showed in your screenshot—nice and consistent.)

Suggested “Next steps” panel (optional)

Start with Get Balance to confirm the integration is authenticated and functioning correctly.
Move to Execute xPay once you can reliably retrieve balances and you’ve confirmed expected currencies are supported.