Payment Status

Poll a payment's status and read its final result.

Payment Status

After the user authenticates, poll the payment until it reaches a final status.

ℹ️

The payment status below (e.g. RJCT) is the payment outcome and comes

back on an HTTP 200. HTTP-level failures of the request itself (401,
404, 500, …) are separate — see Errors.

Get the status

GET https://api.open-finance.ai/v2/payments/{paymentId}/status

curl https://api.open-finance.ai/v2/payments/01J8X.../status \
  -H "Authorization: Bearer <accessToken>"

Returns the full payment object, including its current status and any error.

Get the full payment

GET https://api.open-finance.ai/v2/payments/{paymentId} returns the same
payment object — amounts, creditorName, debtorAccountNumber, service,
timestamps (createdAt / updatedAt), status, and any error.

List payments

GET https://api.open-finance.ai/v2/payments lists the user's payments.

Query paramDescription
limitMax documents to return.
sort1 ascending, -1 descending.
nextPagePagination cursor from the previous response.

Returns { nextPage, items }, where each item is a payment object.

Reading the status

Keep polling while the status is transient and stop once it's final:

  • Done, succeeded — the rail's success code (or ACSC / ACCC).
  • Done, failedRJCT, CANC, or ERROR.
  • Still in progress — anything else (INIT, RCVD, ACSP, ACTC, …).
📘

For every status code, its meaning, the per-rail success codes, and answers

to common questions, see Payment Statuses & FAQ.

Don't poll — get pushed

Rather than poll this endpoint in a loop, register a webhook and Financy will
notify you the moment a payment's status changes. See Payment Webhooks.


Did this page help you?