Overview

Merchants can send requests 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 user details required by the APM providers.

APM Payments

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

Syntax of the paymentOption.alternativePaymentMethod Class

{
  "paymentOption": {
    "alternativePaymentMethod": {
      "paymentMethod": "apmgw_<see below>",
      "<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": {
      "paymentMethod": "apmgw_Bangkok_Bank_ATM",
      "elementpay_userName": "John Smith",
      "elementpay_userPhone": "972802457558"
    }
  }
}

The tables below list the input parameters for APM payments (deposits), grouped by APM type. The tables also list the mandatory user details required by the APM providers.

Understanding the APM Payments (Deposits) Tables

• 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.
• paymentMethod, paymentMethodName, or  payment_method value for the APM.
• Input Parameters: Names for <input_parameterX> in  “<input_parameterX>“: “<valueX>” name-value pairs.
  For advanced merchants who submit /addUPOAPM or /editUPOAPM API requests, or addApmUpo() Web SDK requests, send these name-value pairs in the apmData class.
• Input Validation: Input validation or resources for providing valid input values.
• Mandatory User Details: Parameters required by the APM provider that the merchant needs to send in the userDetails class (or in the billingAddress class).

ACH

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

APM	paymentMethod	Input Parameters	Input Validation	Mandatory User Details
Bank Transfer (ACH) direct	apmgw_ACH	AccountNumber	Maximum 17 characters	firstName, lastName
		RoutingNumber	9 digits
Secure Bank Transfer redirect (for the initial deposit)	apmgw_Secure_Bank_Transfer	-	-	firstName, lastName, email, phone, address, city, zip, state, identification
Secure Bank Transfer direct (for the subsequent deposits)	apmgw_Secure_Bank_Transfer	AccountInfo.field6 (This is the value of the PreApprovalId parameter returned by the initial deposit, which was performed in the redirect flow.)	not null, not empty	firstName, lastName, email, phone, address, city, zip, state, identification

Bank Transfer

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

APM	paymentMethod	Input Parameters	Input Validation	Mandatory User Details
Alior Bank redirect	apmgw_Alior_Bank	-	-	firstName, lastName, email
BACS redirect	apmgw_BACS	bacs_bank_id bacs_account_number bacs_sort_code	-	name, email, city
Banco Azteca redirect	apmgw_Banco_Azteca	-	-	name, email, city
Banco do Brasil redirect	apmgw_Banco do Brasil	personal_id	-	firstName, lastName, email, address, city, zip
Banco Falabella redirect	apmgw_Banco Falabella	personal_id	-	firstName, lastName, email
BANCOMAT Pay redirect	apmgw_BancomatPay	bancomatPay_mobileNumber	The format should be +XXXX with a maximum of 20 characters.	firstName, lastName
Bank Millennium redirect	apmgw_Bank_Millennium	-	-	firstName, lastName, email
Bank Pocztowy redirect	apmgw_Bank_Pocztowy	-	-	firstName, lastName, email
BANK REFERENCED redirect	apmgw_BANK_REFERENCED	-	-	-
Bank Transfer redirect	apmgw_BankPayin	-	-	firstName, lastName, email
Banki Spóldzielcze redirect	apmgw_Banki_Sp_ldzielcze	-	-	firstName, lastName, email
Banorte redirect	apmgw_Banorte	personal_id	-	firstName, lastName, email
BCI redirect	apmgw_BCI	personal_id	-	firstName, lastName, email
Bizum redirect	apmgw_Bizum	-	-	firstName, lastName, email, phone
BNP redirect	apmgw_BNP	-	-	firstName, lastName, email
BOS Bank redirect	apmgw_BOS Bank	-	-	firstName, lastName, email
Bradesco redirect	apmgw_Bradesco	personal_id	-	firstName, lastName, email, address, city, zip
Caixa redirect	apmgw_Caixa	personal_id	-	firstName, lastName, email, address, city, zip
Ceska sporitelna redirect	apmgw_Ceska_Sporitelna	-	-	firstName, lastName, email
Citadel redirect	apmgw_Citadel	-	-	-
CoDi-QR redirect	apmgw_CoDi	codi_method=QR	-	firstName, lastName, country, email
CoDi-Push direct	apmgw_CoDi	codi_method=notification codi_phone_number	-	firstName, lastName, country, email
Cross Bank QR redirect	apmgw_Cross_Bank_QR	-	-	-
CSOB redirect	apmgw_CSOB	-	-	firstName, lastName, email
CSOB_SK redirect	apmgw_CSOB_SK	-	-	email
Dragonpay redirect	apmgw_DragonPay	paymentasia_email paymentasia_phone	-	firstName, lastName, email, phone
eNets redirect	apmgw_eNETS			firstName, lastName, email
EPS redirect	apmgw_EPS	payer_name	-	firstName, lastName, email
ERA redirect	apmgw_ERA	-	-	firstName, lastName, email
Finnish Banks redirect	apmgw_Finnish_Banks	finish_bic	Nordea (60) OP-Pohjola (Osuuspankki) (61) Danske (62) Ålandsbanken (64) Handelsbanken (65) S-Pankki (67) Aktia (298) POP Pankki (299) Säästöpankki (300) Oma Säästöpankki (322)	firstName, lastName, email
FIO Banka redirect	apmgw_FIO_Banka	-	-	firstName, lastName, email
Getin redirect	apmgw_Getin	-	-	firstName, lastName, email
IdeaBank redirect	apmgw_IdeaBank	-	-	firstName, lastName, email
IDS redirect	apmgw_IDS	-	-	-
ING redirect	apmgw_ING	-	-	firstName, lastName, email
Inteligo redirect	apmgw_Inteligo	-	-	firstName, lastName, email
Instant Bank Payments redirect	apmgw_Instant_Bank_Payments_SE apmgw_Instant_Bank_Payments_EE apmgw_Instant_Bank_Payments_FI	-	-	-
Instant Bank Transfer redirect	apmgw_Lean	For information about mandatory input parameters and user fields, see the Lean APM Guide.
Interac redirect	apmgw_Interac	-	-	firstName, lastName, ipAddress
Interac Combined redirect	apmgw_Interac_Combined	email	-	firstName, lastName
		mobilePhone	3-digit area code followed by 7-digit local number
Interac DI redirect	apmgw_Interac_DI	interac_deposit_flow_type	redirect – Request for Money offline – e-Transfer	-
Interac eTransfer redirect	apmgw_Interac_eTransfer	email	-	firstName, lastName, ipAddress
		mobilePhone	[3-digit area code] & [7-digit local number]
Interac Instant redirect	apmgw_INTERAC_Instant	interac_instant_email	-	-
Ipko redirect	apmgw_Ipko	-	-	firstName, lastName, email
ITAU redirect	apmgw_ITAU	personal_id	-	firstName, lastName, email, address, city, zip
KBANK_ATM redirect	apmgw_KBANK_ATM	elementpay_userName elementpay_userPhone	-	-
KBANK_Mobile redirect	apmgw_KBANK_Mobile	-	-	-
Khipu redirect	apmgw_Khipu	personal_id	-	firstName, lastName, email
Komercni Banka redirect	apmgw_Komercni_Banka	-	-	firstName, lastName, email
Local Payments Vietnam redirect	apmgw_Local_Payments_Vietnam	paymentasia_phone paymentasia_email	-	firstName, lastName, email, phone
MazoomaOBT redirect	apmgw_MazoomaOBT	-	-	firstName, lastName, address, state, zip
mBank redirect	apmgw_mBank	-	-	firstName, lastName, email
mBank_PL redirect	apmgw_mBank_PL	-	-	firstName, lastName, email
mBank_SK redirect	apmgw_mBank_SK	-	-	firstName, lastName, email
Moneta Money Bank redirect	apmgw_Moneta Money Bank	-	-	firstName, lastName, email
MyBank redirect	apmgw_MyBank	payer_name	-	firstName, lastName, email
NestBank redirect	apmgw_NestBank	-	-	firstName, lastName, email
Netbanking by Astropay redirect	apmgw_NetbankingbyAstropay	-	-	-
Netbanking redirect	apmgw_Netbanking	netbanking_bankCode	[there is a full list of banks and their codes]	firstName, email, phone, ipAddress
Netbanking_TW redirect	apmgw_Netbanking_TW	netbankingtw_ssn (optional)	-	firstName, lastName, email, phone, city, zip, street, country, state
Noble redirect	apmgw_Noble	-	-	firstName, lastName, email
NPP redirect	apmgw_NPP	-	-	firstName, lastName, country, email
Online Bank Transfer redirect	apmgw_Online_Bank_Transfer	bankTransfer_bank_id, bankTransfer_iban, bankTransfer_account_number, bankTransfer_sort_code	-	firstName, lastName, email, address, zip, city
Online Banking Thailand redirect	apmgw_Online_Banking_Thailand	obt_bank	For valid values, submit a /getMerchantPaymentMethods or getApms() request.	firstName, lastName, email, phone
PayRetailers redirect	apmgw_PayRetailers	-	-	-
PayU redirect	apmgw_PayU	-	-	firstName, lastName, email
PBSBank redirect	apmgw_PBSBank	-	-	firstName, lastName, email
Pekao redirect	apmgw_Pekao	-	-	firstName, lastName, email
PIX redirect	apmgw_PIX	personalId	-	firstName, lastName, email, address, city, zip, phone
PlusBank redirect	apmgw_PlusBank	-	-	-
Postova Banka redirect	apmgw_Postova_Banka	-	-	firstName, lastName, email
Postovni_Sporitelna redirect	apmgw_Postovni_Sporitelna	-	-	firstName, lastName, email
Przelew bankowy redirect	apmgw_Przelew bankowy	-	-	firstName, lastName, email
PSE redirect	apmgw_PSE	personal_id	-	firstName, lastName, email
PSE_PZ redirect	apmgw_PSE_PZ	paymentez_userName paymentez_userType paymentez_userFisNumber paymentez_fiscalNumber paymentez_email paymentez_bankCode	paymentez_userType:    N: persona natural    J: persona jurídica paymentez_userFisNumber:    https://paymentez.github.io/api-doc/#payment-methods-bank-transfer-carriers-fiscal-number-types	phone, address, city, zip
Raiffeisenbank redirect	apmgw_Raiffeisenbank	-	-	firstName, lastName, email
Safetypay redirect	apmgw_Safetypay	-	-	firstName, lastName, email
Safetypay-Online redirect	apmgw_SafetyPay_Online	safetyPay_personalId safetyPay_bankId	-	email, ipAddress, name
Santander Rio redirect	apmgw_Santander_Rio	personal_id	-	firstName, lastName, email
Santander redirect	apmgw_Santander	personal_id	-	firstName, lastName, email
Santander_CL redirect	apmgw_Santander_CL	personal_id	-	firstName, lastName, email
Santander_MX redirect	apmgw_Santander_MX	personal_id	-	firstName, lastName, email
Santander_PL redirect	apmgw_Santander_PL	-	-	firstName, lastName, email
Sberbank redirect	apmgw_Sberbank	-	-	firstName, lastName, email
SCB_ATM redirect	apmgw_SCB_ATM	elementpay_userName elementpay_userPhone	-	-
SCB_Bank_Mobile redirect	apmgw_SCB_Bank_Mobile	-	-	-
SCB_Easy_Pay redirect	apmgw_SCB_Easy_Pay	-	-	-
Sepa redirect	apmgw_Sepa	verification_email iban	^[a-zA-Z0-9_.@-]*$	firstName, lastName, email
Slovenska sporitelna redirect	apmgw_Slovenska_sporitelna	-	-	firstName, lastName, email
Swish redirect	apmgw_Swish	IBP_national_id	-	-
Tatra banka redirect	apmgw_Tatra_Banka	-	-	firstName, lastName, email
T-Mobile redirect	apmgw_T-Mobile	-	-	firstName, lastName, email
Tpay redirect	apmgw_Tpay	-	-	-
Trustly-DI redirect	apmgw_Trustly_DI	-	-	firstName, lastName, email, dateOfBirth
UniCredit redirect	apmgw_UniCredit	-	-	firstName, lastName, email
Unicredit Bank SK redirect	apmgw_Unicredit_Bank_SK	-	-	firstName, lastName, email
UnionPay redirect	apmgw_UnionPay	-	-	firstName, lastName, email
VIP Preferred SDK redirect	apmgw_VIP_Preferred_SDK	-	-	firstName, lastName, address, phone, city, state, zip, country, dateOfBirth, email, identification, identificationType
Vseobecna uverova banka redirect	apmgw_Vseobecna_uverova_Banka	-	-	firstName, lastName, email

Buy Now, Pay Later (BNPL)

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

APM	paymentMethod	Input Parameters	Input Validation	Mandatory User Details
Afterpay redirect	apmgw_Afterpay	-	-	firstName, lastName, email, address, city, zip, state, country
Clearpay redirect	apmgw_Clearpay	-	-	firstName, lastName, email, address, city, zip, state, country
Klarna redirect	apmgw_Klarna	-	-	firstName, lastName, email, address, city, zip, dateOfBirth, ipAddress, phone, state
Riverty redirect	apmgw_Riverty	-	-	Varies according to country. See the Riverty APM Guide.

Cards

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

APM	paymentMethod	Input Parameters	Input Validation	Mandatory User Details
Clave redirect	apmgw_Clave	-	-	email
PostFinance Card redirect	apmgw_PostFinance_Card	-	-	-
South Korea LocalCards redirect	apmgw_South_Korea_LocalCards	card_brand	Only these Issuer ID values are accepted.	billingAddress.firstName, billingAddress.lastName, billingAddress.address, billingAddress.email, billingAddress.phone, billingAddress.city, billingAddress.country, billingAddress.zip, billingAddress.state
UnionPay redirect	apmgw_UnionPay	-	-	firstName, lastName, email

Cash Payment

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

APM	paymentMethod	Input Parameters	Input Validation	Mandatory User Details
Banco Nacional redirect	apmgw_Banco_Nacional	-	-	firstName, lastName, email
BCP redirect	apmgw_BCP	personal_id	-	firstName, lastName, email
BOLETO redirect	apmgw_BOLETO	personal_id	-	firstName, lastName, email, address, city, zip, phone
BOLETO_RAPIDO redirect	apmgw_BOLETO_RAPIDO	personal_id	-	firstName, lastName, email, address, city, zip, phone
COBRO_EXPRESS redirect	apmgw_COBRO_EXPRESS	-	-	-
Davivienda redirect	apmgw_Davivienda	personal_id	-	firstName, lastName, email, address, city, zip
EasyPay redirect	apmgw_EasyPay	-	-	firstName, lastName, email, address
Efecty redirect	apmgw_Efecty	efecty_personal_id	-	firstName, lastName, email, address
Exito redirect	apmgw_exito	-	-	firstName, lastName, email
Konbini redirect	apmgw_Konbini	-	-	-
MULTICAJA redirect	apmgw_MULTICAJA	-	-	-
Others Cash MX redirect	apmgw_Others_Cash_MX	-	-	-
OXXO redirect	apmgw_Oxxo	personal_id	-	firstName, lastName, email
OXXO PAY redirect	apmgw_OXXO_PAY	-	-	firstName, lastName, email, phone
PagoEfectivo redirect	apmgw_Pago_Efectivo	personal_id	-	firstName, lastName, email
PagoFacil redirect	apmgw_PagoFacil	personal_id	-	-
Pay by Cash redirect	apmgw_Paybycash apmgw_Paybycash_OpenAmount	-	-	-
PayCash redirect	apmgw_PayCash	-	-	email
PaySafeCash redirect	apmgw_PaySafeCash	-	-	-
PuntoRed redirect	apmgw_PuntoRed	personal_id	-	firstName, lastName, email, address
Redcompra redirect	apmgw_Redcompra	-	-	-
SafetyPay-Cash redirect	apmgw_SafetyPay_Cash	safetyPay_personalId	-	email, ipAddress, name
Sencillito redirect	apmgw_Sencillito	sencillito_personal_id	-	firstName, lastName, email, address
Su Red (OTHERS CASH) redirect	apmgw_Su Red (OTHERS CASH)	-	-	-
Western Union Panama redirect	apmgw_Western_Union_Panama	-	-	firstName, lastName, email

Cash Payment, Bank Transfer

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

APM	paymentMethod	Input Parameters	Input Validation	Mandatory User Details
2C2P APMs redirect	apmgw_2C2P_APMs	-	-	-
LATAM local payment redirect	apmgw_Astropay_TEF	-	-	-
Local_Payments redirect	apmgw_Local_Payments	-	-	-
Local Payments Indonesia redirect	apmgw_Local_Payments_Indonesia	paymentasia_phone paymentasia_email	-	firstName, lastName, email, phone
MTCPay redirect	apmgw_MTCPay	-	-	firstName, lastName, email

E-wallet

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

APM	paymentMethod	Input Parameters	Input Validation	Mandatory User Details
Aircash redirect	apmgw_Aircash	-	-	-
Airtel Money redirect	apmgw_Airtel_Money	-	-	firstName, email, phone
AliPay Barcode direct	apmgw_AliPay_Barcode	BuyerIdentityCode	Alipay user identifier (a dynamic code (16 to 24 digits)). Starts with 25, 26, 27, 28, 29, or 30. Must be read from the user's Alipay wallet in real time.
AliPay HK redirect	apmgw_AlipayHK	-	-	firstName, lastName, email, phone
AliPay Transaction-QR redirect	apmgw_AliPay_POS_DI	-	-	-
Alipay redirect	apmgw_Alipay	-	-	email
Alipay redirect	apmgw_AliPay_DI	-	-	-
AstroPay (One Touch) redirect	apmgw_AstroPay	-	-	-
Boost redirect	apmgw_BOOST	-	-	-
Dana redirect	apmgw_Dana	-	-	firstName, lastName, email, phone
Daviplata redirect	apmgw_Daviplata	daviplata_typeFiscalNumber daviplata_fiscalNumber	daviplata_typeFiscalNumber: https://paymentez.github.io/api-doc/#payment-methods-bank-transfer-carriers-fiscal-number-types	email
DuitNow redirect	apmgw_DuitNow	-	-	-
Epay.bg redirect	apmgw_Epay_bg	-	-	email
Freecharge redirect	apmgw_FreeCharge	-	-	firstName, email, phone
GCash redirect	apmgw_Gcash	-	-	firstName, lastName, email, phone
GoPay redirect	apmgw_GoPay	-	-	firstName, lastName, email
Grabpay redirect	apmgw_Grabpay	-	-	firstName, lastName, email
GrabPay redirect	apmgw_Grabpay_Malaysia	-	-	-
HiPay redirect	apmgw_HiPay	-	-	email, ipAddress
InstaDebit redirect	apmgw_InstaDebit	-	-	email
JioMoney redirect	apmgw_JioMoney	-	-	firstName, email, phone
Kakao Pay redirect	apmgw_KaKaoPay	-	-	firstName, lastName, email, phone OR billingAddress.firstName, billingAddress.lastName, billingAddress.address, billingAddress.email, billingAddress.phone, billingAddress.city, billingAddress.country, billingAddress.zip, billingAddress.state
L.pay redirect	apmgw_Lpay	-	-	billingAddress.firstName, billingAddress.lastName, billingAddress.address, billingAddress.email, billingAddress.phone, billingAddress.city, billingAddress.country, billingAddress.zip, billingAddress.state
LinkAja redirect	apmgw_LinkAja	-	-	-
Local Payments Indonesia redirect	apmgw_Local_Payments_Indonesia	paymentasia_phone paymentasia_email	-	firstName, lastName, email, phone
Mach redirect	apmgw_Mach	personal_id	-	firstName, lastName, email
MercadoPago redirect	apmgw_MercadoPago	mercado_personalId, mercado_email	-	firstName, lastName, email
MobilePay redirect	apmgw_MobilePay	-	-	firstName, lastName, email, country
MuchBetter direct	apmgw_MuchBetter	mobilePhone	international, no leading 00 or +	-
Nequi redirect	apmgw_NEQUI_CO	nequi_phone_number - must consist of 10 numbers nequi_method - "qr" or "notification"		email
Neteller redirect	apmgw_Neteller	nettelerAccount	^[A-Za-z0-9-_.+%]+@[A-Za-z0-9-.]+.[A-Za-z]{2,4}$|^\d*$	-
Ovo redirect	apmgw_OVO	-	-	-
PayNow redirect	apmgw_PayNow	-	-	-
Pay TM redirect	apmgw_Paytm	SocialSecurityNumber	^[a-zA-Z0-9-]{10}$	-
Pay Zapp redirect	apmgw_Pay_Zapp	-	-	firstName, email, phone
Pay4Fun redirect	apmgw_Pay4Fun	pay4fun_account_email pay4funId	-	-
Payco redirect	apmgw_PAYCO	-	-	billingAddress.firstName, billingAddress.lastName, billingAddress.address, billingAddress.email, billingAddress.phone, billingAddress.city, billingAddress.country, billingAddress.zip, billingAddress.state
PayPal redirect	apmgw_expresscheckout	-	-	-
Paytm redirect	apmgw_Paytm	-	-	firstName, email, phone
payWithCrypto redirect	apmgw_PayWithCrypto	-	-	-
Payz redirect	apmgw_ecoPayz	account_id	-	-
Phonepe redirect	apmgw_Phonepe	-	-	firstName, email, phone
QR Redeban redirect	apmgw_QR_Redeban	-	-	email
QRIS redirect	apmgw_QRIS	-	-	-
Samsung Pay redirect	apmgw_Samsung_Pay	-	-	billingAddress.firstName, billingAddress.lastName, billingAddress.address, billingAddress.email, billingAddress.phone, billingAddress.city, billingAddress.country, billingAddress.zip, billingAddress.state
Satispay redirect	apmgw_Satispay	-	-	firstName, lastName
Shopee Pay ID redirect	apmgw_Shopee_Pay	-	-	-
Shopee Pay Wallet redirect	apmgw_Shopee_Pay_Wallet	-	-	-
Skrill redirect	apmgw_MoneyBookers	account_id	-	-
SSGPAY redirect	apmgw_SSG_Pay	-	-	billingAddress.firstName, billingAddress.lastName, billingAddress.address, billingAddress.email, billingAddress.phone, billingAddress.city, billingAddress.country, billingAddress.zip, billingAddress.state
Todito Cash (Direct Integration) direct	apmgw_Todito_Cash_Direct_Integration_	toditocash_card_number, toditocash_pin_code	^[0-9]{10}$, ^[0-9]{4}$	-
Toss Payments redirect	apmgw_Toss	-	-	billingAddress.firstName, billingAddress.lastName, billingAddress.address, billingAddress.email, billingAddress.phone, billingAddress.city, billingAddress.country, billingAddress.zip, billingAddress.state
Touch 'n Go redirect	apmgw_TouchnGo	-	-	firstName, lastName, email, phone
TrueMoney redirect	apmgw_Truemoney	-	-	firstName, lastName, email, phone
TWINT redirect	apmgw_TWINT	-	-	-
UPI redirect	apmgw_UPI	upi_ssn (optional)	-	firstName, lastName, email, phone, city, zip, street, country, state
WeBanq direct	apmgw_WeBanq	account_id, account_password	-	-
WeChat_OfficialAccount redirect	apmgw_WeChat_OfficialAccount	-	-	-
WeChat_QuickPay direct	apmgw_WeChat_QuickPay	wechat_quickpay_auth_code	-	-
ZaloPay redirect	apmgw_ZaloPay	-	-	email

Local Payment Card

Local Payment Card APMs require these input parameters when performing APM payments (deposits):

APM	paymentMethod	Input Parameters	Input Validation	Mandatory User Details
BBVA redirect	apmgw_BBVA	personal_id	-	firstName, lastName, email
Mastercard by Astropay redirect	apmgw_MCByAstropay	-	-	-
Visa by Astropay redirect	apmgw_VisaByAstropay	-	-	-

Local Payments

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

APM	paymentMethod	Input Parameters	Input Validation	Mandatory User Details
Local Payments Africa redirect	apmgw_Local_payments_Africa	-	-	firstName, lastName, email, phone

Mobile Payments

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

APM	paymentMethod	Input Parameters	Input Validation	Mandatory User Details
Boku redirect	apmgw_Boku	-	-	-
Fonix redirect	apmgw_Fonix	phoneNumber	If the phone number starts with "7", then only 10 digits are allowed. If the phone number starts with "0", 11 digits are allowed, but the second digit must be "7".	-
MuchBetter direct	apmgw_MuchBetter	mobilePhone	international, no leading 00 or +	-
Nequi redirect	apmgw_Nequi	-	-	firstName, lastName, email
Skrill One-Tap direct	apmgw_Skrill_One_Tap	recurring_id	-	-
WeChat redirect	apmgw_WeChat	-	-	-

Prepaid

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

APM	paymentMethod	Input Parameters	Input Validation	Mandatory User Details
AstroPay (One Touch) redirect	apmgw_AstroPay	-	-	-
BanContact redirect	apmgw_BanContact	-	-	firstName, lastName, email
NeoSurf(Direct-Integration) redirect	apmgw_NeoSurf_Direct_Integration_	-	-	-
NeoSurf_CA(Direct-Integration) redirect	apmgw_NeoSurf_CA_Direct_Integration_	-	-	-
NeoSurf_UK(Direct-Integration) redirect	apmgw_NeoSurf_UK_Direct_Integration_	-	-	-
PaySafeCard redirect	apmgw_PaySafeCard	-	-	-

Real-Time Bank Transfer

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

APM	paymentMethod	Input Parameters	Input Validation	Mandatory User Details
Banco BICE redirect	apmgw_Banco BICE	personal_id	-	firstName, lastName, email
Banco de Chile redirect	apmgw_Banco de Chile	personal_id	-	firstName, lastName, email
Banco CrediChile redirect	apmgw_Banco CrediChile	personal_id	-	firstName, lastName, email
Banco Estado redirect	apmgw_Banco Estado	personal_id	-	firstName, lastName, email
Banco Security redirect	apmgw_Banco Security	personal_id	-	firstName, lastName, email
Bangkok Bank ATM redirect	apmgw_Bangkok_Bank_ATM	elementpay_userName elementpay_userPhone	-	-
Bangkok Bank iPay redirect	apmgw_Bangkok_Bank_iPay	-	-	-
Bangkok Bank Mobile Banking redirect	apmgw_Bangkok_Bank_Mobile	-	-	-
BBVA Bancomer redirect	apmgw_BBVA Bancomer	personal_id	-	firstName, lastName, email
BLIK direct	apmgw_BLIK	blik_code	-	-
BLIK_Redirect redirect	apmgw_BLIK_Redirect	-	-	firstName, lastName, email
EFT Payments redirect	apmgw_Instant_Bank_Transfer	-	-	firstName, lastName, address, city, state, zip, country, phone
iDeal redirect	apmgw_iDeal	BIC	List of accepted bank names	firstName, lastName, email, country
iDebit redirect	apmgw_iDebit	-	-	-
Instant Open Banking redirect	apmgw_Instant_Open_Banking	instantOb_bankId	Only bank IDs linked to apmgw_Instant_Open_Banking. For details, see the Collecting Payment Details topic.
		ob_iban (or ob_account_number (and ob_sort_code (for UK)))	ob_iban or ob_account_number is only required if specified by the bank. For details, see "mandatoryFields" in the Collecting Payment Details topic.
Interac Combined redirect	apmgw_Interac_Combined	email	-	firstName, lastName
		mobilePhone	3-digit area code followed by 7-digit local number
Interac Instant redirect	apmgw_INTERAC_Instant	interac_instant_email	-	-
Klarna Pay Now redirect	apmgw_Sofort	-	-	firstName, lastName, email, country
MB WAY direct	apmgw_MBWAY	mbWay_mobilePhone	<international code>#<mobile phone number>	-
MULTIBANCO redirect	apmgw_MULTIBANCO	-	-	firstName, lastName, email
Nuvei Instant Bank Transfer (IBT) redirect	apmgw_eCheckSelect	-	-	firstName, lastName, address, city, state, zip, dateOfBirth
Open Banking redirect	apmgw_Open_Banking	ob_bank_id	Only bank IDs linked to apmgw_Open_Banking. For details, see the Collecting Payment Details topic.	firstName, lastName
		ob_iban (or ob_account_number (and ob_sort_code (for UK)))	ob_iban or ob_account_number is only required if specified by the bank. For details, see "mandatoryFields" in the Collecting Payment Details topic.
Pay with Bank Transfer redirect	apmgw_PayWithBankTransfer	-	-	country must be "GB", shippingAddress class is mandatory for ecommerce goods merchants
PayNearMe redirect	apmgw_PayNearMe	-	-	firstName lastName phone (exactly 10 digits) dateOfBirth
POLI redirect	apmgw_POLI	-	-	firstName, lastName, email
Przelewy24 redirect	apmgw_P24	email (not required when provided in user details)	-	firstName, lastName, email
Skrill Rapid Transfer redirect	apmgw_Skrill_RapidTransfer	-	-	country
SPEI redirect	apmgw_SPEI	amount	Must be greater than 0 (zero)	-
STPmex redirect	apmgw_STPmex	amount	Must be 0 (zero)	-
Webpay redirect	apmgw_Webpay	webpay_personal_id	-	firstName, lastName, email, address, city, zip

Voucher

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

APM	paymentMethod	Input Parameters	Input Validation	Mandatory User Details
ABON direct	apmgw_Abon	abon_voucherNumber	16-digit voucher number	-
		abon_userPhone (conditionally)	Phone number must be in MSISDN format (3-digit area code, followed by 2-digit operator number, followed by 7-digit local number).	-
CASHlib redirect	apmgw_CASHlib_	-	-	firstName, lastName, dateOfBirth, ipAddress
CryptoGO redirect	apmgw_CryptoGO	-	-	firstName, lastName, email, address, dateOfBirth, ipAddress
KwickGO redirect	apmgw_KwickGO	-	-	firstName, lastName, email, address, zip, dateOfBirth, ipAddress
OKTOCash redirect	apmgw_OKTO_CASH	-	-	-
OnShop redirect	apmgw_OnShop	-	-	-
PassNGO redirect	apmgw_PassNGO	-	-	firstName, lastName, email, address, zip, dateOfBirth, ipAddress

APM Payouts

For advanced merchants who submit /addUPOAPM or /editUPOAPM API requests, or addApmUpo() Web SDK requests, send these name-value pairs in the apmData class.

Syntax of the apmData Class

{
  "apmData": {
    "paymentMethod": "apmgw_<see below>",
    "<input_parameter1>": "<value1>",
    "<input_parameter2>": "<value2>"
    . . .
  }
}

The tables below list the input parameters for APM payouts (withdrawals), grouped by APM type. The tables also list the mandatory user details required by the APM providers.

Understanding the APM Payouts (Withdrawals) Tables

• APM: Display name of the APM.
• paymentMethodName value for the APM.
• Input Parameters: Names for <input_parameterX> in the  “<input_parameterX>“: “<valueX>” name-value pairs.
• Input Validation: Input validation or resources for providing valid input values.
• Mandatory User Details: Parameters required by the APM provider that the merchant needs to send in the userDetails class (or in the billingAddress class). For more information about the userDetails class for /payout REST API requests, see Payouts.

Bank Transfer

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

APM	paymentMethodName	Input Parameters	Input Validation	Mandatory User Details
Banco Azteca redirect	apmgw_Banco_Azteca	-	-	name, email, city
Bank Payouts	apmgw_Local_Payouts	firstName, lastName, birthdate	-	-
Bank Transfer (ACH)	apmgw_ACH	AccountNumber	Maximum 17 characters	firstName, lastName, email
		RoutingNumber	9 digits
Citadel	apmgw_Citadel	citadel_holder_name citadel_iban citadel_swift_code citadel_bank_city citadel_bank_name citadel_account_numberCA citadel_account_numberAU citadel_branch_codeCA citadel_bank_codeCA citadel_branch_codeAU citadel_ibanMX	-	-
Colombia Payouts	apmgw_Colombia_Payouts	co_account_number	Cannot be empty; only digits are allowed.	email
		co_account_bank_code	-
		co_account_type	-
		co_account_identification	Cannot be empty; only digits are allowed.
		co_account_identification_type	-
eCashout	apmgw_Express_Connect	accountNumber	up to 12 digits	firstName, lastName, ipAddress
		institutionNumber	3-digit institution number
		transitNumber	5-digit transit number
iDeal	apmgw_iDeal	A payout can only be performed after userTokenId and userPaymentOptionId were generated from a previous payment transaction.
iDebit	apmgw_iDebit	A payout can only be performed after userTokenId and userPaymentOptionId were generated from a previous payment transaction.
IDS	apmgw_IDS	transactworld_bankIfsc	^[a-zA-Z]{4}[0][a-zA-Z0-9]{6}$	-
		transactworld_accountNumber	numeric, 0-35 symbols	-
Instant Bank Payments	apmgw_Instant_Bank_Payments_SE apmgw_Instant_Bank_Payments_DK apmgw_Instant_Bank_Payments_EE apmgw_Instant_Bank_Payments_FI	-	-	-
Interac DI	apmgw_Interac_DI	interac_email, interac_question, interac_answer	-	-
Interac eTransfer	apmgw_Interac_eTransfer	email	-	firstName, lastName, ipAddress
		mobilePhone	3-digit area code followed by 7-digit local number.
Interac Instant	apmgw_INTERAC_Instant	interac_instant_email	-	-
		interac_instant_phone	For Canadian numbers: 10-digits, without country code	-
		interac_instant_security_question	-	-
		interac_instant_security_answer	-	-
Malaysia Bank Payouts	apmgw_2C2P_PayoutService	payout2c2p_beneficiaryName, payout2c2p_beneficiaryAccountNo, payout2c2p_beneficiaryBankName, payout2c2p_beneficiaryBankCode	-	-
NPP	apmgw_NPP	npp_payout_type: "559", npp_account_name, npp_bankStateBranch_number, npp_account_number OR npp_payout_type: "560", npp_account_name, npp_pay_id, npp_pay_id_type	-	-
Online Bank Transfer	apmgw_Online_Bank_Transfer	bankTransfer_bank_id, bankTransfer_iban, bankTransfer_account_number, bankTransfer_sort_code	-	firstName, lastName, email, address, zip, city
Open Banking	apmgw_Open_Banking	A payout can only be performed after userTokenId and userPaymentOptionId were generated from a previous payment transaction.
payWithCrypto	apmgw_PayWithCrypto	coindirect_ cryptoAddress coindirect_ cryptoCurrency	-	-
PIX	apmgw_PIX	personalId pix_key	-	Press here to see additional mandatory parameters for payouts with bank detail verification.
PIX Payouts	apmgw_PIX_payouts	pix_accountNum	Up to 100 characters	email
SEPA Payouts	apmgw_SEPA_Payouts	IBAN	-	firstName, lastName, email Press here to see additional mandatory parameters for instant SEPA payouts.
Skrill-RapidTransfer	apmgw_Skrill_RapidTransfer	wd_transaction_bank_id	-	-
Swish	apmgw_Swish	-	-	-
Verified SEPA Payouts	apmgw_Verified_SEPA_Payouts	-	-	firstName, lastName, email Press here to see additional mandatory parameters for Verified SEPA Payouts.
VIP Preferred	apmgw_VIP_Preferred	userPaymentOptionId, userTokenId	-	-
VIP Preferred SDK	apmgw_VIP_Preferred_SDK	-	-	firstName, lastName, address, phone, city, state, zip, country, dateOfBirth, email, identification, identificationType
WeBanq	apmgw_WeBanq	account_id	-	-

Cash

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

APM	paymentMethodName	Input Parameters	Input Validation	Mandatory User Details
OXXO_PAY	apmgw_OXXO_PAY	-	-	email, phone
Efecty	apmgw_Efecty	efecty_personal_id	-	country, email

E-wallet

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

APM	paymentMethodName	Input Parameters	Input Validation	Mandatory User Details
Aircash	apmgw_Aircash	Aircash_phone	The country code (without+) and the number. (for example: 385981234567)
Payz	apmgw_ecoPayz	account_id	1000000000-2147483647	-
MuchBetter	apmgw_MuchBetter	mobilePhone	International, no leading 00 or +	-
Nequi	apmgw_NEQUI_CO	nequi_phone_number	Must consist of 10 numbers	email
Neteller	apmgw_Neteller	A payout can only be performed after userTokenId and userPaymentOptionId were generated from a previous payment transaction.
Pay4Fun direct	apmgw_Pay4Fun	pay4fun_account_email pay4funId	-	-
PayPal	apmgw_expresscheckout	A payout can only be performed after userTokenId and userPaymentOptionId were generated from a previous payment transaction.
Efectivo	apmgw_PESPay	pes_personal_id	-	email
Play+	apmgw_PlayPlus	userPaymentOptionId, userTokenId	-	-
		RoutingNumber	Up to 9 digits
Skrill	apmgw_MoneyBookers	A payout can only be performed after userTokenId and userPaymentOptionId were generated from a previous payment transaction.
Skrill One-Tap	apmgw_Skrill_One_Tap	email	-	-

Prepaid

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

APM	paymentMethodName	Input Parameters	Input Validation	Mandatory User Details
AstroPay (One Touch)	apmgw_AstroPay	astropay_phone	User mobile number including country calling code, and no preceding "+".	-
PaySafeCard	apmgw_PaySafeCard	account_id wd_pay_safe_first_name wd_pay_safe_last_name wd_pay_safe_birthdate	-	email

Real-Time Bank Transfer

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

APM	paymentMethodName	Input Parameters	Input Validation	Mandatory User Details
Faster Payments	apmgw_Faster_Payments	fasterPayments_iban, fasterPayments_account_number, fasterPayments_sort_code	-	firstName, lastName, email In addition, the following parameters are mandatory to minimize transactions held by the RFI process: dateOfBirth address (for example: 1 Hardwick Street) city zip
P24	apmgw_P24	p24_iban	-	firstName, lastName, email, address, city, zip
Verified Faster Payments	apmgw_Verified_Faster_Payments	-	-	firstName, lastName, email Press here to see additional mandatory parameters for Verified Faster Payments.

Appendix

South Korea LocalCard Brands

Issuer ID	Issuer Name
536	Gwangju
537	Shinhan
538	Samsung
539	Hyundai
540	Lotte
541	Suhyup
542	Citi
543	NH
544	Jeonbuk
545	Jeju
546	Hana
547	Kookmin
548	Woori
549	KEB
550	BC