Get the status of a payment request
E-transfer
/PaymentRequests
Use this endpoint to check on the status of a payment request by providing the requestId of a previously generated payment.
GET
Get the status of a payment request
Use this endpoint to check on the status of a payment request by providing the
Once authenticated, you can provide the previously generated
requestId of a previously generated payment.
To successfully call this endpoint, you must first call the /Authorize endpoint to obtain a valid access_token.
Get the status of a payment request
In order to check on the status of a payment request and confirm that it has been completed, you are able to re-call the/PaymentRequests endpoint—but rather than submitting the creation of a new request, you will use GET to retrieve the status of a previously created request.
Polling Recommendation
If implemented, it is recommended that you are able to poll this endpoint every 30 seconds until you receive an update in thestatus field. However, it is highly recommended to use Events as detailed in the quick start guide in order to provide the user the best experience on the front-end.requestId of a payment transaction to receive an update on the current status of the given transaction. The API will return with this status (see below for currently supported statuses) as well as the ReferenceId provided upon generation of a session. Finally, it also includes the original PaymentLink that was generated for the given transaction, this can be used to represent the link to the user if it is still in an ‘initiated’ state.
Payment status
Please find all the available statuses and descriptions below:| STATUS | DESCRIPTION |
|---|---|
| Initiated | Request for payment has been received and is ready for processing by the end user. |
| Processing | User is processing the transaction and the transaction is ready to be filled. |
| Accepted | User has accepted the payment request at their Financial Institution and the funds flow has started. Funds are guaranteed at this stage. |
| Processed | Flinks has processed the transaction and is awaiting settlement on your account. |
| Settled | Payment request has successfully completed and fund transfer has been initiated to your account. |
| Cancelled | Payment was cancelled before being initiated. |
| Expired | End user did not action the payment request and the request has expired. You will need to initiate a new request if necessary. |
| Declined | End user has declined the payment request at their Financial Institution. |
| Failed | Payment request has failed. |
| failed_name_matching | Returned in the ‘StatusDetails’ field. Indicates that the reason for the failure was due to the name submitted during the creation of the session and the name returned from the ExternalFI did not match, and as such the transaction has failed. No funds have been moved, you can create a new session with an adjusted correct name as appropriate. |
Headers
The unique environment that you are making the API call from. Provided during onboarding.
Bearer (plus the access_token received previously in a completed authorize call).
Path Parameters
Unique GUID representing a previously generated payment transaction.