Get Payment Summary

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 NamePath Details
End Point[Velocity URL]/mpoint/ get-payment-summary
Format/Content Typetext/xml
AuthenticationHTTP 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"?>
    <get-payment-summary client-id="[integer]">
        <transaction id="[integer]">
            <card type-id="16">
                <token>[Wallet Token]</token>
        <client-info language="us" version="1.28" platform="iOS/9.0.1">

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"?>
    <card id="7" charge-type-id="2">
        <card-holder-name>Joe Test</card-holder-name>
        <address country-id="200">
            <street>4000 Ponce De Leon Blvd</street>
            <city>Coral Gables</city>

The parameters are listed and defined in the table below

get-payment-summaryObjectThe object which contains details of the payment summary.
client-idIntegerThe unique ID of a merchant.
transaction idIntegerA unique transaction identification number of a transaction.
card type-idIntegerThe type of card used for a transaction.
tokenStringThe encrypted alpha-numeric string to represent card information used in third-part wallet.
client-infoStringThe object which contains details of language used for a transaction, version, and platform details.
device-idStringThe unique device identification number from which a transaction is conducted.
card idIntegerThe ID which indicates the type of card used for a transaction.
charge-type-idIntegerThe ID to indicate the type of wallet used for a transaction.
maskStringThe masked value of a card number.
expiryStringThe expiration date of a card.
card-holder-nameStringThe name of a card holder.
addressObjectThe object which contains address details such as country-id, first name, last name, street name, postal code, city, and state.