Get Payment Request Status
GET/v1/payment_requests/bank_payments_status
Retrieve the current status of a bank payment request. This endpoint allows you to check the status of a specific payment, helping you track its progress and outcome. The possible statuses are as follows:
pending
: The customer has not yet made the requested payment.received
: The payment has been successfully completed by the customer.expired
: The payment request has expired due to the time limit.return_pending
: A refund (either full or partial) has been requested on this payment.return_received
: The refund has been successfully transferred back to the original payer.return_expired
: The refund request expired after 10 days without being completed.return_rejected
: The refund failed due to an issue with the destination account, and Hello Clever will not retry the transaction.
To retrieve the status, you must provide either a unique id
or both bsb
and account_number
. If both id
and bsb
with account_number
are provided, id
will be prioritised.
Request
Responses
- 200
- 400
- 401
- 404
Payment request status retrieved successfully.
Bad Request
Unauthorized
Not Found