Get Payment Summary
This page provides information on the Get Payment Summary request and response. This operation retrieves the decrypted payment summary including the masked card number from various wallets.
The table below specifies the endpoint and request requirements for the Get Payment Summary operation:
Path Name | Path Details |
---|---|
Endpoint | [Velocity URL]/mpoint/get-payment-summary |
Request Method | GET |
Format/Content Type | text/xml |
Authentication | HTTP basic access authentication |
Request
Merchants need to use the Get Payment Summary operation 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 use this operation.
The following is an example 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>
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>
The operation's 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. |
Updated 2 months ago