Retrieve Token

Retrieve card details by card id

GET https://<PayEngine-host>/api/cards/:id

Path Parameters

Name	Type	Description
id*	string	PayEngine card unique ID

200: OK

Card token

Field name	Type	Description	Required?
id	string	Card token ID	Required
merchant_id	string	Merchant ID	Required
name	string	Name associated with this card	Required
email	string	Email address associated with this card	Optional
exp_month	integer	Expiration month	Required
exp_year	integer	Expiration year	Required
last_4	integer	Last four digit of the card	Required
address_line1	string	Address line 1 associated with Cardholder's billing address	Optional
address_line2	string	Address line 2 associated with Cardholder's billing address	Optional
address_city	string	City associated with Cardholder's billing address	Optional
address_state	string	State associated with Cardholder's billing address	Optional
address_zip	string	Zip code associated with the card	Optional
address_country	string	Country associated with Cardholder's billing address	Optional
brand	string	Card brand	Required
country	string	Country where card issued	Required
type	string	Type of card - Credit | Debit | Gift | Prepaid	Required
expires_at	string	Card token expiration timestamp	Optional
token	string	Card token that is used for making payments	Required
surcharge_allowed	boolean	True | False. True if the surcharge is allowed for the card	Required
phone_number.cc	string	Cardholder Phone Country Code	Optional
phone_number.subscriber	string	Cardholder Phone Number	Optional
card_updater	object	Card updater information details only when card account updater is enabled	Optional
card_updater.status	string	Values - enrolled | closed Required if the card_updater object is present	Required
card_updater.type	string	Values - updated, expired, closed, no_participating, contact_cardholder_advice, unknown, opt_out, enrolled Required if the card_updater object is present	Required
card_updater.enrolled_at	string	Timestamp indicating when the card was enrolled in the Card Account Updater service. Required if the card_updater object is present Note: This date is not the same as the token creation date	Required
card_updater.updated_at	string	Timestamp indicating when the last update was received. Required if the card_updater object is present	Required

cURL

curl --location --request GET 'http://<PayEngine-host>/api/cards/1d15778a-64fb-459b-8c19-e8b5da0a9af9' \
--header 'Authorization: Basic <YOUR_API_SECRET>'

Response

{
    "id": "1d15778a-64fb-459b-8c19-e8b5da0a9af9",
    "merchant_id": "a3766e78-7388-4c94-b3e9-a89feeb9ab3a",
    "name": "John Doe",
    "exp_month": 12,
    "exp_year": 2023,
    "last_4": "1111",
    "brand": "visa",
    "country": "United States of America",
    "type": "Credit",
    "surcharge_allowed": true,
    "token": "card_test_V3atojWZsHCVCqqeYoHo5Oo2",
    "created_at": "2021-12-27T03:35:38.947Z",
    "address_line1": "123 Street 1",
    "address_line2": "Unit 123",
    "address_city" : "Burbank",
    "address_state": "CA",
    "address_country": "US",
    "address_zip": "90245",    
    "email": "[email protected]",
    "phone_number": {
        "cc": "1",
        "subscriber": "4155056227"
    },
    "card_updater": {
        "status": "enrolled", 
        "type": "updated",
        "enrolled_at": "2025-03-27T03:35:38.947Z",
        "updated_at": "2025-03-28T03:35:38.947Z"
    }
}