Skip to main content

Get PayID Status

GET 
/v1/payment_requests/status

Retrieve the current status of a PayID payment request, providing real-time updates to track the state of a payment. This endpoint is essential for monitoring payment progress and handling different outcomes, including refunds.

Possible statuses include:

  • pending: The customer has not yet made the payment.
  • received: The payment has been successfully completed by the customer.
  • expired: The payment request has expired because it was not fulfilled in time.
  • return_pending: A refund request (either full or partial) is pending on this payment.
  • return_received: The refund has been successfully returned to the original payer.
  • return_expired: The refund request expired after being unfulfilled for 10 days.
  • return_rejected: The refund failed due to an issue with the recipient's account. No further attempts will be made to process the refund.

Note: Either id or payid is required as a query parameter. If both are provided, the id will take precedence in determining the status.

Request​

Responses​

Payment request status retrieved successfully.