Exirom Payment API Documentation

Payment Method Identifier: ARS | Payment Type: BANK_TRANSFER

ARS is an Argentine bank-transfer payment method. It is available for ARS payments through POST /api/v1/payments/apm.

#Request Payload

#Request Fields

Field	Type	Required	Description
`paymentMethod`	String	Yes	Must be `ARS`
`paymentType`	String	Yes	Must be `BANK_TRANSFER`
`customerDocument`	String	Yes	Customer DNI or CUIT; 7, 8, or 11 digits

{
  "paymentMethod": "ARS",
  "paymentType": "BANK_TRANSFER",
  "customerDocument": "12345678"
}

#Direct Response

When the transfer details are ready, apmResponseData.actionType is REFERENCE. Read the receiving CVU from the entry whose key is receiverCvu. Payment instructions are available in English (en) and Spanish (es) through customerInstructionsByLanguage.

{
  "paymentMethod": "ARS",
  "paymentType": "BANK_TRANSFER",
  "actionType": "REFERENCE",
  "providerTransactionId": "ars-order-123456",
  "references": [
    {
      "key": "receiverCvu",
      "label": "CVU",
      "value": "0000000000000000000000"
    }
  ],
  "customerInstructionsByLanguage": {
    "en": "## How to pay\n\n1. Copy the CVU.\n2. Open your bank or payment app, select **Transfer**, and paste the copied CVU as the recipient account.\n3. Enter the displayed amount and confirm the transfer.\n\nYou’ll be redirected back to the merchant as soon as we receive your payment.",
    "es": "## Cómo pagar\n\n1. Copia la CVU.\n2. Abre tu aplicación bancaria o de pagos, selecciona **Transferir** y pega la CVU copiada como cuenta de destino.\n3. Ingresa el importe que se muestra y confirma la transferencia.\n\nVolverás automáticamente al sitio del comercio en cuanto recibamos tu pago."
  }
}

#Response Fields

Field	Type	Description
`paymentMethod`	Enum	Always `ARS`
`paymentType`	Enum	Always `BANK_TRANSFER`
`actionType`	Enum	`REFERENCE` when bank-transfer details are ready
`providerTransactionId`	String	Provider transaction identifier, when available
`references`	Array	Transfer details; read the receiving CVU from `receiverCvu`
`customerInstructionsByLanguage`	Object	Markdown instructions keyed by language: `en` (English), `es` (Spanish)

Show the selected language, falling back to English and then the first available translation. When the map is absent or empty, omit the instructions block. Render Markdown safely with raw HTML disabled. The hosted checkout offers language selection for payment instructions only; payment details and other checkout labels do not change.

The transaction remains in CUSTOMER_VERIFICATION while the customer completes the transfer.

#Internal Redirect Response

If the internal APM redirect flow is required first, the initial response has actionType: REDIRECTION. Redirect the customer to redirectUrl to continue the same transaction.

{
  "paymentMethod": "ARS",
  "paymentType": "BANK_TRANSFER",
  "actionType": "REDIRECTION",
  "redirectUrl": "https://checkout.example.com/?token=...",
  "providerTransactionId": "ars-order-123456"
}

#See Also

APM Payment API — Full request and response schema
Payment Flow — End-to-end payment handling
ARS Payout Payload — ARS payout fields