apmPayload References

This document provides a complete reference of all payment methods and payment types supported by the Exirom APM API. Use the paymentMethod and paymentType fields in your apmPayload when initiating transactions.

All APM transactions use the same endpoint (POST /api/v1/payments/apm). The apmPayload object varies per payment method — see Initiating a Payment for the full request structure.

#Smart Routing Methods

Smart methods automatically route to the best provider based on the user’s country, currency, device, and merchant configuration. Use these when you want Exirom to handle provider selection.

{
  "paymentMethod": "SMART_APM",
  "paymentType": "E_WALLET"
}

{
  "paymentMethod": "SMART_BANK_TRANSFER",
  "paymentType": "BANK_TRANSFER",
  "accountHolderName": "Hans Müller",
  "iban": "DE89370400440532013000",
  "bic": "COBADEFFXXX"
}

{
  "paymentMethod": "SMART_CARRIER_BILLING",
  "paymentType": "CARRIER_BILLING",
  "msisdn": "+14155552671"
}

{
  "paymentMethod": "SMART_MOBILE_WALLET",
  "paymentType": "MOBILE_WALLET",
  "walletProvider": "google_pay"
}

{
  "paymentMethod": "SMART_VOUCHER",
  "paymentType": "VOUCHER",
  "voucherCode": "VOUCHER-CODE-12345"
}

#E-Wallets

All e-wallet methods use the same minimal payload structure — just paymentMethod and paymentType. The provider page handles authentication and user interaction.

{
  "paymentMethod": "PAYPAL",
  "paymentType": "E_WALLET"
}

#Mobile Wallets

#Bank Transfers & Open Banking

Most bank transfer methods use a minimal payload — just paymentMethod + paymentType. The user is redirected to their bank. For SMART_BANK_TRANSFER, include account details.

{
  "paymentMethod": "IDEAL",
  "paymentType": "BANK_TRANSFER"
}

{
  "paymentMethod": "OPEN_BANKING",
  "paymentType": "BANK_TRANSFER",
  "accountHolderName": "Jane Smith",
  "paymentReference": "ORDER-12345",
  "paymentDescription": "Product purchase"
}

#QR Code Payments

All QR methods use a minimal payload. The response returns actionType: QR with qrData (Base64 PNG) and optionally qrDeepLink.

{
  "paymentMethod": "PIX_QR",
  "paymentType": "E_WALLET"
}

#Carrier Billing

#Hosted Payment Page (HPP) Methods

#Regional / Direct Methods

These methods require specific fields in the apmPayload. Missing required fields will result in a validation error.

#PAPARA (Turkey)

paymentMethod: PAPARA | paymentType: E_WALLET

{
  "paymentMethod": "PAPARA",
  "paymentType": "E_WALLET",
  "username": "customer_username",
  "userID": "12345678",
  "fullname": "Ahmet Yılmaz"
}

#TK Pay EFT (Turkey)

paymentMethod: TK_PAY | paymentType: BANK_TRANSFER

{
  "paymentMethod": "TK_PAY",
  "paymentType": "BANK_TRANSFER",
  "username": "customer_username",
  "userID": "12345678",
  "fullname": "Ahmet Yılmaz"
}

#TK Pay QR (Turkey)

paymentMethod: TK_PAY_QR | paymentType: E_WALLET

{
  "paymentMethod": "TK_PAY_QR",
  "paymentType": "E_WALLET",
  "username": "customer_username",
  "userID": "12345678",
  "fullname": "Ahmet Yılmaz"
}

#TK Pay Payout (Turkey)

paymentMethod: TK_PAY_PAYOUT | paymentType: BANK_TRANSFER

{
  "paymentMethod": "TK_PAY_PAYOUT",
  "paymentType": "BANK_TRANSFER",
  "username": "customer_username",
  "userID": "12345678",
  "fullname": "Ahmet Yılmaz",
  "accountHoldersName": "Ahmet Yılmaz",
  "iban": "TR330006100519786457841326",
  "accountNumber": "519786457841326"
}

#PY Bank Payout

paymentMethod: PY_BANK_PAYOUT | paymentType: BANK_TRANSFER

{
  "paymentMethod": "PY_BANK_PAYOUT",
  "paymentType": "BANK_TRANSFER",
  "bankName": "Banco Continental",
  "bankCode": "006",
  "accountNumber": "1234567890",
  "localCountryCurrencyIso3Code": "PYG",
  "bankAccountHolderName": "Carlos Rodríguez"
}

#PY Bank Pay-in

paymentMethod: PY_BANK_PAYIN | paymentType: BANK_TRANSFER

No additional fields required beyond paymentMethod and paymentType.

#Supported Payment Types (PaymentType)

The paymentType field categorizes how the transaction is processed:

#Smart APM Routing

When using SMART_APM, the platform automatically classifies and routes transactions to the most appropriate smart payment handler based on:

• Market and country of the user
• Currency and payment amount
• User device and payment context
• Merchant configuration and supported providers

Smart methods (prefixed with SMART_) handle provider selection automatically. Use direct methods (e.g., PAYPAL, IDEAL) when you want to specify the exact payment method.

Note: All APM methods use the same POST /api/v1/payments/apm endpoint. The apmPayload object structure varies per payment method. For request/response details, refer to the dedicated guide linked in each method’s row above.