Overview

Merchants can send a request for alternative payment methods (APMs) by including the paymentOption.alternativePaymentMethod class or the apmData class in the request, depending on the type of request.

The tables below list the input parameters for the APMs, grouped into APM Payments and APM Payouts. The tables also list the mandatory buyer details required by the APM providers.

APM Payments

With REST 2.0 integration, includes the paymentOption.alternativePaymentMethod class in the /payment request. With Web SDK 2.0 integration, include the paymentOption.alternativePaymentMethod class in the createPayment() request.

Syntax of the paymentOption.alternativePaymentMethod Class

{
  "paymentOption": {
    "alternativePaymentMethod": {
      "name": "apm name",
      "data": {
        "<<input_parameter1>>": "<<value1>>",
        _"<<input_parameter2>>": "<<value2>>"
      }
    }
  }
}

Example paymentOption.alternativePaymentMethod Class

An example of the paymentOption.alternativePaymentMethod class for a payment using the Bangkok Bank ATM APM (in JSON).

{
  "paymentOption": {
    "alternativePaymentMethod": {
      "name": "ach",
      "data":{
      "accountNumber": "1111111111",
      "routingNumber": "123456789"
      }
    }
  }
}

APM Payments (Deposits) Tables

The tables in this section provide the input parameters for APM payments (deposits), grouped by APM type. Each table includes the following columns:

• APM
  • Display name of the APM.
  • direct/redirect payment flow indicator:
    • direct – Customer stays on the merchant’s site.
    • redirect – Customer is redirected either to Nuvei or to the APM provider.
• Input Name – Name value for the APM.
• Input Parameters – Names for <input_parameterX> in  “<input_parameterX>“: “<valueX>” name-value pairs under alternativePaymentMethod.data class.
• Mandatory Buyer Details – Parameters required by the APM provider that the merchant needs to send in the  buyerDetails, billingDetails, or deviceDetails class.

ACH

ACH APMs require these input parameters when performing APM payments (deposits):

Bank Transfer

Bank Transfer APMs require these input parameters when performing APM payments (deposits):

E-wallet

E-wallet APMs require these input parameters when performing APM payments (deposits):

Real-Time Bank Transfer

Real-Time Bank Transfer APMs require these input parameters when performing APM payments (deposits):

APM Payouts

The tables in this section provide the input parameters for APM payouts (withdrawals), grouped by APM type. Each table includes the following columns:

• APM – Display name of the APM.
• Name – Value for the APM.
• Input Parameters – Names for <input_parameterX> in  “<input_parameterX>“: “<valueX>” name-value pairs under alternativePaymentMethod.data class.
• Mandatory Buyer Details – Parameters required by the APM provider that the merchant needs to send in the  buyerDetails, billingDetails, or deviceDetails class.

Bank Transfer

Bank Transfer APMs require these input parameters when performing APM payouts (withdrawals):

E-wallet

E-wallet APMs require these input parameters when performing APM payouts (withdrawals):