Verify xPay

Request returns xPay information

Typical use cases: reconciling internal transfers, confirming an allocation’s status, or surfacing sender/receiver details in your back office.

Endpoint

POST https://secure.3gdirectpay.com/API/v6/

Headers

Content-Type: application/xml; charset=utf-8
Accept: application/xml

Request

Required Fields

Example Request (XML)

<?xml version="1.0" encoding="utf-8"?>
<API3G>
  <CompanyToken>YOUR_COMPANY_TOKEN</CompanyToken>
  <Request>verifyXpay</Request>
  <XpayId>67834</XpayId>
</API3G>

Response

You’ll receive a high-level Result and allocation details (sender/receiver, currency, amount, etc.).

Example Success Response (XML)

<?xml version="1.0" encoding="utf-8"?>
<API3G>
  <Result>Success</Result>
  <Status>Pending</Status>
  <Sender>Air Excel</Sender>
  <Receiver>Direct Pay Limited</Receiver>
  <Currency>USD</Currency>
  <Amount>0.40</Amount>
  <Description>Payment for flight</Description>
  <ServiceType>Safari Holiday</ServiceType>
</API3G>

Fields

If your transaction responses elsewhere include xPay allocation references, you may also encounter AllocationID / AllocationCode in other APIs. Use verifyXpay to check the live status by XpayId.

Typical Flow

sequenceDiagram
  participant M as Merchant (You)
  participant D as DPO API

  M->>D: POST verifyXpay (XpayId)
  D-->>M: Result + allocation details (Status, Sender, Receiver, Amount)
  M->>M: Reconcile / display status internally

Best Practices

• Store and index XpayId in your back office so you can query status later.
• Treat Status as the source of truth for allocation progress (e.g., Pending → Completed).
• Log responses for audit trails (date, XpayId, Status, Amount, Currency).

Troubleshooting

• If you receive a non-success Result, verify:

  • CompanyToken validity
  • The XpayId exists and belongs to your hierarchy

• For XML errors (e.g., 804), confirm tag names and encoding.

• If the allocation is tied to a wider transaction, cross-check the parent transaction via Transaction Status Lookup.