WorldFirst DocsWorldFirst DocsDOCS

Release notes

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 WorldFirst 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.

@2024 WorldFirst