Table of Contents
The API “get_shopper_payment_account” allows a user to retrieve the payment account associated with their shopper account. It returns a list of payment cards associated with the user’s payment account. The user must provide their user ID as a parameter to retrieve their payment account information. The response includes the card ID, card type, name on card, card number, and expiry date for each card associated with the user’s account. The API response is in JSON format.
Endpoint #
The Voomerr payment account endpoint is POST https://admin.voomerr.com/api/get_shopper_payment_account.php
Parameters #
| Parameter Name | Data Type | Required | Description |
|---|---|---|---|
| user_id | Integer | Yes | The unique identifier of the shopper. |
Response #
If the API call is successful, it will return a JSON response with the following parameters:
| Parameter Name | Data Type | Description |
|---|---|---|
| success | Boolean | Indicates whether the API call was successful or not. |
| message | String | A message indicating the result of the API call. |
| cards | Array | An array of payment account cards associated with the specified shopper. Each card object contains the following parameters: |
| id | Integer | The unique identifier of the payment account card. |
| card_type | String | The type of the payment account card (e.g., Visa, Mastercard, American Express, etc.). |
| name_on_card | String | The name of the cardholder. |
| card_number | String | The card number, with only the last 4 digits visible. |
| expiry | String | The expiration date of the card, in the format MM/YY. |
| is_active | Boolean | Indicates whether the payment account card is currently active or not. |
Example Request #
json
{
"user_id": 12345
}
Example Response #
json
{
"success": true,
"message": "Payment account cards retrieved successfully.",
"cards": [
{
"id": 123,
"card_type": "Visa",
"name_on_card": "John Doe",
"card_number": "************1234",
"expiry": "12/23",
"is_active": true
},
{
"id": 456,
"card_type": "Mastercard",
"name_on_card": "Jane Doe",
"card_number": "************5678",
"expiry": "06/24",
"is_active": false
}
]
}
