Load Configuration

Get all information you need to build a dynamic checkout based on merchant configuration

To load the settings of a Sales Location, a technical integrator can call the 'service:getConfig' endpoint in the via the **GMS **(<<glossary:Global Management System>>).

If the GMS is in maintenance no changes can be made, so no syncs need to be performed.

You will receive all relevant configuration information necessary to build a checkout page. With that data and the authentication details you can process payments via the transaction gateway unit, or server2server direct payments endpoints.

An integrator that offers their checkout services to third parties (merchants) can certify for different features.

Try it yourself

Before you start: You need a valid <<glossary:serviceId>> and Secret> or a <<glossary:Merchant Token>> and Secret and the <<glossary:serviceId>>.

🦉 Load getConfig

Payer Checkout Features

Individual integrationThird party integration
getConfigOptionalMandatory
eCommerce gateway checkoutMandatoryMandatory
Point of Sale Terminal transactionOptionalOptional
MOTO card not present transactionOptionalOptional
Send a Paylink (email / sms / manual)OptionalOptional
server2server CARD based paymentsOptionalOptional
Apple Pay & GooglePay button integrationsOptionalOptional
server2server Giftcard RedeemOptionalOptional

Checkout Optimalisation

ActionExplanation
MIN / MAX amounts per payment MethodShow only Payment Methods that are in line with the MIN/MAX amount.
Show + More Country OptimiserShow the Payment Methods & offer the More List.
MandatoryFieldsCheckerCheck pre-checkout the fields that are mandatory based on the selected payment Method
IPFilteringShow or Hide payment methods and handle the exception list.
SortingRank the Payment Methods based on the comma separated list.
MultiLanguageCheckoutChange the names of the Payment Methods based on the selected checkout language
look&feel managerUpdate the look&feel by using the 4 colours & CSS provided stylesheet.

The merchants information.

You get information in blocks. First part you can use to show your client information about the service, merchant and moneyflow. This basic information can be stored in the platform, but isn't necessary to create the payment flow.

{
  "code": "SL-####-####",
  "secret": "secret",
  "testMode": false,
  "name": "mywebshop.nl",
  "translations": {
    "name": {
      "nl_NL": "mywebshop.nl"
    }
  },
  "status": "ACTIVE",
  "merchant": {
    "code": "M-####-####",
    "name": "Company B.V.",
    "status": "ACTIVE"
  },
  "category": {
    "code": "CY-####-####",
    "name": "Beauty en wellness",
  },
  "turnoverGroup": {
    "code": "CT-####-####",
    "name": "Standaard"
  },
  "layout": {
    "code": "LY-####-####",
    "name": "Eigen look & feel",
    "cssUrl": "https://static.pay.nl/layout/LY-####-####/cssfile.css",
    "icon": "",
    "supportingColor": "000000",
    "headerTextColor": "556622",
    "buttonColor": "56EADD",
    "buttonTextColor": "CCCCCC"
  },
  "tradeName": {
    "code": "TM-####-####",
    "name": "TradeName"
  },
}

The checkoutOptions

If you want to make a ~~request ~~to a <<glossary:TGU>> to start a Gateway transaction or use the <<glossary:Direct Payment Processing>> you need the PaymentMethod ID. In some cases you can also bypass the next step (option selection) by sending in the option you prefer via the option list.

 "checkoutOptions": [
    {
      "tag": "PG_2",
      "name": "Debit and Credit cards (EN)",
      "translations": {
        "name": {
          "de_DE": "Credit- & Debitcards (DE)",
          "en_GB": "Debit and Credit cards (EN)",
          "nl_NL": "Credit- & Debitcards (NL)"
        }
      },
      "image": "/payment_method_groups/2.svg",
      "paymentMethods": [
        {
          "id": 706,
          "name": "Visa Mastercard",
          "description": "Make a secure payment by Creditcard",
          "translations": {
            "name": {
              "nl_NL": "Visa Mastercard"
            },
            "description": {
              "nl_NL": "Betaal veilig met uw creditcard"
            }
          },
          "image": "/payment_methods/7.svg",
          "options": [],
          "settings": [],
          "minAmount": 0,
          "maxAmount": 5000000
        },
        {
          "id": 707,
          "name": "Postepay",
          "description": "",
          "translations": {
            "name": {
              "nl_NL": "Postepay"
            }
          },
          "image": "/payment_methods/10.svg",
          "options": [],
          "settings": [],
          "minAmount": 0,
          "maxAmount": 0
        },
        {
          "id": 710,
          "name": "Carte Bleue",
          "description": "",
          "translations": {
            "name": {
              "nl_NL": "Carte Bleue"
            }
          },
          "image": "/payment_methods/11.svg",
          "options": [],
          "settings": [],
          "minAmount": 0,
          "maxAmount": 0
        }
      ],
      "requiredFields": [
        {
          "fieldName": "cardholderName",
          "mandatory": "required"
        },
        {
          "fieldName": "cardNumber",
          "mandatory": "required"
        },
        {
          "fieldName": "expiryDate",
          "mandatory": "required"
        },
        {
          "fieldName": "CVC",
          "mandatory": "required"
        }
      ]
    },
    {
      "tag": "PG_4",
      "name": "Cadeaukaarten",
      "translations": {
        "name": {
          "de_DE": "Geschenkkärte",
          "nl_NL": "Cadeaukaarten"
        }
      },
      "image": "/payment_method_groups/4.svg",
      "paymentMethods": [
        {
          "id": 1657,
          "name": "GivaCard",
          "description": "",
          "translations": {
            "name": {
              "en_GB": "GivaCard",
              "it_IT": "GivaCard",
              "nl_NL": "GivaCard"
            }
          },
          "image": "/payment_methods/61.svg",
          "options": [],
          "settings": [],
          "minAmount": 0,
          "maxAmount": 0
        },
        {
          "id": 1669,
          "name": "Fashion Giftcard",
          "description": "",
          "translations": {
            "name": {
              "nl_NL": "Fashion Giftcard"
            }
          },
          "image": "/payment_methods/28.svg",
          "options": [],
          "settings": {
            "ipFilter": []
          },
          "minAmount": 0,
          "maxAmount": 0
        },
        {
          "id": 1714,
          "name": "VVV Giftcard",
          "description": "",
          "translations": {
            "name": {
              "en_GB": "VVV Giftcard",
              "nl_NL": "VVV Cadeaukaart"
            }
          },
          "image": "/payment_methods/25.svg",
          "options": [],
          "settings": [],
          "minAmount": 0,
          "maxAmount": 0
        }
      ],
      "requiredFields": []
    },
    {
      "tag": "PM_10",
      "name": "iDEAL",
      "translations": {
        "name": {
          "de_DE": "iDEAL",
          "en_GB": "iDEAL",
          "nl_NL": "iDEAL"
        }
      },
      "image": "/payment_methods/1.svg",
      "paymentMethods": [
        {
          "id": 10,
          "name": "iDEAL_EN",
          "description": "",
          "translations": {
            "name": {
              "de_DE": "iDEAL",
              "en_GB": "iDEAL",
              "nl_NL": "iDEAL"
            }
          },
          "image": "/payment_methods/1.svg",
          "options": [
            {
              "id": "2",
              "name": "Rabobank",
              "image": "/issuers/2.svg"
            },
            {
              "id": "4",
              "name": "ING",
              "image": "/issuers/4.svg"
            },
            {
              "id": "5",
              "name": "SNS",
              "image": "/issuers/5.svg"
            },
            {
              "id": "8",
              "name": "ASN Bank",
              "image": "/issuers/8.svg"
            },
            {
              "id": "9",
              "name": "RegioBank",
              "image": "/issuers/9.svg"
            },
            {
              "id": "10",
              "name": "Triodos Bank",
              "image": "/issuers/10.svg"
            },
            {
              "id": "11",
              "name": "Van Lanschot",
              "image": "/issuers/11.svg"
            },
            {
              "id": "12",
              "name": "Knab",
              "image": "/issuers/12.svg"
            },
            {
              "id": "5080",
              "name": "Bunq",
              "image": "/issuers/5080.svg"
            },
            {
              "id": "5082",
              "name": "Svenska Handelsbanken",
              "image": "/issuers/5082.svg"
            },
            {
              "id": "5084",
              "name": "Revolut",
              "image": "/issuers/5084.svg"
            }
          ],
          "settings": [],
          "minAmount": 0,
          "maxAmount": 0
        }
      ],
      "requiredFields": []
    },
    {
      "tag": "PM_136",
      "name": "Overboeking (SCT)",
      "translations": {
        "name": {
          "nl_NL": "Overboeking (SCT)"
        }
      },
      "image": "/payment_methods/12.svg",
      "paymentMethods": [
        {
          "id": 136,
          "name": "Overboeking (SCT)",
          "description": "",
          "translations": {
            "name": {
              "nl_NL": "Overboeking (SCT)"
            }
          },
          "image": "/payment_methods/12.svg",
          "options": [],
          "settings": [],
          "minAmount": 0,
          "maxAmount": 0
        }
      ],
      "requiredFields": []
    },
    {
      "tag": "PM_138",
      "name": "PayPal",
      "translations": {
        "name": {
          "en_GB": "PayPal",
          "it_IT": "PayPal",
          "nl_NL": "PayPal"
        }
      },
      "image": "/payment_methods/21.svg",
      "paymentMethods": [
        {
          "id": 138,
          "name": "PayPal",
          "description": "",
          "translations": {
            "name": {
              "en_GB": "PayPal",
              "it_IT": "PayPal",
              "nl_NL": "PayPal"
            }
          },
          "image": "/payment_methods/21.svg",
          "options": [],
          "settings": [],
          "minAmount": 0,
          "maxAmount": 0
        }
      ],
      "requiredFields": []
    },
    {
      "tag": "PM_138",
      "name": "PayPal",
      "translations": {
        "name": {
          "en_GB": "PayPal",
          "it_IT": "PayPal",
          "nl_NL": "PayPal"
        }
      },
      "image": "/payment_methods/21.svg",
      "paymentMethods": [
        {
          "id": 138,
          "name": "PayPal",
          "description": "",
          "translations": {
            "name": {
              "en_GB": "PayPal",
              "it_IT": "PayPal",
              "nl_NL": "PayPal"
            }
          },
          "image": "/payment_methods/21.svg",
          "options": [],
          "settings": [],
          "minAmount": 0,
          "maxAmount": 0
        }
      ],
      "requiredFields": []
    },
    {
      "tag": "PM_1927",
      "name": "PIN",
      "translations": {
        "name": {
          "nl_NL": "PIN"
        }
      },
      "image": "/payment_methods/164.svg",
      "paymentMethods": [
        {
          "id": 1927,
          "name": "PIN",
          "description": "",
          "translations": {
            "name": {
              "nl_NL": "PIN"
            }
          },
          "image": "/payment_methods/164.svg",
          "options": [
            {
              "code": "TH-4030-9090",
              "name": "Terminal_A",
              "contractStartDate": "2022-07-24",
              "contractEndDate": "2022-11-01",
              "paymentTypes": [
                "SALE"
              ],
              "terminalBrands": [
                {
                  "id": "1003",
                  "name": "V PAY",
                  "image": "/terminal_brands/32.svg"
                },
                {
                  "id": "1009",
                  "name": "Maestro",
                  "image": "/terminal_brands/33.svg"
                },
                {
                  "id": "3004",
                  "name": "Edenred",
                  "image": "/terminal_brands/180.svg"
                }
              ]
            },
            {
              "code": "TH-6180-0000",
              "name": "Terminal_B",
              "contractStartDate": "2022-07-18",
              "contractEndDate": "2022-11-01",
              "paymentTypes": [
                "SALE",
                "REFUND"
              ],
              "terminalBrands": [
                {
                  "id": "1002",
                  "name": "Visa Electron",
                  "image": "/terminal_brands/0.svg"
                },
                {
                  "id": "1009",
                  "name": "Maestro",
                  "image": "/terminal_brands/33.svg"
                },
                {
                  "id": "2003",
                  "name": "MasterCard",
                  "image": "/terminal_brands/35.svg"
                },
                {
                  "id": "2004",
                  "name": "AMEX",
                  "image": "/terminal_brands/36.svg"
                }
              ]
            },
            {
              "code": "TH-9070-8090",
              "name": "Terminal_C",
              "contractStartDate": "2022-07-19",
              "contractEndDate": "2022-11-29",
              "paymentTypes": [
                "SALE"
              ],
              "terminalBrands": []
            }
          ],
          "settings": {
            "ipFilter": {
              "exceptionList": [
                "192.168.1.2",
                "192.168.2.1",
                "192.168.3.1"
              ],
              "type": "allow"
            }
          },
          "minAmount": 0,
          "maxAmount": 0
        }
      ],
      "requiredFields": []
    },
    {
      "tag": "PM_436",
      "name": "Bancontact",
      "translations": {
        "name": {
          "nl_NL": "Bancontact"
        }
      },
      "image": "/payment_methods/2.svg",
      "paymentMethods": [
        {
          "id": 436,
          "name": "Bancontact",
          "description": "",
          "translations": {
            "name": {
              "nl_NL": "Bancontact"
            }
          },
          "image": "/payment_methods/2.svg",
          "options": [],
          "settings": [],
          "minAmount": 0,
          "maxAmount": 0
        }
      ],
      "requiredFields": []
    },
    {
      "tag": "PM_694",
      "name": "Giropay_EN",
      "translations": {
        "name": {
          "en_GB": "Giropay",
          "nl_NL": "Giropay"
        }
      },
      "image": "/payment_methods/3.svg",
      "paymentMethods": [
        {
          "id": 694,
          "name": "Giropay",
          "description": "",
          "translations": {
            "name": {
              "en_GB": "Giropay",
              "nl_NL": "Giropay"
            }
          },
          "image": "/payment_methods/3.svg",
          "options": [],
          "settings": [],
          "minAmount": 0,
          "maxAmount": 0
        }
      ],
      "requiredFields": []
    }
  ],

🦉 Start a Transaction at the TGU

The <<glossary:TGU>> - List

We will provide you with a list of dedicated endpoints that you can use to send your payment request to.

"tguList": [
    {
      "ID": 2,
      "share": 90,
      "domain": "pay.nl",
      "status": "ACTIVE"
    },
    {
      "ID": 52,
      "share": 10,
      "domain": "payments.nl",
      "status": "ACTIVE"
    },
    {
      "ID": 51,
      "share": 0,
      "domain": "achterelkebetaling.nl",
      "status": "FALLBACK"
    }
  ]

Save the configuration

You can save the full JSON response, or save the data in any database or caching engine. If you lose the configuration setup, you can request that information again from the TGU or GMS.


What’s Next