Checkout
Get checkout status
The current state of a run. Poll every five to ten seconds until status is submitted, canceled, blocked or error.
Live API. A POST to /v1/cards issues a real card.
Authorizations
Authorizationstringrequired
Bearer token:
Authorization: Bearer mk_live_.... Create a key in the AgentPay console under Developer, API keys.Path parameters
checkout_idstringrequired
From the start-checkout response.
Response
checkout_idstring
statusstring
The run state.
Available options:
queued, running, needs_login, needs_answer, awaiting_approval, needs_card_approval, paying, submitted, canceled, blocked, errortaskstring
merchantstring
amountnumber
The cap in dollars.
card_last4string
The card the run pays with, once minted or chosen.
card_sourcestring
issued or own.hoststring
The site the run opened.
review_totalstring
The shop's total at the review, as a display string such as
"1.98 USD" or "60.90 AED".order_idstring
The merchant's order id, on
submitted.order_totalstring
The paid total as a display string, on
submitted.needs_loginboolean
true while the status is needs_login.login_checkstring
On
needs_login: why.Available options:
signed_out, unknown, passkey_passwordlogin_urlstring
On
needs_login: the page the browser stopped on.connect_urlstring
On
needs_login: the live window where the person signs in.login_layerstring
How the run signed in.
Available options:
session, passkeyneeds_card_approvalboolean
true while the run waits for the cardholder.approval_urlstring
On
needs_card_approval: the link for the cardholder's phone.approval_expires_atstring
On
needs_card_approval: when the link stops working.payment_unknownboolean
true when the run paid but could not read the merchant's confirmation. Check the merchant account before retrying.error_reasonstring
On
blocked or error: why.request_idstring
The request id, also in the
X-Mooj-Request-Id header.Errors
| Status | Code | When |
|---|---|---|
| 404 | checkout_not_found | No such checkout on your account. |