XML Transaction Report

Updated 8 months ago by RM

When a payment is processed within the BCH digital secure payment environment, an XML-based transaction report can be posted to your systems.

This page contains a detailed description of all the fields used. It also contains an example XML required to develop a card payment transaction report receiver on your server.

To enable this feature, the URL of the receiver will need to be configured within the service setup. Please check with support to ensure this has been enabled.

During your testing and development phase, it is possible to use a test gateway. The test gateway will allow different transaction results to be reported without the use of live payment transaction.

XML Data Definition

Section
Field
Type / Format
Description
Attributes

<Transaction>

DateTime

Date&Time

Transaction Time

[DD/MM/YYYYHH:MM:SS]

Value

Double

Transaction Amount

Currency

  • string
  • ISO 4217

<Status>

Code

Int

Transaction status code

  • 100–Authorised
  • 200-Declined

Description

String

Description of status code

</Status>

<GatewayResponse>

AuthCode

String

Authorisation Code from the merchant

ResponseCode

String

Response code from the merchant

Message

String

Message returned from the merchant gateway

SecurityKey*

String

A Security key

AuthNumber

String

Unique Authorisation Code

VPSTxId

String

Sage Pay ID

TransactionID

String

Transaction Unique ID

</GatewayResponse>

<Card>

PAN

String

Sanitised card long number

Type

String

Card type

CHName

String

Card holder name

Token

String

Token associated with card

StartDate

String

Card start date (MM/YY)

ExpiryDate

String

Card expiry date (MM/YY)

IssueNumber

Int

Card issue number

</Card>

<Call>

Reference

Int

Call Reference number

Number

String

Number Dialled

CLI

String

Callers Number

Start

Date&Time

Start Time of the call [DD/MM/YYYYHH:MM:SS

</Call>

</Transaction>

Card Types

Below is the card types used with in the <card> node

Value
Card Type

UNKNOWN

Unknown card type

VISA

Visa card types

AMEX

American Express

DINERS

Diners Card

MAESTRO

Maestro Cards

SOLO

Solo Cards

MC

Mastercard

Example XML


How did we do?