Direct Support Site

Results for

icon-search-large No search results yet
Enter your search query above
Page topics

Integration

We offer this payment methods for the following integration modes. Learn in our dedicated guides about the individual differences

Find a high level overview in the "Process flows" chapter. 

Depending on the integration mode, differences apply:

Hosted Checkout Page

Add the following properties to a standard CreateHostedCheckout request:

{
  "order": {
    "amountOfMoney": {
      "currencyCode": "EUR",
      "amount": 1200
    }
  },
  "hostedCheckoutSpecificInput": {
    "locale": "en_GB",
    "returnUrl": " https://yourReturnUrl.com"
   },
  "redirectPaymentMethodSpecificInput": {
    "PaymentProductId": 5404
  }
} 
Properties Remarks

order.amountOfMoney

amount

currencyCode

amount: The gross amount you want to charge for this order
currencyCode: The ISO 4217 currency code for this amount

hostedCheckoutSpecificInput

     returnURL

     locale

returnURL: The URL we redirect your customers to after the payment has been finalized

locale: The language version of our Hosted Checkout Page

redirectPaymentMethodSpecificInput.
paymentProductId

The numeric identifier of the payment method on our platform. Find this id in the "Overview" tab. It instructs our platform to send your customers directly to the WeChat Pay portal. If left out, our platform sends your customers to the Hosted Checkout Page instead, allowing them to choose this or any other payment method in your account

Find detailed information about this object and its properties in our HostedCheckoutAPI

Server-to-server

Add the following properties to a standard CreatePayment request:

{
   "Order":{
      "AmountOfMoney":{
         "Amount":1200,
         "CurrencyCode":"EUR"
      },
      "Customer":{
         "Device":{
            "IpAddress":"217.149.44.205",
            "UserAgent":"Mozilla/5.0 (Linux; Android 4.4.4; MX4 Pro Build/KTU84P) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/33.0.0.0 Mobile Safari/537.36; 360 Aphone Browser (6.9.7)"
         }
      },
      "References":{
         "MerchantReference":"mr_638143243872475406"
      }
   },
   "RedirectPaymentMethodSpecificInput":{
      "PaymentProductId":5404,
      "redirectionData":{
         "returnURL":"https://yourReturnUrl.com"
      }
   }
}
Properties Remarks

order.amountOfMoney

amount

currencyCode

amount: The gross amount you want to charge for this order
currencyCode: The ISO 4217 currency code for this amount

customer.device

    ipAdress
    userAgent

ipAdress: Your customers' IP address 

userAgent: Your customers' device used for the transaction

Mandatory for the "With a mobile device" flow to ensure our platform returns an merchantAction.showFormData. paymentProduct5404.appSwitchLink to open the WeChat Pay app on your customers’ device.

If left out, our platform returns a merchantAction.showFormData. paymentProduct5404.qrCodeUrl instead for the "With a desktop and a mobile device" flow

redirectPaymentMethodSpecificInput

    paymentProductId
    redirectionData.returnURL

paymentProductId: The numeric identifier of the payment method on our platform. Find this id in the "Overview" tab

returnURL: The URL we redirect your customers to after the payment has been finalised

order.customer.contactDetails.emailAddress

Your customer’s e-mail address

Find detailed information about this object and its properties in our CreatePaymentAPI