Retrieve Data from Locker

POST /data/retrieve

Description: Retrieve the sensitive data associated with a stored card reference.

Try it: https://api.example.com/data/retrieve

---

Example request (cURL)

cURL

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"
}
'

---

Response example (200)

application/json

{
  "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.

Accepted/request types:

• RetrieveDataReq

• JWEReq

Body fields:

• merchant_id (string) Example: "m0100"

• merchant_customer_id (string) Example: "HsCustomer1"

• card_reference (string) Example: "3ffdf1e5-7f38-4f26-936f-c66a6f4296fa"

---

Response

200 - application/json

Response types:

• RetrieveDataRes

• JWERes

Fields:

• status (enum) Available option: Ok

• payload (RetrieveRes object) Contains the sensitive data associated to the card reference. See the response example above for the structure.

---

Was this page helpful?

Yes / No

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/locker-api-reference/cards/retrieve-data-from-locker.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/locker-api-reference/cards/retrieve-data-from-locker

Related:

• Delete Data from Locker: https://api-reference.hyperswitch.io/locker-api-reference/cards/delete-data-from-locker

• Get or insert the data fingerprint: https://api-reference.hyperswitch.io/locker-api-reference/cards/get-or-insert-the-card-fingerprint