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/requests/{payRequestId}
Request samples
curl -i -X GET \
  'https://api.tyro.com/connect/pay/requests/{payRequestId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "id": "string",
  • "paySecret": "string",
  • "locationId": "string",
  • "provider": {
    },
  • "origin": {
    },
  • "payMethod": {
    },
  • "capture": {
    },
  • "status": "AWAITING_PAYMENT_INPUT",
  • "supportedNetworks": [
    ],
  • "total": {
    },
  • "transactionResults": [
    ],
  • "threeDSecureDetails": {
    }
}
Copyright © Tyro Payments 2019-2024. All right reserved.