AlipayPlus

This page provides an overview of the payments methods provided by the AlipayPlus adapter in the IXOPAY platform. It also includes a full list of all configuration options available to you when integrating AlipayPlus within your payments landscape, as well as an overview of the parameters required when submitting a transaction via IXOPAY's API.

The current Alipay+ integration only supports the Alipay+ CashierPayment Flow!

Payment Methods

Payment Method	Transaction Flows	Transaction Types	Description
Alipay+	Full-Page Redirect	Debit, Refund	Wallet will be selected by customer @ AlipayPlus
AlipayCN	Full-Page Redirect	Debit, Refund	Only AlipayCN available
AlipayHK	Full-Page Redirect	Debit, Refund	Only AlipayHK available
BPI	Full-Page Redirect	Debit, Refund	Only BPI available
ConnectWallet	Full-Page Redirect	Debit, Refund	Only ConnectWallet available
Dana	Full-Page Redirect	Debit, Refund	Only Dana available
GCash	Full-Page Redirect	Debit, Refund	Only GCash available
KakaoPay	Full-Page Redirect	Debit, Refund	Only KakaoPay available
RabbitLinePay	Full-Page Redirect	Debit, Refund	Only RabbitLinePay available
TNG	Full-Page Redirect	Debit, Refund	Only TNG available
TrueMoney	Full-Page Redirect	Debit, Refund	Only TrueMoney available
Boost	Full-Page Redirect	Debit, Refund	Only Boost available
Akulaku	Full-Page Redirect	Debit, Refund	Only Akulaku available

Connector Config

Parameter / Name	Type	Required	Description
username (ClientId)	string	true	Your ClientId from Alipay+. Starts with SANDBOX_ for their sandbox environment.
extraData.privateKey	string	true	The Private Key - to be retrieved from Alipay+
extraData.alipayplusPublicKey	string	true	The Alipay+ Public Key - to be found in the Alipay+ Developer Portal
extraData.referenceMerchantId	string	true	The Reference Merchant Id - The ID assigned to identify the merchant.
extraData.merchantName	string	true	The display name of the merchant.
extraData.merchantMCC	string	true	The merchant category code, which represents the categorization of the merchant's business type
extraData.merchantAddressRegion	string	true	The merchant address country
extraData.merchantAddressCity	string	true	The merchant address city
extraData.referenceStoreId	string	false	The Reference Store Id - The ID assigned to identify a store.
extraData.storeName	string	false	The store name
extraData.storeMCC	string	false	The stores category code, which represents the categorization of the store's business type
extraData.storeAddressRegion	string	false	The store address region
extraData.storeAddressAddress1	string	false	The store address
extraData.expirySeconds	int	false	Seconds till the payment expires. Between 60 seconds and 600 (default) seconds.
extraData.settlementCurrency	string	false	The 3 letter ISO currency code of the currency that the merchant wants to be settled against. If provided, overwrites connector configuration
extraData.signatureKeyVersion	string	false	Specifies the key version that is used to generate or validate the signature. By default, the value is the latest version of the key associated with Client-Id

Debit Parameters

Name	Type	Required	Description
currency	string	true	3 letter currency code
amount	string	true	Transaction amount: decimals separated by a "." (dot)
description	string	true	Description of items the user is purchasing Alipay+ Docs
extraData.terminalType	string	true	Valid values: WEB,WAP,APP,MINI_APP Alipay+ Docs
extraData.osType	string	conditional	Required if extraData.terminalType == APP/WAP Valid values: IOS, ANDROID Alipay+ Docs
extraData.settlementCurrency	string	false	The 3 letter ISO currency code of the currency that the merchant wants to be settled against. If provided, overwrites connector configuration
extraData.allowedPspRegions	string	false	Comma separated list of allowed Countries e.g. AT,DE
extraData.splitSettlementId	string	false	Alipay+ split settlement support Alipay+ Docs

Debit Customer Parameters

Name	Type	Required	Description
identification (Customer)	string	false (but highly recommended)	The customer’s unique id at the merchant
firstName (Customer)	string	false (but highly recommended)	The customer’s first name and any middle names
lastName (Customer)	string	false (but highly recommended)	The customer’s last name
email (Customer)	string	false (but highly recommended)	The customer’s email address
billingPhone (Customer)	string	false	The customer’s phone number
billingCountry (Customer)	string	false	The customer’s country ISO 3166 2-letter country code. Mapped to userRegion
ipAddress (Customer)	string	false	The customer’s IP address
shippingFirstName (Customer)	string	false	Shipping first name
shippingLastName (Customer)	string	false	Shipping last name
shippingAddress1 (Customer)	string	false	First line of the address
shippingAddress2 (Customer)	string	false	Second line of the address
shippingCity (Customer)	string	false	Australian suburb, New Zealand town or city, U.K. Postal town, U.S. or Canadian city
shippingState (Customer)	string	false	Australian state, New Zealand region, U.K. county, Canadian Territory or Province, or U.S. state
shippingPostcode (Customer)	string	false	ZIP or postal code
shippingCountry (Customer)	string	false	The two-character country code
extraData.shippingCarrier (Customer)	string	false	The name of the carrier, such as FedEx, UPS, USPS, and so on

Debit Item Parameters

If items are provided with the transaction data, the following parameters can or must be given:

Name	Type	Required	Description
identification (Item)	string	true	The unique ID assigned by the merchant that directly provides services or goods to users to identify goods
name (Item)	string	true	Product name or display name for the discount
quantity (Item)	string	false	Quantity
currency (Item)	string	false	If not provided transaction.currency will be used
price (Item)	string	false	Item price: decimals separated by a "." (dot)
extraData.category (Item)	string	false	Item Category
extraData.brand (Item)	string	false	Item Brand

ConsultPayment Request

In order to retrieve the available payment methods and active promotions details, the consultPayment options request has to be issued.

Please use consultPayment as an option name e.g. POST /options/{apiKey}/consultPayment.

ConsultPayment Parameters

Name	Type	Required	Description
parameters.type	string	true	Valid values: CASHIER
parameters.currency	string	true	3 letter currency code
parameters.amount	string	true	Payment amount: decimals separated by a "." (dot)
parameters.settlementCurrency	string	true	3 letter currency code for settlement
parameters.terminalType	string	true	Valid values: WEB,WAP,APP,MINI_APP Alipay+ Docs
parameters.osType	string	conditional	Required if extraData.terminalType == APP/WAP Valid values: IOS, ANDROID Alipay+ Docs

Request body

Request Body Example

{
  "parameters": {
    "type": "CASHIER",
    "currency": "USD",
    "amount": 100,
    "settlementCurrency": "JPY",
    "terminalType": "WEB"
  }
}

Response

Example responses

success

{
  "success": true,
  "options": {
    "paymentOptions": [
      {
        "brandName": "Alipay+",
        "enabled": "true",
        "logos": [
          {
            "logoHeight": "190",
            "logoName": "Alipay+",
            "logoPattern": "default",
            "logoUrl": "https://cdn.marmot-cloud.com/storage/aplus-checkout-prod/icon/prod/CONNECT_WALLET_TEST.png",
            "logoWidth": "810"
          }
        ],
        "paymentMethodType": "CONNECT_WALLET",
        "promoNames": [
          "{\"en_US\":\"A+ Cashier Promotion Test\",\"fil_PH\":\"A+ Cashier Promotion Test\"}"
        ]
      }
    ]
  }
}

error

{
  "success": false,
  "errorMessage": "Given identifier 'someIdentifier' is invalid."
}

You can find more information about the options request here: Options Request