closedLoopReads

Retrieve closed loop read

Changed on

Use 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:

  • Date that the payment device captured the information.
  • Unstructured payload from the card.
get/closed-loop-reads/{closedLoopReadId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/closed-loop-reads/{closedLoopReadId}
  • Auth
    HTTP bearer

Path parameters

closedLoopReadIdstring required

Unique identifier that we assigned to the closed-loop read.

Response

Successful request. Returns information from the closed-loop card.

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

closedLoopReadIdstring required

Unique identifier that we assigned to the closed-loop read.

readDatestring date required

Date that the payment device read the closed-loop card. Our gateway returns this value in YYYY-MM-DD format.

dataClosedLoopResponseData required

Unstructured payload from the card.

Changes