Exirom Payment API Documentation

Track the latest changes to the Exirom Payment Gateway API and documentation.

#October 2026

Flexepin voucher payments — the FLEXEPIN method. The voucher must be in your account currency and is redeemed in full; credit the customer with the callback's processedAmount, which can differ from the requested amount. See Flexepin Payment Payload

Gender and state are now required — PayID identity verification needs kycData.person.gender (MALE, FEMALE or OTHER) and kycData.address.state. A submission without them returns an input error against the field. The hosted verification form asks for both. See PayID Identity Verification
Date of birth on the first PayID payment — a customer's first PayID payment needs apmPayload.dateOfBirth or billingDetails.dateOfBirth (YYYY-MM-DD, customer 18 or older); without it the payment is declined with 62. The hosted payment page asks for it on the first payment only. See PayID Payment Payload
PayID payout recipient type is optional — without apmPayload.recipientType a PayID payout goes to the PayID when payId is sent and to the bank account otherwise. See PayID Payout Payload

PayID payments and payouts — the PAY_ID method. A payment returns the bank details and the payment reference the customer transfers against; a payout pays to a PayID or to an Australian bank account. See Payment / Payout
Identity verification — a payment or payout may return apmResponseData.actionType: KYC_REQUIRED. The hosted payment page handles it on its own; a direct integration submits the customer's data to the new KYC endpoint, with its own form or with the hosted one. See Identity Verification
Verification decline codes — 4034, 4035 and 4036 tell apart a verification that is still required, one under manual review, and one that was rejected

PIX payments and payouts — the PIX_QR method for Brazil. See Payment / Payout
Argentine bank transfers — the ARS method. See Payment / Payout
Internal redirect flow — requireInternalRedirectFlow sends the customer through the hosted checkout before the transaction reaches the provider. See Internal APM Redirect Flow

Hosted Havale pay-ins — the HAVALE_HPP method for TRY bank transfers, with the customer completing the transfer on a hosted page. See HAVALE_HPP Payload

Havale payouts — the HAVALE_PAYOUT method for server-to-server TRY payouts against an account-holder name and IBAN. See Havale Payout Payload

Decline description callback header — callbacks now include decline description details for failed transactions
Rate-limit documentation — added sandbox and production rate limits, including production IP whitelist guidance

5-language code examples — every API endpoint now includes cURL, Python, Node.js, Go, and Kotlin examples
API Playground — interactive sandbox tester on each endpoint page (sandbox environment only)
Environment switcher — toggle between sandbox and production URLs across code examples
Expandable nested objects — Card, BillingDetails, Device objects collapse by default in parameter tables
Copy endpoint URL — one-click copy of the full endpoint URL

Quick Start guides — step-by-step guides for Card payments, APM payments, and Hosted Payment Page
Integration checklist — pre-launch verification list
Idempotency guide — preventing duplicate transactions with requestId
Callback retry guide — webhook retry behavior and best practices
API versioning — version strategy and backwards compatibility

Cmd+K search — full-text search across all docs with keyboard navigation
Dark mode — complete dark theme with localStorage persistence
Decline code navigation — clickable code references with scroll-to and highlight animation
Sticky table headers — parameter table headers stay visible during scroll
Reading time — estimated reading time on every page
Scroll to top — quick return to top on long pages
Keyboard shortcuts — press ? to see all shortcuts

Check this page for the latest changes, or download the OpenAPI spec to see the current API surface.