DOCS

Release notes

Release date: April 21, 2025

Modified

API name

Impacts

inquiryStatementList

Response body

  • Added the following parameter:
    • statementList.originalFeeAmount
    • statementList.discountFeeAmount

inquiryStatementDetail

Response body

  • Added the following parameter:
    • statementList.originalFeeAmount
    • statementList.discountFeeAmount

consultPayout

Response body

  • Added the following parameter:
    • chargeMode
    • transferFromDetail.originalFeeRate
    • transferFromDetail.feeRate
    • transferFromDetail.originalFeeAmount
    • transferFromDetail.discountFeeAmount
    • transferFromDetail.promotionList
    • transferToDetail.originalFeeRate
    • transferToDetail.feeRate
    • transferToDetail.originalFeeAmount
    • transferToDetail.discountFeeAmount
    • transferToDetail.promotionList

createPayout

Response body

  • Added the following parameter:
    • chargeMode
    • transferFromDetail.originalFeeRate
    • transferFromDetail.feeRate
    • transferFromDetail.originalFeeAmount
    • transferFromDetail.discountFeeAmount
    • transferFromDetail.promotionList
    • transferToDetail.originalFeeRate
    • transferToDetail.feeRate
    • transferToDetail.originalFeeAmount
    • transferToDetail.discountFeeAmount
    • transferToDetail.promotionList

inquiryPayout

Response body

  • Added the following parameter:
    • chargeMode
    • transferFromDetail.originalFeeRate
    • transferFromDetail.feeRate
    • transferFromDetail.originalFeeAmount
    • transferFromDetail.discountFeeAmount
    • transferFromDetail.promotionList
    • transferToDetail.originalFeeRate
    • transferToDetail.feeRate
    • transferToDetail.originalFeeAmount
    • transferToDetail.discountFeeAmount
    • transferToDetail.promotionList

notifyPayout

Request body

  • Added the following parameter:
    • chargeMode
    • transferFromDetail.originalFeeRate
    • transferFromDetail.feeRate
    • transferFromDetail.originalFeeAmount
    • transferFromDetail.discountFeeAmount
    • transferFromDetail.promotionList
    • transferToDetail.originalFeeRate
    • transferToDetail.feeRate
    • transferToDetail.originalFeeAmount
    • transferToDetail.discountFeeAmount
    • transferToDetail.promotionList

Release date: March 17, 2025

Modified

API name

Impacts

bindBeneficiary

Request body

  • Added the following parameter:
    • thirdPartyIdentity
  • Updated the code samples

consultPayout

Request body & response body:

  • Added the following parameter:
    • transferToDetail.transferToMethod.paymentMethodMetaData.routingNumber（when paymentType = BANK_ACCOUNT_DETAIL)

createPayout

Request body & response body:

  • Added the following parameter:
    • transferToDetail.transferToMethod.paymentMethodMetaData.routingNumber（when paymentType = BANK_ACCOUNT_DETAIL)

inquiryPayout

Response body:

  • Added the following parameter:
    • transferToDetail.transferToMethod.paymentMethodMetaData.routingNumber（when paymentType = BANK_ACCOUNT_DETAIL)

notifyPayout

Request body:

  • Added the following parameter:
    • transferToDetail.transferToMethod.paymentMethodMetaData.routingNumber（when paymentType = BANK_ACCOUNT_DETAIL)

Release date: February 26, 2025

Modified

API name

Impacts

inquiryAccount

Request body

  • Modified the following parameter: 
    • accountType

Response body

  • Added the following parameter: 
    • alipayCustomer

Release date: November 29, 2024

Added

Added the following APIs:

Modified

API name

Impacts

inquiryRate

Request body

  • Added the following parameter: 
    • customeId

Updated the code samples

inquiryExchange

Request body

  • Added the following parameter: 
    • customeId

Updated the code samples

Release date: November 21, 2024

Modified

API name

Impacts

inquiryBeneficiaryTemplate

Request body

  • Modified the following parameters: 
    • currency
    • beneficiaryType

Updated the code samples

bindBeneficiary

Request body

  • Modified the following parameter: 
    • currency

Response body

  • Modified the following parameter: 
    • beneficiary.currency

Updated the code samples

inquiryBeneficiaryList

Request body

  • Modified the following parameter: 
    • currencyList

Response body

  • Modified the following parameter: 
    • beneficiaries.currency

Updated the code samples

createPayout

Request body

  • Modified the following parameter: 
    • transferToDetails.purposeCode

Response body

  • Modified the following parameter: 
    • transferToDetails.purposeCode

Release date: Sept 20, 2024

Added

Added the inquiryStatementDetail API.

Modified

API name

Impacts

inquiryAccount

Request body

  • Updated the description of the following parameter: 
    • accountType

Response body

  • Added the following parameter: 
    • affliatedCustomer 

Updated the request and response samples

inquiryBeneficiaryTemplate

Request body

  • Updated the description of the following parameters: 
    • currency
    • beneficiaryType
    • countryCode

Response body

  • Added the following parameter: 
    • alipayTemplateData
  • Updated the description of the following parameter: 
    • cardTemplateData

Updated the request and response samples

bindBeneficiary

Request body

  • Added the following parameter: 
    • beneficiaryAlipayAccount
  • Updated the description of the following parameters: 
    • beneficiaryType 
    • beneficiaryBankAccount
    • countryCode
    • currency
    • beneficiaryNick

Updated the request and response samples

inquiryBeneficiary

Request body 

  • Added the following parameters: 
    • assetType
    • accountName
    • currencyList
  • Updated the following parameter: 
    • bankAccountNo

Response body

  • Added the following parameter: 
    • beneficiaries.beneficiaryAlipayAccount
  • Updated the following parameter: 
    • beneficiaries.beneficiaryBankAccount

Updated the request and response samples

submitTradeOrder

Request body

  • Added the following parameter: 
    • traderOrders.buyer.buyerCountry

inquiryTradeOrder

Response body

  • Added the following parameter: 
    • tradeOrderResults.orderType

Updated the response samples

notifyTradeOrder

Request body

  • Added the following parameter: 
    • tradeOrderResults.orderType

Updated the request sample

Release date: August 15, 2024

Added

  • To enable Partners to download statement details and meet the regulatory compliance, added the following three APIs:
  • To enable Partners to receive beneficiary binding result from Zyla, added the following API:

Modified

API Name

Impacts

Manage your beneficiaries

Updated the description of:

  • The step to receive beneficiary binding result via Zyla

inquiryBeneficiary

Request body

  • Move the customerId to the request header as the Connected-CustomerId parameter
  • Updated the use condition of the parameter: accessToken

Response body

  • Updated the description of the parameter: beneficiaryBankAccount

bindBeneficiary

Request body

  • Move the customerId to the request header as the Connected-CustomerId parameter
  • Updated the use condition of the parameter: accessToken
  • Updated the description of the parameter: beneficiaryBankAccount

Response body

  • Updated the description of the parameter: beneficiaryBankAccount

removeBeneficiary

Request body

  • Move the customerId to the request header as the Connected-CustomerId parameter
  • Updated the use condition of the parameter: accessToken

Release date: July 15, 2024

Modified

API name

Impacts

inquiryStatementList

Request body：

  • Updated the following parameters：
    • startTime
    • endTime
    • trasactionTypeList

Response body：

  • Added the following parameters：
    • statementList.goodsName
    • statementList.goodsAmount
    • statementList.platformFeeAmount
  • Updated the following parameters：
    • statementList.transactionStatus

Release date: July 4, 2024

Modified

API Name

Impacts

inquiryBeneficiaryList

Request body:

  • Add the following parameters:
    • relationStatusList

Response body:

  • Updated the description of the following parameters:
    • beneficiaries.beneficiaryType
    • beneficiaries.beneficiaryBankAccount.bankAccountNo
    • beneficiaries.beneficiaryBankAccount.bankAccountIBAN

bindBeneficiary

Request body:

  • Updated the description of the following parameters:
    • beneficiaryType
    • beneficiaryBankAccount.bankAccountNo
    • beneficiaryBankAccount.bankAccountIBAN

Response body:

  • Updated the description of the following parameters:
    • beneficiaryType
    • beneficiaries.beneficiaryBankAccount.bankAccountNo
    • beneficiaries.beneficiaryBankAccount.bankAccountIBAN

inquiryPayout

Request body:

  • Add the following parameters:
    • transferId
  • Updated the code sample

inquiryStatementList

Request body:

  • Add the following parameters:
    • fuzzyName
  • Updated the code sample

Response body:

  • Add the following parameters:
    • statementList.accountingBizNo
    • statementList.fundMoveDetail.payerBankName
  • Updated the code sample

notifyVostro

Request body:

  • Updated the description of the following parameters:
    • payerBankAccount.holderAddress

submitTradeOrder

Request body:

  • Updated the description of the following parameters:
    • tradeOrders.paymentTime
    • tradeOrders.orderTime

Release date: May 14, 2024

Added

In the response message of the inquiryAccount API, added the following parameters:

  • customer.logonId
  • customer.verificationLevel

Release date: April 28, 2024

To enhance clarity and facilitate the process to set up Zyla Receiving Accounts, updated the integration guide: Create a Receiving Account for Customers

Added

Added the result code: REQUEST_ID_IDEMPOTENT and REFERENCE_CUSTOMER_ID_OPENED_RA

Modified

Modified the use condition for the requestId parameter.

Release date: January 17, 2024

To enhance VA account inquiry capability through Zyla, updated the following content:

API Name

Impacts

inquiryAcccount

Response body:

  • Add the following parameters:

       accountInfos.bankAccountList.bankRegion

  • Updated the desciption of the following parameters:
    • accountInfos.bankAccountList.bankAccountNo
    • accountInfos.bankAccountList.bankName
    • accountInfos.bankAccountList.routingNumber
    • accountInfos.bankAccountList.bankBIC
    • accountInfos.bankAccountList.bankAccountIBAN
    • accountInfos.bankAccountList.bankAccountBSB
    • accountInfos.bankAccountList.accountCreationDate
    • accountInfos.bankAccountList.bankCode
    • accountInfos.bankAccountList.branchCode
    • accountInfos.bankAccountList.wireRoutingNumber
    • accountInfos.bankAccountList.sortCode

inquiryStore

Response body:

  • Add the following parameters:
    • accountInfos.bankAccountList.bankRegion
    • statementList.receiveAmount
  • Updated the desciption of the following parameters:
    • accountInfos.bankAccountList.bankAccountNo
    • accountInfos.bankAccountList.bankName
    • accountInfos.bankAccountList.routingNumber
    • accountInfos.bankAccountList.bankBIC
    • accountInfos.bankAccountList.bankAccountIBAN
    • accountInfos.bankAccountList.bankAccountBSB
    • accountInfos.bankAccountList.accountCreationDate
    • accountInfos.bankAccountList.bankCode
    • accountInfos.bankAccountList.branchCode
    • accountInfos.bankAccountList.wireRoutingNumber

Release date: November 17, 2023

Modified

In the submitTradeOrder API:

Updated the description of tradeOrders.shipping.wayBillInfos.shippingOrderReferenceNo

Release date: November 3, 2023

Modified

To enhance OAuth capability, replaced INVALID_ACCESS_TOKEN with AUTHORIZATION_NOT_EXIST in the following APIs:

Release date: October 30, 2023

To enhance account and statement inquiry through Zyla, updated the following content:

Added

  • Added a value to transactionType: DEPOSIT_PURCHASE
  • Added the primaryUserInformation parameter to the response body of the inquirySubuser API.

Release date: September 22, 2023

To enhance trade order submission and statement inquiry through Zyla, updated the following content:

Added

  • Added a value to transactionType：BALANCE_TO_BALANCE
  • Added the following parameters to Goods：
    • goodsUnit
    • goodsCnName

Modified

Updated the description of the following parameters in the request body of the submitTradeOrder API：

  • tradeOrders.referenceOrderNo
  • tradeOrders.transAmount
  • tradeOrders.tradeAmount
  • tradeOrders.merchant
  • tradeOrders.attachmentDesc
  • tradeOrders.goods.goodsCategory
  • tradeOrders.goods.goodsQuantity
  • tradeOrders.goods.storeUrl

Release date: September 5, 2023

Modified

To improve the overall performance of account inquiry, order association and payout, modified the following APIs:

API name

Impacts

inquiryAccount

  • Request body: updated the usage conditions of accountType
  • Error code
    • Added AUTHORIZATION_NOT_EXIST
    • Added ACCESS_TOKEN_EXPIRED

inquiryStatementList

  • Request body: updated the desciption of the following parameters
    • pageSize
    • pageNumber
  • Response body: added the following parameters:
    • statementList.netAmount
    • statementList.receiveAmount
    • statementList.fundMoveDetail.payerUserId
    • statementList.fundMoveDetail.paymentExplanation
    • statementList.fundMoveDetail.paymentSubject
    • statementList.fundMoveDetail.paymentVoucherNo
  • Updated the code sample

submitTradeOrder

Request body: added tradeOrders.logisticsMode parameter

notifyAssociationResult

Request body: added the following parameters

  • notificationType
  • referenceOrderNo

createPayout

  • Request body and response body: updated transferToAmount.transferToRemark to transferToAmount.transferRemark
  • Error code: added AVAILABLE_QUOTA_NOT_ENOUGH

Enumeration

Added:

  • accountType.VIRTUAL_ACCOUNT
  • accountType.ALIPAY_WALLET
  • transactionType.CASH_BACK
  • transactionType.VENDOR_COLLECTION_PAYMENT

Release date: Auguest 8, 2023

Modified

To optimise the management of beneficiaries through Zyla, modified the following APIs:

API name

Impacts

bindBeneficiary

  • Request body
    • Added the following parameters:
      • beneficiaryBankAccount.beneficiaryTIN
      • beneficiaryBankAccount.beneficiaryDepositType
      • beneficiaryBankAccount.bankCountryCode
      • beneficiaryBankAccount.bankLocalName
      • beneficiaryBankAccount.localBeneficiaryAddress
      • beneficiaryBankAccount.beneficiaryPostalCode
      • beneficiaryBankAccount.beneficiaryState
      • beneficiaryBankAccount.beneficiaryCity
  • Response body
    • Added the following parameters:
      • beneficiaryBankAccount.beneficiaryTIN
      • beneficiaryBankAccount.beneficiaryDepositType
      • beneficiaryBankAccount.bankCountryCode
      • beneficiaryBankAccount.bankLocalName
      • beneficiaryBankAccount.localBeneficiaryAddress
      • beneficiaryBankAccount.beneficiaryPostalCode
      • beneficiaryBankAccount.beneficiaryState
      • beneficiaryBankAccount.beneficiaryCity
  • Updated request and response code samples

inquiryBeneficiary

Response body: Added the following parameters:

  • beneficiaryBankAccount.beneficiaryTIN
  • beneficiaryBankAccount.beneficiaryDepositType
  • beneficiaryBankAccount.bankCountryCode
  • beneficiaryBankAccount.bankLocalName
  • beneficiaryBankAccount.localBeneficiaryAddress
  • beneficiaryBankAccount.beneficiaryPostalCode
  • beneficiaryBankAccount.beneficiaryState
  • beneficiaryBankAccount.beneficiaryCity

Release date: July 28, 2023

Modified

To provide better experience in trade order management through Zyla, modified the following APIs:

API name

Impacts

submitTradeOrder

  • Request body: Added the extendInfo parameter
  • Result code: Added FUND_ORDER_RELATED_MANUALLY 
  • Updated request and response code samples

inquiryTradeOrder

Updated request and response code samples

Release date: July 24, 2023

Deleted

For all fund transfer and payout APIs, delete the feeMode parameter from the TransferToDetail object.

Release date: July 21, 2023

To enable partners to transfer and receive funds in multiple currencies, modified the inquireStore API:

Modified

API name

Impacts

inquiryStore

  • Request body
    • Added the following parameters: 
      • storeInformation.accountInformation.bankAccountList.currencyList
      • storeInformation.accountInformation.bankAccountList.holderAccountType
      • storeInformation.accountInformation.bankAccountList.routingNumber
      • storeInformation.accountInformation.bankAccountList.bankAddress
      • storeInformation.accountInformation.bankAccountList.bankAccountIBAN
      • storeInformation.accountInformation.bankAccountList.bankAccountBSB
      • storeInformation.accountInformation.bankAccountList.accountCreationDate
      • storeInformation.accountInformation.bankAccountList.bankCode
      • storeInformation.accountInformation.bankAccountList.branchCode
      • storeInformation.accountInformation.bankAccountList.bankAccountType
      • storeInformation.accountInformation.bankAccountList.collectionArea
      • storeInformation.accountInformation.bankAccountList.wireRoutingNumber
    • Deleted the following parameter:
      • storeInformation.accountInformation.bankAccountList.bankRegion
    • Modified the use condition of the following parameter:
      • storeInformation.accountInformation.currencyList
    • Updated the names of the following parameters: 
      • storeInformations was changed to：storeInformation
      • storeInformations.accountInfos was changed to：storeInformation.accountInformation
      • storeInformations.accountInfos.bankAccount was changed to：storeInformation.accountInformation.bankAccountList
      • storeInformations.accountInfos.bankAccount.accountNo was changed to：storeInformation.accountInformation.bankAccountList.bankAccountNo
    • Updated the data type of the following parameter:
      • storeInformation.accountInformation.bankAccountList was changed from BankAccount object to Array<BankAccount object>
  • Updated the response code sample

Release date: June 9, 2023

Added

Modified

  • To enhance the capabilities of Partners in invoicing payment via Zyla, modified the createInvoice API in the following aspects:
    • Modified the data type of invoice.bill.billSender.userName and invoice.bill.billReceiver.userName from String to the UserName object.
    • Modified the data type of invoice.bill.billSender.userAddress and invoice.bill.billReceiver.userAddress from String to the Address object.
    • Added the result code UNSUPPORTED_BUSINESS to the response body.
    • Updated the sample codes.
  • To adapt to new capabilities of payout, modified the following APIs:

API name

Impacts

consultPayout

Updated the request and response code samples. 

createPayout

Updated the request and response code samples. 

inquiryPayout

Updated the request and response code samples. 

  • To enhance the capabilities of Partners in trade orders and payouts, modified the following APIs:

API name

Impacts

submitTradeOrder

  • Request body:
    • Added the following parameters:
      • quotaAccumulationId
      • tradeOrders.market
      • tradeOrders.revenueShare
    • Deleted the following parameters:
      • transferId
      • referenceBatchNo
      • tradeOrders.tradeBizType
      • tradeOrders.sellerAccount
      • tradeOrders.sellerAccount.bankAccountNo
      • tradeOrders.sellerAccount.receivingAccount
    •  Updated the descriptions of the following parameters:
      • tradeOrders
      • tradeOrders.tradeAmount
      • tradeOrders.isUsedForExchange
      • tradeOrders.bizContractInfo
      • tradeOrders.shipping.wayBillInfos
      • tradeOrders.shipping.isShipped
      • tradeOrders.shipping.isDeclared
      • tradeOrders.shipping.isNewBuyer
      • tradeOrders.shipping.declarationInfos
      • tradeOrders.shipping.expectedShippingDate
      • tradeOrders.shipping.inquiryChatRecordAttachmentList
      • tradeOrders.shipping.logisticsChatRecordAttachmentList
      • tradeOrders.shipping.tradeTerms
      • tradeOrders.shipping.wayBillInfos.shippingOrderReferenceNo
      • tradeOrders.shipping.wayBillInfos.shippingMethod
      • tradeOrders.shipping.wayBillInfos.shippingProofAttachmentList
      • tradeOrders.shipping.wayBillInfos.logisticsCompany
      • tradeOrders.shipping.declarationInfos.declarationOrderReferenceNo
      • tradeOrders.shipping.declarationInfos.supervisionMethod
      • tradeOrders.shipping.declarationInfos.customsDeclarationAttachmentList
    • Added two enum values, TRANSFER_ID and COLLECTION_ID to the quotaAccumulationMethod parameter
    • Updated the two enum values, CREATE_ORDERS_AND_ASSOCIATE and CREATE_ORDER_AND_ASSOCIATE_BIG_MERCHANT of the sceneCode parameter to the enum value CREATE_B2B_ORDERS
    • Updated the enum value PAYMENT of the tradeOrders.orderType parameter to LOAN
  • Response body:
    • Added the result code REPEAT_REQ_INCONSISTENT
    • Updated the description of the acceptOrderId parameter
  • Updated the sample codes

inquiryTradeOrder

  • Request body:
    • Added the following parameter in the request body:
      • sceneCode
      • quotaAccumulationMethod
      • quotaAccumulationId
      • tradeType
    • Deleted the sellerUserId parameter
  • Response body:
    • Added the following result codes:
      • ACCOUNT_NOT_EXIST
      • ORDER_NOT_EXIST
  • Updated the sample codes

consultPayout

Move the transferFromDetail.availableQuota parameter to the response body as the availableQuota parameter. 

Release date: June 6, 2023

Modified

To enable different payment channels in fund payout, modified the following APIs:

API name

Impacts

consultPayout

  • In both request body and response body: 
    • Added the following parameter: 
      • transferFromDetail.transferFromMethod.paymentMethodMetaData.AlipayAccountPaymentMethodDetail
    • Updated the descriptions of the following parameters:
      • transferFromDetail.transferFromMethod.paymentMethodType
      • transferFromDetail.transferFromMethod.paymentMethodId
      • transferFromDetail.transferFromMethod.paymentMethodMetaData
      • transferToDetail.transferToMethod.paymentMethodType
      • transferToDetail.transferToMethod.paymentMethodId
      • transferToDetail.transferToMethod.paymentMethodMetaData

createPayout

  • In both request body and response body: 
    • Added the following parameters: 
      • transferFromDetail.transferFromMethod.paymentMethodMetaData.AlipayAccountPaymentMethodDetail
      • transferOrderAddition.disPlayTitle
    • Updated the descriptions of the following parameters:
      • transferFromDetail.transferFromMethod.paymentMethodType
      • transferFromDetail.transferFromMethod.paymentMethodId
      • transferFromDetail.transferFromMethod.paymentMethodMetaData
      • transferToDetail.transferToMethod.paymentMethodType
      • transferToDetail.transferToMethod.paymentMethodId
      • transferToDetail.transferToMethod.paymentMethodMetaData

inquiryPayout

  • Response body: 
    • Added the following parameters: 
      • transferFromDetail.transferFromMethod.paymentMethodMetaData.AlipayAccountPaymentMethodDetail
      • transferOrderAddition.disPlayTitle
    • Updated the descriptions of the following parameters:
      • transferFromDetail.transferFromMethod.paymentMethodType
      • transferFromDetail.transferFromMethod.paymentMethodId
      • transferFromDetail.transferFromMethod.paymentMethodMetaData
      • transferToDetail.transferToMethod.paymentMethodType
      • transferToDetail.transferToMethod.paymentMethodId
      • transferToDetail.transferToMethod.paymentMethodMetaData

notifyPayout

  • Request body: 
    • Added the following parameters: 
      • transferFromDetail.transferFromMethod.paymentMethodMetaData.AlipayAccountPaymentMethodDetail
      • transferOrderAddition.disPlayTitle
    • Updated the descriptions of the following parameters:
      • transferFromDetail.transferFromMethod.paymentMethodType
      • transferFromDetail.transferFromMethod.paymentMethodId
      • transferFromDetail.transferFromMethod.paymentMethodMetaData
      • transferToDetail.transferToMethod.paymentMethodType
      • transferToDetail.transferToMethod.paymentMethodId
      • transferToDetail.transferToMethod.paymentMethodMetaData

Release date: May 19, 2023

Fully migrated from WorldFirst to Zyla.

Release date: April 28, 2023

Added

  • To support various types of balance for different clients, especially for the CN HK EC (E-commerce) clients from the point of risk control, added the core balanceTypes field in the inquiryBalance API and the inquiryStatementList API.

API name

Impacts

inquiryBalance

  • Added the balanceTypes field in the request body
  • Added the balanceTypes field in the accountBalance data object in the response body

inquiryStatementList

  • Added the balanceTypes field in the request body
  • Added the balanceTypes filed and the description field in the statementList object in the response body
  • To support unfunded foreign exchange spot deals, modified the following APIs:

API name

Impacts

inquiryAvailableCalendar

Added the exchangeTradeType field in the request body

createQuote

  • Added the quoteUnfundedInfo field in the request body
  • Added the UNFUNDED_SPOT enum value to the exchangeTradeType field
  • Added the quoteUnfundedInfo field in the response body

createDeal

Added the exchangeTradeType field in the request body

notifyExchange

  • Added the UNFUNDED_SPOT enum value to the exchangeTradeType field
  • Added the exchangeUnfundedInfo field in the request body

createExchange

  • Added the UNFUNDED_SPOT enum value to the exchangeTradeType field
  • Added the exchangeUnfundedInfo field in the request body
  • Added the exchangeUnfundedInfo field in the response body

inquiryExchange

Added the exchangeUnfundedInfo field in the response body

Data Dictionary

Added the settlementTimeType field to the QuoteForwardInfo object.

Modified

To support unfunded foreign exchange spot deals, modified the following APIs:

API name

Impacts

inquiryAvailableCalendar

Modified the forwardType field from Required to Optional

createQuote

  • Removed the quoteForwardInfo field from the request body
  • Removed the quoteForwardInfo field from the response body

createDeal

  • Modified the marginCurrency field from Required to Optional
  • Modified the forwardType field from Required to Optional

createExchange

  • Removed the exchangeForwardInfo field from the request body
  • Removed the exchangeForwardInfo field from the response body

inquiryExchange

Removed the exchangeForwardInfo field in the response body

Data Dictionary

  • Removed the forwardType field from the QuoteForwardInfo object
  • Modified the marginCurrency field in the QuoteForwardInfo object from Required to Optional

Release date: April 21, 2023

Modified

For the createQuote API:

  • Added the Connected-CustomerId field to the request header.
  • Removed the customerId and accessToken fields from the request body.
  • Added code samples for the request header.
  • Updated code samples for the request body and the response body.

Release date: April 13, 2023

Modified

For the inquiryBalance API:

  • Added the Connected-CustomerId field to the request header.
  • Removed the customerId and accessToken fields from the request body.
  • Updated code samples for the request body, request calling, and the response body.

Release date: April 10, 2023

Modified

For the inquiryStatementList API:

  • Added the Connected-CustomerId field to the request header.
  • Removed the customerId and accessToken fields in the request.
  • Updated code samples for the request body, request calling, and the response body.

Release date: April 3, 2023

Added

    • Added the PAY_INTO_CHINA enumeration value in the sceneCode field.
    • Added the following request fields for the B2C scenario:
      • quotaAccumulationMethod
      • referenceBatchNo
      • tradeOrder.orderType
      • tradeOrder.merchant
      • tradeOrder.seller
      • tradeOrder.buyer
      • tradeOrder.sellerAccount
      • tradeOrder.seller.referenceCustomerId
      • tradeOrder.goods.goodsCategory
      • tradeOrder.shipping.wayBillInfos.shippingAddress
    • Added the tradeOrderResult response field.
    • Added two code samples for the B2C scenario.

Modified

For the submitTradeOrder API:

    • Modified the descriptions of the following request fields:
      • tradeOrders
      • platform
      • transferId
      • tradeOrder.transAmount
      • tradeOrder.isUsedForExchange
      • tradeOrder.bizContractInfo
      • tradeOrder.seller.customerId
      • tradeOrder.shipping.isShipped
      • tradeOrder.shipping.isDeclared
      • tradeOrder.shipping.isNewBuyer
      • tradeOrder.shipping.wayBillInfos
      • tradeOrder.shipping.declarationInfos
      • tradeOrder.shipping.expectedShippingDate
      • tradeOrder.shipping.inquiryChatRecordAttachmentList
      • tradeOrder.shipping.logisticsChatRecordAttachmentList
      • tradeOrder.shipping.tradeTerms
      • tradeOrder.shipping.wayBillInfos.shippingOrderReferenceNo
      • tradeOrder.shipping.wayBillInfos.shippingMethod
      • tradeOrder.shipping.wayBillInfos.shippingProofAttachmentList
      • tradeOrder.shipping.wayBillInfos.logisticsCompany
      • tradeOrder.shipping.declarationInfos.declarationOrderReferenceNo
      • tradeOrder.shipping.declarationInfos.supervisionMethod
      • tradeOrder.shipping.declarationInfos.customsDeclarationAttachmentList
    • Removed the following optional fields from the request fields:
      • tradeOrder.purposeCode
      • tradeOrder.goods.goodsCnName
      • tradeOrder.goods.goodsUnit
      • tradeOrder.goods.storeUrl
      • tradeOrder.goods.goodsUnitAmount
      • tradeOrder.shipping.wayBillInfos.logisticsCompanyName
    • Modified the description of the acceptOrderId response field.

Release date: Mar 31, 2023

Added

  • Added the businessSceneCode request parameter and 2 samples for the FX scenario in the consultPayout API and the createPayout API.
  • Added the following three fields in the BankAccountPaymentMethodDetail data model:
    • beneficiaryType
    • bankAccountLocalName
    • bankLocalName
  • Added the following two fields in the TransferToDetail (for Payout) data model:
    • arrivalType
    • fvtPayment
  • Added the following two fields in the TransferFromDetail data model:
    • tranferLimitInfo
    • availableQuota
  • Added the TransferLimitInfo data model.

Modified

  • Modified the descriptions of the following two fields in the BankAccountPaymentMethodDetail data model:
    • bankCountryCode
    • routingNumber
  • Modified the description of the transferToAmount field in the TransferToDetail data model.
  • Modified the description of the transferFromAmount field in the TransferFromDetail data model.

Release date: Mar 28, 2023

Added

Added Transfer and Payout APIs to replace the former Funds Transfer APIs.

API Name

Function

consultTransfer

Consult expected transfer result

createTransfer

Create a transfer request

inquiryTransfer

Check transfer result

notifyTransfer

Receive transfer result notification

consultPayout

Consult expected payout result

createPayout

Create a payout request

inquiryPayout

Check payout result

notifyPayout

Receive payout result notification

Release date: Feb 22, 2023

Added

For the submitTradeOrder API

  • For tradeOrder.bizContractInfo.tradeCountry and tradeOrder.bizContractInfo.deliverCountry, updated field descriptions and added regulated country list
  • Added REGULATED_COUNTRY_NOT_SUPPORTED to result.resultCode

Release date: Feb 1, 2023

Added

3 APIs on trade order submission:

API name

Description

submitTradeOrder

It is used to submit trade orders. The Partner calls submitAttachment API to submit the required attachments. 

submitAttachment

It is called to submit the attachment required by submitTradeOrder API.

receiveAssociationResultNotification

After Zyla receives and processes the request of submitting trade orders, we call this API to send out result notifications.

Release date: Oct 26, 2022

Added

For the inquiryStatementList API

  • Added the following enumeration values for the transactionType field:
    • REFUND, FX_ADJUSTMENT, FX_FEE, PAYMENT

Release date: Oct 24, 2022

Added

For the createTransfer API:

  • Added the BankAccountPaymentMethodDetail.beneficiaryAddress field.

Modified

For the createTransfer API:

  • Changed the BankAccountPaymentMethodDetail.holderAccountName field to bankAccountName.

Release date: Sep 28, 2022

Added

For the inquiryStatementList API:

  • Added the statementList.fundMoveDetail.receiveAccount field.

Removed

For the createTransfer API:

  • Removed the transferToDetail.transferToAmount.value field in the API request.

Release date: Aug 31, 2022

Enhanced

Added the inquiryAccount API.

Release date: Aug 30, 2022

Enhanced

For the inquiryAvailableCalendar API:

  • Added the forwardType field for supporting T+0 FX trading requests.

Release date: Aug 18, 2022

Fixed

For the inquiryStatementList API:

  • Fixed enumerations for the BeneficiaryAccountType and PayerAccountType fields.

Release date: Jul 1, 2022

Fixed

In the createDeal and unwindDeal interfaces:

the dealRequestId field is idempotent.

Release date: Jun 30, 2022

Fixed

For the inquiryStatementList API:

  • Fixed the description for the statementList.fundMoveDetail.beneficiaryAccountNo field.
  • Updated the enumeration for the statementList.fundMoveDetail.beneficiaryAccountTypefield.

Release date: Jun 29, 2022

Enhanced

  • Modified the result codes of the majority of the interfaces and classified the result codes into two categories: System-related result codes and business-related result codes.
  • Added result calling samples for the majority of the interfaces in multiple programming languages including Java, C#, Python, and JavaScript.

Fixed

For the inquiryStatementList API:

  • Clarified the descriptions for the following fields under the FundMoveDetail object: payerName, payerAccountNo, payerAccountType, beneficiaryName, beneficiaryAccountNo, beneficiaryAccountType, beneficiaryBankCountry, beneficiaryBankName.

For the inquiryBeneficiary API:

  • Added pageSize, pageNumber fields in the request.
  • Added totalCount, totalPageNumber, currentPageNumber fields in the response message.
  • Added REPEAT_REQ_INCONSISTENT to the result codes.

For the removeBeneficiary API:

  • Added BENEFICIARY_NOT_EXIST and REPEAT_REQ_INCONSISTENT to the result codes.

For the unwindDeal API:

  • In the request message, removed dealId and cancelCost fields. Added dealRequestId field.
  • Added the deal.cancelGain field in the response message.

For the inquiryDeal API:

  • In the request message, removed customerId and dealId fields. Added dealRequestId field.

For the createExchange, inquiryExchange, notifyExchange interfaces:

  • In the ExchangeForwardInfo object, removed the following fields: fxDealId, triggerSettleTime, compensatedAmount, marginAmount. Added the dealId field.
  • Updated descriptions for the transferToDetail.transferToMethod.paymentMethodType and transferToDetail.transferToMethod.paymentMethodId field.
  • Added enumeration for the paymentMethodType field and ACM enumeration for the PurposeCode field.

For the createExchange API:

  • Added sample codes for the forward rate scenario.
  • For the inquiryExchange API:Removed the customerId and accessToken fields in the request message.

For the notifyExchange API:

  • Removed the transferToDetail.transferToFinishTime field.

Release date: May 16, 2022

The first version of this documentation is released.