Get a Payment Request.

Retrieves an existing PayID PaymentRequest.

Use the contents of the response body to determine whether the customer has made their payment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

For detailed information on how to use this API and specific merchant use cases for this API, please refer to this API reference guides documentation: PaymentRequestAPI

Error Codes

CodeStatusReasonWhat to do
ERR0.04400"paymentRequestId: PaymentRequestID not found"Check the paymentRequestID is valid. Note that if a paymentRequestId has been deleted via the Delete a Payment Request API, it will not be available via the Get API

Query Params
string
required

ID of Payment Request to retrieve.

This is the paymentRequestId returned by the Create a Payment Request API

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json