12. Get Payment Summary

Velocity exposes an API for retrieving the decrypted payment summary including the masked card number from various wallets.

Use the following API to get payment summary information:

Path Name	Path Details
End Point	[Velocity URL]/mpoint/ get-payment-summary
Format/Content Type	text/xml
Authentication	HTTP basic access authentication

12.1 Request

Merchants need to consume this API for wallet integration only. For example, if you have integrated Apple Pay or Google Pay and want to show the card number to your customer in a masked manner, you can call this API.

The following is an example of a request for retrieving the payment summary:

<?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>

12.2 Response

If the Get Payment Summary API request is successful, the masked card details are shown to a customer as a response.

<?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>

The parameters are listed and defined in the table below

Parameter	Type	Description
get-payment-summary	Object	The object which contains details of the payment summary.
client-id	Integer	The unique ID of a merchant.
transaction id	Integer	A unique transaction identification number of a transaction.
card type-id	Integer	The type of card used for a transaction.
token	String	The encrypted alpha-numeric string to represent card information used in third-part wallet.
client-info	String	The object which contains details of language used for a transaction, version, and platform details.
device-id	String	The unique device identification number from which a transaction is conducted.
card id	Integer	The ID which indicates the type of card used for a transaction.
charge-type-id	Integer	The ID to indicate the type of wallet used for a transaction.
mask	String	The masked value of a card number.
expiry	String	The expiration date of a card.
card-holder-name	String	The name of a card holder.
address	Object	The object which contains address details such as country-id, first name, last name, street name, postal code, city, and state.