/closed-loop-reads/{closedLoopReadId}getClosedLoopUse this method to retrieve information that a payment device captured from a closed-loop card.
A closed-loop card is a type of card that a customer can use only with a specific merchant. Each time a payment device captures information from a closed-loop card, we store the information as a closed-loop read.
Our gateway returns the following information from a closed-loop read:
| Name | In | Type | Description |
|---|---|---|---|
closedLoopReadIdRequired | path | string | Unique identifier that we assigned to the closed-loop read. |
Successful request. Returns information from the closed-loop card.
{
"closedLoopReadId": "KEO45MAC1U",
"data": {
"cardType": "MiFareClassic",
"uid": "04134ee21f1d80"
},
"processingTerminalId": "1234001",
"readDate": "2024-07-02"
}Invalid request
{
"detail": "One or more validation errors occurred, see error section for more info",
"errors": [
{
"detail": "invalid date",
"message": "Expected time, got '' for start_time",
"parameter": "start_time"
}
],
"status": 400,
"title": "Bad request",
"type": "https://docs.payroc.com/api/errors#bad-request"
}Identity could not be verified
{
"detail": "Your identity could not be verified",
"status": 401,
"title": "Not Authorized",
"type": "https://docs.payroc.com/api/errors#not-authorized"
}Do not have permissions to perform this action
{
"detail": "You do not have the required permissions to perform this action",
"instance": "https://api.payroc.com/v1/exampleResource/3",
"resource": "exampleResource",
"status": 403,
"title": "Forbidden",
"type": "https://docs.payroc.com/api/errors#forbidden"
}Resource not found
{
"detail": "Resource not found",
"resource": "(The Type of the Resource)",
"status": 404,
"title": "Not found",
"type": "https://docs.payroc.com/api/errors#not-found"
}Not acceptable
{
"detail": "Resource does not support the representation requested",
"status": 406,
"title": "Not acceptable",
"type": "https://docs.payroc.com/api/errors#not-acceptable"
}An error has occured
{
"detail": "We are unable to process your request at this time",
"errors": [
{
"message": "Service offline"
}
],
"status": 500,
"title": "Api error",
"type": "https://docs.payroc.com/api/errors#api-error"
}