Skip to main content
POST
/
data
/
retrieve
Retrieve Data from Locker
curl --request POST \
  --url https://api.example.com/data/retrieve \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchant_id": "m0100",
  "merchant_customer_id": "HsCustomer1",
  "card_reference": "3ffdf1e5-7f38-4f26-936f-c66a6f4296fa"
}
'
{
  "status": "Ok",
  "payload": {
    "card": {
      "card_number": "<string>",
      "name_on_card": "<string>",
      "card_exp_month": "<string>",
      "card_exp_year": "<string>",
      "card_brand": "<string>",
      "card_isin": "<string>",
      "nick_name": "<string>"
    }
  }
}

Headers

​
x-tenant-id
string

Body

application/json

The request body might be JWE + JWS encrypted when using middleware

​
merchant_id
string
Example:

"m0100"

​
merchant_customer_id
string
Example:

"HsCustomer1"

​
card_reference
string
Example:

"3ffdf1e5-7f38-4f26-936f-c66a6f4296fa"

Response

200 - application/json

Retrieve Data Response

Response received with the sensitive data, associated to the card reference

​
status
enum<string>
Available options:
Ok
​
payload
RetrieveRes · object