This page provides API reference for Velocity API's Get Payment Summary operation (get-payment-summary). This operation is only applicable to wallet integration. For information on how to integrate this operation, see API.

Request

Endpoint: /mpoint/get-payment-summary
Method: GET

Sample Request

Below is a sample Get Payment Summary request:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <get-payment-summary client-id="[integer]">
    <transaction id="[integer]">
      <card type-id="16">
        <token>[Wallet Token]</token>
      </card>
    </transaction>
    <client-info language="us" version="1.28" platform="iOS/9.0.1">
      <customer-ref/>
      <device-id>86A535F6B2A414423327</device-id>
      <ip>10.14.128.7</ip>
    </client-info>
  </get-payment-summary>
</root>

Request Parameters

`get-payment-summary`

Parent: root

The get-payment-summary element is required, and it has the following attribute:

Parameter	Format	Requirement	Description
`client-id`	Integer	Required	The unique ID of a merchant.

`transaction`

Parent: root: get-payment-summary

The get-payment-summary element requires at least one transaction child, and it may have multiple transaction children.

Each transaction child element has the following attribute:

Parameter	Format	Requirement	Description
`id`	Integer	Required	A unique transaction identification number of a transaction.

`card`

Parent: root: get-payment-summary: transaction

The card element is required, and it has the following attribute:

Parameter	Format	Requirement	Description
`type-id`	Integer	Required	The type of card used for a transaction.

`token`

Parent: root: get-payment-summary: transaction

The token element is required, and it has the following text content:

Parameter	Format	Requirement	Description
token	String	Required	The encrypted alpha-numeric string to represent card information used in a third-party wallet.

`client-info`

Parent: root: get-payment-summary

The client-info element is required, and it has the following attributes:

Parameter	Format	Requirement	Description
`language`	String	Required	The language used for a transaction.
`version`	String	Required	The version used for a transaction.
`platform`	String	Required	Platform details.

`customer-ref`

Parent: root: get-payment-summary: client-info

The customer-ref element is optional, and it has the following text content:

Parameter	Format	Requirement	Description
customer reference ID	String	Optional	A merchant-generated ID for the customer, for internal reference.

`device-id`

Parent: root: get-payment-summary: client-info

The device-id element is required, and it has the following text content:

Parameter	Format	Requirement	Description
device ID	String	Required	The unique device identification number from which a transaction is conducted.

`ip`

Parent: root: get-payment-summary: client-info

The ip element is required, and it has the following text content:

Parameter	Format	Requirement	Description
IP address	String	Required	The client's IP address.

Response

Sample Response

If the Get Payment Summary request is successful, the masked card details are shown to a customer as a response like the following:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <card id="7" charge-type-id="2">
    <card-number-mask>540287******4924</card-number-mask>
    <expiry>10/17</expiry>
    <card-holder-name>Joe Test</card-holder-name>
    <address country-id="200">
      <first-name>Joe</first-name>
      <last-name>Test</last-name>
      <street>4000 Ponce De Leon Blvd</street>
      <postal-code>33146</postal-code>
      <city>Coral Gables</city>
      <state>FL</state>
    </address>
  </card>
</root>

Response Parameters

`card`

Parent: root

The card element is required, and it has the following attributes:

Parameter	Format	Requirement	Description
`id`	Integer	Required	The ID which indicates the type of card used for a transaction.
`charge-type-id`	Integer	Required	The ID to indicate the type of wallet used for a transaction.

`card-number-mask`

Parent: root: card

The card-number-mask element is required, and it has the following text content:

Parameter	Format	Requirement	Description
masked card number	String	Required	The masked value of a card number.

`expiry`

Parent: root: card

The expiry element is required, and it has the following text content:

Parameter	Format	Requirement	Description
expiration date	String	Required	The expiration date of a card.

`card-holder-name`

Parent: root: card

The card-holder-name element is required, and it has the following text content:

Parameter	Format	Requirement	Description
cardholder name	String	Required	The name of the cardholder.

`address`

Parent: root: card

The address element is required, and it has the following attribute:

Parameter	Format	Requirement	Description
`country-id`	Integer	Required	The country code of the cardholder's mailing address.