The response provides information about each APM supported by the merchant’s Nuvei account in the specified countryCode, including a fields array.
fields Array Structure in Response
"fields"[
"name" (String, 45),
"type" (String, 45),
"validationMessage"
["language" (String, 2), "message" (String, 400)],
"caption"
["language" (String, 2), "message" (String, 400)],
"listValues" [
"code" (String, 255),
"caption" (String),
"mandatoryFields"
[(String, 45)]
]
]
Response Output Parameters
| Parameter | Description | Examples |
|---|---|---|
| paymentMethod | paymentMethod value for APM. | apmgw_Lean |
| paymentMethod.displayName | Array of text labels for the paymentMethod to use on the payment form. | - |
| paymentMethod.displayName .language | Language code. | en |
| paymentMethod.displayName .message | Text label. | Instant Bank Transfer |
| paymentMethod.countries | Country codes the APM supports. | AE |
| paymentMethod.currencies | Currency codes the APM supports. | AED |
| paymentMethod.logoURL | URL for the paymentMethod logo to use on the payment form. | https://secure.safecharge.com /ppp/resources/img/svg/solid -white/open_banking.svg |
| fields | Array of /payment or createPayment() input parameters for the APM. | - |
| fields.name | Name of input parameter for /payment or createPayment() requests. | lean_bank |
| fields.listValues | Array of valid values for field.name for a dropdown list the merchant presents to the user. | - |
| fields.listValues .code | The value of the input parameter for /payment or createPayment() requests. | MASHREQ_NEO_UAE ADIB_UAE ENBD_UAE |
| fields.listValues .caption | Text the merchant presents to the user in a dropdown list. | Mashreq Neo Bank Abu Dhabi Islamic Bank Emirates NBD |
| fields.listValues .mandatoryFields | Array of fields required for /payment or createPayment() requests. | - |
Example Information for Lean in Response
{
"paymentMethod": "apmgw_Lean",
"paymentMethodDisplayName": [
{
"language": "en",
"message": "Instant Bank Transfer"
}
],
"isDirect": "false",
"countries": [
"AE"
],
"currencies": [
"AED"
],
"logoURL": "https://secure.safecharge.com/ppp/resources/img/svg/solid-white/open_banking.svg",
"fields": [
{
"name": "BankCode",
"type": "text",
"caption": [
{
"language": "en",
"message": "Bank"
}
],
"listValues": [
{
"code": "MASHREQ_NEO_UAE",
"caption": "Mashreq Neo Bank",
"mandatoryFields": []
},
{
"code": "ADIB_UAE",
"caption": "Abu Dhabi Islamic Bank",
"mandatoryFields": []
},
{
"code": "ENBD_UAE",
"caption": "Emirates NBD",
"mandatoryFields": []
}
]
}
],
"openInExternalBrowser": "false"
}
Present the user a payment form containing the list of these APMs. For each APM, use the paymentMethodDisplayName.message for the relevant language and the logoURL.
After the user selects Instant Bank Transfer, present a list of the banks using their listValues.caption values, and a Register button. After the user selects a bank, if there are any mandatoryFields for that bank, collect the mandatory information from the user.