Retrieve a Pay Request

This endpoint is for fetching Pay Requests.

Request

Security:

JWT

path Parameters

payRequestId

required

string

header Parameters

Authorization

required

string

Default: Bearer {$$.env.access_token}

Responses

200

The Pay Request response

404

When the provided payRequestId does not match a Pay Request stored in the system.

get/pay-terminal/requests/{payRequestId}

Request samples

curl
C#
Node.js

curl -i -X GET \
  'https://api.tyro.com/connect/pay-terminal/requests/{payRequestId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

application/json

{"id": "a2be1eaf-b873-4aa9-9530-fc3007231572",
"mid": "123",
"tid": "456",
"status": "SUCCESS",
"total": {"currency": "AUD",
"cashoutAmount": 1000,
"goodsAndServicesAmount": 5000,
"refundAmount": 0
},
"options": {"integratedReceipt": true,
"receiptWidth": 60
},
"origin": {"name": "Example",
"orderId": "Pay Terminal Example",
"transactionId": "cffd6564-0023-44d8-996e-2932292277c2"
},
"transactionProgress": {"id": "COMPLETE",
"description": "The transaction is processed"
},
"pendingDecision": {"decisionId": "0f448ac1-862a-4c7b-bdb4-a3b7cdbf6149",
"question": "Would you like to print a receipt?",
"options": ["YES",
"NO"
]
},
"receipts": {"customer": "<This will be a printable receipt for the customer>",
"merchant": "<This will be a printable receipt for the merchant>",
"signature": "<This will be a printable receipt for the merchant if signature is required>"
},
"transactionOutcome": {"transactionResult": "Approved",
"approvalCode": "00",
"transactionReference": "xa29boybbo",
"authorisationNumber": "674574564",
"cardType": "visa",
"elidedPan": "XXXXXXXXXXXX8635",
"retrievalReferenceNumber": "63594680046125834000",
"surchargeAmount": 300,
"tipAmount": 500,
"totalAmount": 6800
}
}