status. This page maps each value to the action it calls for, and covers the operations that move a resource from one value to the next.
Enrollment
An enrollment created from a Reap card or a BIN sponsor card can reach
ACTIVE without a hosted step. An external card always passes through the hosted card entry page.
Revoke an enrollment
Revoke a stored card withPOST /agentic/enrollments/:id/revoke when the user removes it or when the card should stop working.
Request
Response
Mandate
CANCELLED and REVOKED are both end states, and neither returns to ACTIVE. The difference is scope. Canceling ends one mandate and leaves the stored card ready for a new one. Revoking the enrollment stops every mandate that points at that card.
Pause a mandate
POST /agentic/mandates/:id/pause holds charges and keeps the approved mandate.
Request
Response
Resume a mandate
Request
POST /agentic/mandates/:id/resume returns status as ACTIVE with the same mandate. Resuming needs no further approval from the user, because nothing about the mandate changed.
Cancel a mandate
Request
POST /agentic/mandates/:id/cancel returns status as CANCELLED. The enrollment stays untouched and remains available for a new purchase.
Pause and resume suit a temporary hold. Cancel ends the mandate for good. Revoking the enrollment is the wider action, because it stops charges across every mandate that points at the same stored card, and those mandates report REVOKED rather than CANCELLED.
Quote
A quote has no status field. It has an expiry instead.- Read
expiresAton every quote and open the checkout before that time - Create a new quote with
POST /agentic/quotesonce the expiry has passed, because merchant prices can move in between - Read the quote at any time with
GET /agentic/quotes/:idto get the current total
Checkout
COMPLETED, FAILED, and EXPIRED are final. A checkout never leaves one of them, so branch on the status value rather than treating anything other than COMPLETED as still in flight. Neither FAILED nor EXPIRED can be retried in place, and both need a fresh quote and a fresh checkout.
POST /agentic/checkouts returns a nextAction when the charge needs approval. A checkout created under a mandate the user approved earlier skips that step and moves straight into PROCESSING.
Read the checkout with GET /agentic/checkouts/:id after the user lands back on your return URL. Returning to that URL does not by itself mean the order is placed, so read the status. A nextAction of null on a completed checkout means you have nothing left to do.
Next steps
One-Time Purchases
The full purchase sequence with requests and responses.
FAQ
Short answers to common integration questions.