Integration docs
Accept cards without building a processor
Eight HTTP APIs, HASH, processor routing, store plugins, webhooks, and KYC/KYB — written from this codebase. Show a merchant this overview; then send them to processors or plugins.
CARD_MASK is stored. There is no live acquiring, no PCI Level 1 claim, and no real issuer OTP.How merchants go live on this host
- Sign in as the demo merchant
sandbox@mrivory.testand copy your APP_ID + secret from My Profile. - Connect a processor — pick Card processor 1 (local simulator) or an assigned card processor and paste that account’s sandbox keys.
- Enable payment methods — Settings → Payment methods. Wired methods default on. Hosted checkout only collects what you enable. See Payment methods.
- Install a plugin or POST hosted checkout. Shoppers type the card on MrIvory. The cart never holds PAN.
Eight API paths
Hosted checkout
/pgui/jsp/paymentrequest — browser form. Customer types the card here.
Server-to-server
/pgui/services/paymentServices/initiate/payment — JSON sale when you already handle PAN.
Capture (3DS)
/pgui/jsp/capturePayment — finish a sandbox 3DS sale in the browser.
Transaction status
/pgui/services/paymentServices/transactionStatus — sale / refund enquiry before you fulfil.
Refund
/pgui/services/paymentServices/refund/initiate — refund a captured sale.
Payout
Initiate, getStatus (this settles), and fetchBalance on the payout wallet.
| Method | Path | Use |
|---|---|---|
| POST | /pgui/jsp/paymentrequest | Hosted checkout form |
| POST | /pgui/services/paymentServices/initiate/payment | Server-to-server JSON |
| POST | /pgui/jsp/capturePayment | Finish a 3DS sale |
| POST | /pgui/services/paymentServices/transactionStatus | Sale / refund enquiry |
| POST | /pgui/services/paymentServices/refund/initiate | Refund a captured sale |
| POST | /pgui/services/paymentServices/payout/initiate | Start a payout |
| POST | /pgui/services/paymentServices/payout/getStatus | Payout enquiry (settles) |
| POST | /pgui/services/paymentServices/payout/fetchBalance | Payout wallet balance |
Read next
What this sandbox is
Success rule, amounts, currencies, credentials, and what is stored.
How HASH is built
Sort fields, tilde join, lowercase secret, SHA-512 uppercase.
Test cards and demo logins
Visa 3DS, Mastercard capture, decline PAN, and sandbox@mrivory.test.
Merchant tour
Click-through guide to every panel function, plus the shared sandbox login.
Merchant panel map
Where APP_ID, secret, processor keys, and reports live.
Processor plugins
Charge routing, credential precedence, and sandbox env keys.
Payment methods
Enable wired methods after you connect a processor. Hosted checkout respects the toggles.
Store plugins
WooCommerce, Shopify, and other carts — MrIvory APP_ID only.
Webhook shapes
Sale, refund, recurring events, and inbound KYC callbacks.
KYC / KYB
Hosted onboarding and the sandbox provider decision order.
Also in this sandbox
The panel has recurring plans, subscriptions, and KYC onboarding. Those are panel + hosted-checkout flows — there is no separate public REST for recurring or KYC start. Unknown payment-service URLs still return 327.
Not implemented as public APIs: voids, network tokens, Soft POS terminal APIs, wallets, or open banking.