Change Log

2026.10.19

Common

• On a list query, X-Unit-Id: ALL returns the current merchant and all of its sub-merchants.

Global Account

• Open Global Account (opens new window) biz_type values are Collection, B2BCollection, DirectPayment. country and currency follow the business contact. Added platform AliExpress and response field iban. account_type is Current, Saving, or Checking.
• routing_info and fee_info are arrays.
• Global Account Notification (opens new window) status includes Suspend.
• List Global Accounts (opens new window) supports X-Unit-Id: ALL.

Shop

• Added platform AliExpress. site, currency, sales_category, application_type, and acquirer follow the shop template.
• store_id length is 32. legal_no is the shop owner's ID number.
• Update Shop (opens new window) is allowed only when the status is Rejected.
• Scopes are shop_write and shop_read. Shop Notification (opens new window) sends Approved and Rejected only.

Collection

• The funding source field is funding_sources.
• List Refunds (opens new window) status is Pending, Success, Cancel, Failure.
• WEBSTORE attachments require orders and shippingReceipt. B2B shippingReceipt is not required when account_purpose is 22 or 23.
• Transfer-In Notification (opens new window) includes account_no, funding_sources, and the full remitter_info.

Payee

• Scopes are payee_write and payee_read. Currency and country follow the payee template. account_country and reference are optional.
• A duplicate partner_payee_id returns the existing payee.
• Payee Notification (opens new window) sends Approved and Declined only.

CNY Repatriation

• Scopes are repatriation_write and repatriation_read.
• Contract order responses use state. Query values are Waiting Approval, Approved, and Rejected. The repatriation webhook maps those results to Success or Failure.
• Logistics Supplement Notification (opens new window) status is Approved or Rejected.
• Upload failure_reason and import order lists are arrays. software_name is a string.
• Available repatriation amount is calculated for the institution account. Notification order_type includes the B2B contract types.

FX

• Query FX Rate (opens new window) scope is fx_read. Supported currencies follow production.
• Batch Query FX Rate (opens new window) returns the rate array directly, without rate_id or expire_time.
• FX Order Notification (opens new window) sends Success or Failure. The failure reason is 下单失败.
• B_Fx_PartnerOderIdExistError means the partner_order_id already exists. The missing-order code is B_Fx_OrderNotExistError.

Transfer

• Scopes are transfer_write and transfer_read. Status is Pending, Success, or Failure. The notification sends Success and Failure only.
• A duplicate partner_order_id returns the existing transfer. The fee follows the commercial agreement.

Payment

• Scopes are payment_read and payment_write. The embedded payee object matches the Payee API.
• Status is Pending, Processing, Success, or Failure. Supported currencies follow production.
• A duplicate partner_order_id returns the existing payment.

2026.05.19

FX

• Added Batch Query FX Rate (opens new window): POST /fx/api/v1/batch/rate, query multiple currency pairs via query_list.

2026.01.15

Shop

• Create Shop (opens new window) Added shop_screenshot_file_id.
• Edit Shop (opens new window) Added shop_screenshot_file_id.

User

• Create User(V1) (opens new window) Added online_store_url, business_document, platform_screenshot.

• Edit User(V1) (opens new window) Added online_store_url, business_document, platform_screenshot.

• Create User(V2) (opens new window) Added online_store_url, BUSINESS_DOCUMENT, PLATFORM_SCREENSHOT.

• Edit User(V2) (opens new window) Added online_store_url, BUSINESS_DOCUMENT, PLATFORM_SCREENSHOT.

2025.11.03

Issuing

• Added Update Auth Limit (opens new window).

2025.07.07

Mock

• Added GlobalAccount Mock (opens new window).

2025.06.17

Payout

• Added Get Payment Limit (opens new window).
• Get Payment By ID (opens new window) Added tracking_number.
• Get Payment List (opens new window) Added tracking_number.
• Get Payment List (opens new window) Added tracking_number.
• Payment Notification (opens new window) Added tracking_number.

2025.06.10

CNY Repatriation

• Contract Order Add (opens new window) Added bank_bill_file.
• Contract Order Edit (opens new window) Added bank_bill_file.

2025.05.21

Global Account

• Global Account Notification (opens new window) Added pix_key.

2025.03.25

User

• User (opens new window) industry Added Food.

2025.03.18

Collection

• Collection Notification (opens new window) Added auto_exchanged.
• Get Collection List (opens new window) Added auto_exchanged.
• Get Collection By Id (opens new window) Added auto_exchanged.

Fx

• Get Fx Order By Id (opens new window) Added inbound_order_id.
• Get Fx Order List (opens new window) Added inbound_order_id.
• Fx Order Notification (opens new window) Added inbound_order_id.

2025.03.07

Template

• Added Payee Template.

Payee

• Create A New Payee (opens new window) Added legal_name.
• Edit Payee (opens new window) Added legal_name.
• Create A New Payment (opens new window) Added legal_name.

2024.12.24

Appendix

• Collection Attachment Notification (opens new window) Added unit_id.
• Collection Attachment Audit Result Notification (opens new window) Added unit_id.
• Collection Refund Notification (opens new window) Added unit_id.
• Get Collection Refund List (opens new window) Added unit_id.

2024.12.05

Appendix

• Added US Provinces (opens new window).
• Added IDR Provinces (opens new window).
• Added IDR Cities (opens new window).

2024.11.26

Collection

• Get Collection List (opens new window) Added biz_type.

2024.11.05

Shop

• Added Mercado Libre platform.

Global Account

• Added Mercado Libre platform.

Collection

• Added TransferIn Notification.

2024.10.22

Payment

• Added Get Bank List (opens new window).

2024.10.15

Repatriation

• Order Upload (opens new window) Added platform.
• Order Import (opens new window) Added platform.

2024.09.12

Payment

• Updated field purpose to be required.

2024.08.14

Issuing

• Updated Transactions response.

2024.07.12

Mock

• Added Refund Notification.

2024.07.10

• Added API online request.

2024.06.27

Shop

• Create Shop (opens new window) Added auth_file_id.

User

• v1 Create User (opens new window) Added operation_address.

2024.05.29

Report

• Added Report (opens new window).

2024.05.21

Collection

• Added Get Refund List (opens new window).
• Added Refund Notification (opens new window).

2024.05.06

Issuing

• Updated v2 version.

2024.04.18

GlobalAccount

• Added fee_info.

2024.04.02

Collection:

• Submit Attachment (opens new window) Added sender_info.

Balances:

• Added Add Get Current Balance List (opens new window).

Fx:

• Added Add Get Fx Order List (opens new window).

2024.03.21

Mock:

• Added Edit Global Account.

2024.03.13

Payment:

• If the Payer is PSP, the payer object must be not null.

2024.02.27

Issuing:

• Added Add Cardholder (opens new window).
• Added Query Cardholder detail (opens new window).

2024.02.05

Payee:

• If paymentMethods is set to US-USD-Local, the value of payee_info.province should be restricted to a specific list. The allowed list of provinces is ["Alabama", "Alaska", "Arizona", "Arkansas", "California", "Colorado", "Connecticut", "Delaware", "Florida", "Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan", "Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada", "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", "North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island", "South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Vermont", "Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming"].

2024.01.18

Shop:

• Shop (opens new window) Added fields: sales_category and application_type.
• Added Shop Template (opens new window), and the API must validate the fields of the Shop Template.
• Added Shop Notification (opens new window).
• Added Shop Response Fields.
• Added Mock Shop Notification (opens new window).

2024.01.16

Collection:

• Submit Attachment (opens new window) Added file_type fields: other.

2024.01.04

Payee:

• Payee (opens new window) Added field: payee_info.birthday.

2023.12.25

Collection:

• Collection Attachment Notification (opens new window) Added attachment_type: ContractOrder.

CNY Repatriation:

• Contract Order Add (opens new window) Added field: trade_goods.advanced_payment, trade_goods.trade_country, trade_goods.payer_type, trade_goods.inquiry_record_file, trade_goods.freight_record_file, trade_goods.last_order_doc_file.
• Added API: Contract Order Supplement Logistics (opens new window).
• Added Supplement Logistics Notification (opens new window).

2023.12.20

Mock:

• Added KYC Mock (opens new window).

2023.12.05

Global Account:

• Added API: Get Global Account WelcomeLetter (opens new window).