API list

2023-10-26 09:17

The following table demonstrates a list of interfaces available after completing the integration process:

Account management

Interface name	Description	Endpoint	Direction
inquiryAccount	Inquire about the account information	/amsin/api/v1/business/account/inquiryAccount	Partner > WorldFirst
inquiryBalance	Inquire about prefunding balance.	/amsin/api/v1/business/account/inquiryBalance	Partner > WorldFirst
inquiryAvailableQuota	Inquire about available quota for declaration.	/amsin/api/v1/business/account/inquiryAvailableQuota	Partner > WorldFirst
notifyVostro	Receive prefunding notification.	To be provided by the Partner.	WorldFirst > Partner

Statement management

Interface name	Description	Endpoint	Direction
inquiryStatementList	Obtain statements lists.	/amsin/api/v1/business/account/inquiryStatementList	Partner > WorldFirst

Trade order submission

Interface name	Description	Endpoint	Direction
submitTradeOrder	Submit trade orders.	/amsin/api/v1/business/account/submitTradeOrder	Partner > WorldFirst
inquiryTradeOrder	Inquiry about the submission result of trade orders.	/amsin/api/v1/business/account/inquiryTradeOrder	Partner > WorldFirst
notifyTradeOrder	Receive notifications about the submission results.	/amsin/api/v1/business/account/notifyTradeOrder	WorldFirst > Partner
submitAttachment	Submit the attachment required by the submitTradeOrder API.	/amsin/api/v1/business/account/submitAttachment	Partner > WorldFirst
Receive association result notification	Receive notifications about association results.	To be provided by the Partner.	WorldFirst > Partner

FX quotes

Interface name	Description	Endpoint	Direction
inquiryRate	Request a foreign exchange rate.	/amsin/api/v1/business/fund/inquiryRate	Partner > WorldFirst
inquiryAvailableCalendar	Get a date that is available for making an exchange.	/amsin/api/v1/business/fund/inquiryAvailableCalendar	Partner > WorldFirst
createQuote	Request a direct quote.	/amsin/api/v1/business/fund/createQuote	Partner > WorldFirst

FX deals

Interface name	Description	Endpoint	Direction
Create forward deals	Create a forward deal.	/amsin/api/v1/business/fund/createDeal	Partner > WorldFirst
Unwind forward deals	Unwind a forward deal.	/amsin/api/v1/business/fund/unwindDeal	Partner > WorldFirst
Inquire forward deals	Inquire about the result of the forward deal.	/amsin/api/v1/business/fund/inquiryDeal	Partner > WorldFirst
Notify forward deals	Receive notifications about the forward deal.	To be provided by the Partner.	WorldFirst > Partner

FX settlements

Interface name	Description	Endpoint	Direction
Create settlements	Create a settlement request with either spot rates or forward rates. an on-spot or forward exchange request.	/amsin/api/v1/business/fund/createExchange	Partner > WorldFirst
Inquire settlements	Inquire about the settlement result.	/amsin/api/v1/business/fund/inquiryExchange	Partner > WorldFirst
Notify settlements	Receive notifications about the settlement result.	To be provided by the Partner.	WorldFirst > Partner

Beneficiary management

Interface name	Description	Endpoint	Direction
inquiryBeneficiaryTemplate	Obtain templates for beneficiaries.	/amsin/api/v1/business/account/inquiryBeneficiaryTemplate	Partner > WorldFirst
bindBeneficiary	Bind the beneficiary's bank card.	/amsin/api/v1/business/account/bindBeneficiary	Partner > WorldFirst
inquiryBeneficiaryList	Obtain a list of existing beneficairies.	/amsin/api/v1/business/account/inquiryBeneficiaryList	Partner > WorldFirst
removeBeneficiary	Remove a beneficiary.	/amsin/api/v1/business/account/removeBeneficiary	Partner > WorldFirst

Fund transfer

Interface name	Description	Endpoint	Direction
consultTransfer	Consult expected transfer result	/amsin/api/v1/business/fund/consultTransfer	Partner > WorldFirst
createTransfer	Create a transfer request	/amsin/api/v1/business/fund/createTransfer	Partner > WorldFirst
inquiryTransfer	Check transfer result	/amsin/api/v1/business/fund/inquiryTransfer	Partner > WorldFirst
notifyTransfer	Receive transfer result notification	To be provided by the Partner.	WorldFirst > Partner

Fund payout

Interface name	Description	Endpoint	Direction
consultPayout	Consult expected payout result	/amsin/api/v1/business/fund/consultPayout	Partner > WorldFirst
createPayout	Create a payout request	/amsin/api/v1/business/fund/createPayout	Partner > WorldFirst
inquiryPayout	Check payout result	/amsin/api/v1/business/fund/inquiryPayout	Partner > WorldFirst
notifyPayout	Receive payout result notification	To be provided by the Partner.	WorldFirst > Partner

Invoicing

Interface name	Description	Endpoint	Direction
createInvoice	Create an invoice	/amsin/api/v1/business/fund/createInvoice	Partner > WorldFirst
notifyInvoice	Receive invoice payment notification	To be provided by the Partner.	WorldFirst > Partner
queryInvoice	Inquire about invoice payment result	/amsin/api/v1/business/fund/queryInvoice	Partner > WorldFirst

Authorization

Interface name	Description	Endpoint	Direction
applyToken	Apply for access token	/amsin/api/v1/oauth/applyToken	Partner > WorldFirst
refreshToken	Refresh or prolong access token	/amsin/api/v1/oauth/applyToken	Partner > WorldFirst
revokeToken	Revoke access token	/amsin/api/v1/oauth/revokeToken	Partner > WorldFirst

User management

Interface name	Description	Endpoint	Direction
inquirySubuser	Inquire about subuser information.	/amsin/api/v1/business/user/inquirySubuser	Partner > WorldFirst

Store management

Interface name	Description	Endpoint	Direction
inquiryStore	Inquire about information about store and the associated account.	/amsin/api/v1/business/store/inquiryStore	Partner > WorldFirst