How it works
OnceThe user adds a card and sets a budget for the next 30 days.Then, for each purchase:
- 1RequestYour agent sends what it’s buying.
transactionId - 2CheckBudget and your spending limits. Without a budget, the user enters their security code.↻ Repeats: wait, approval
nextAction - 3PaySapiom Browser Pay swaps the placeholder for the real card.
payment_ready - 4CompletedSapiom sent the card. Confirm the order with the merchant.
completed
Cancel until your agent pays
POST …/cancel- Request. Your agent sends the merchant, the items and the total, with the user’s key.
- Check. Sapiom checks the purchase against the user’s budget and your spending limits. Without a budget, the user enters their security code on a hosted page. Your agent follows
nextActionuntil the purchase ispayment_ready. - Pay. Your agent fills checkout with a placeholder card. Sapiom sends the real card to the merchant’s payment processor.
- Completed. The purchase reads
completed. Confirm the order with the merchant.
Who is involved
Each user’s cards and purchases are visible only with that user’s key.
Start here
First purchase
Make one purchase end to end in the sandbox.
Sandbox
Test cards, a test merchant, and no real money.
Set up your platform
Get your platform key, then a user and a user key for each of your users.
Card data and security
Where the card number goes, and who can see it.