Request fields such as currency (and similar fields like priceCurrency and claimMoneyCurrency) must use one of the three-letter codes below. Any other currency returns errCode 801001 (currency error).
Currency codes follow ISO 4217. The current code lists are published by the standard’s maintenance agency, SIX. The table below is the subset the platform currently accepts globally — not the full ISO 4217 list.
| Currency | Code | Notes |
|---|
| US Dollar | USD | |
| Canadian Dollar | CAD | |
| Euro | EUR | Also used by Croatia, Montenegro, Kosovo, etc. |
| Australian Dollar | AUD | |
| British Pound | GBP | |
| Japanese Yen | JPY | |
| UAE Dirham | AED | |
| Saudi Riyal | SAR | |
| Bahraini Dinar | BHD | |
| Kuwaiti Dinar | KWD | |
| Brazilian Real | BRL | |
| Danish Krone | DKK | |
| Swedish Krona | SEK | |
| Polish Zloty | PLN | |
| Norwegian Krone | NOK | |
| Mexican Peso | MXN | |
| New Zealand Dollar | NZD | |
| Country | Full name | Code |
|---|
| United States | United States of America | US |
| Canada | Canada | CA |
| United Kingdom | United Kingdom of Great Britain and Northern Ireland | GB |
| France | French Republic | FR |
| Germany | Federal Republic of Germany | DE |
| Italy | Italian Republic | IT |
| Spain | Kingdom of Spain | ES |
| Japan | Japan | JP |
| China | People’s Republic of China | CN |
| Australia | Australia | AU |
| New Zealand | New Zealand | NZ |
| India | India | IN |
| Brazil | Brazil | BR |
| South Africa | Republic of South Africa | ZA |
| Russia | Russian Federation | RU |
| South Korea | Republic of Korea | KR |
| Mexico | United Mexican States | MX |
| United Arab Emirates | United Arab Emirates | AE |
| Saudi Arabia | Kingdom of Saudi Arabia | SA |
| Unit | Abbreviation |
|---|
| Cubic meter | m3 |
| Liter | L |
| Milliliter | mL |
| Cubic centimeter | cm3 |
| Cubic millimeter | mm3 |
| Cubic kilometer | km3 |
| Cubic foot | ft3 |
| Cubic inch | in3 |
| Gallon | gal |
| Barrel | bbl |
| Fluid ounce | fl oz |
| Pint | pt |
| Quart | qt |
| Hectoliter | hl |
| Microliter | uL |
| Unit | Abbreviation |
|---|
| Gram | g |
| Kilogram | kg |
| Milligram | mg |
| Ton | t |
| Ounce | oz |
| Pound | lb |
| Carat | ct |
| Troy pound | lb t |
| Jin (Chinese unit, 500 g) | jin |
| Troy ounce | oz t |
| State | Value |
|---|
| Not shipped | UNSHIPED |
| Shipped | SHIPED |
| Delivered | DELIVERED |
The orderState field must use the following literals (the spelling is the contract — do not “fix” them to UNPAID / SHIPPED):
| State | Value |
|---|
| Unpaid | UNPAIED |
| Paid | PAIED |
| Not shipped | UNSHIPED |
| Shipped | SHIPED |
| Delivered | DELIVERED |
| Finished | FINISHED |
Query response fields: policyStatus (code), policyStatusDesc (Chinese text), and policyStatusDescEn (fixed English). Callbacks use the same codes on serviceState / serviceStateDesc.
- Query
policyStatusDesc is Chinese when the request is unchanged. Use policyStatusDescEn on the same row for English (no extra request field)
- Callback
serviceStateDesc defaults to English
- Query typically returns
1 / 2 / 3 / 5 / 8. The callback uses the same codes and may also send 7 (Expired)
| Code | policyStatusDesc / Chinese | policyStatusDescEn / English |
|---|
| 1 | 未投保 | Uninsured |
| 2 | 已投保 | Insured |
| 3 | 已生效 | Effective |
| 5 | 已退保 | Refunded |
| 7 | 已过保 | Expired |
| 8 | 已取消 | Cancelled |
| State | Value |
|---|
| INIT (no claim / initialized) | 0 |
| Under review | 1 |
| Paying out | 2 |
| Paid | 3 |
| Rejected | 4 |
| State | Value |
|---|
| Pending review | 1 |
| Review approved | 2 |
| Rejected | 3 |
| Plan | Value |
|---|
| One year | 1 Year |
| Two years | 2 Years |
| Three years | 3 Years |
| Value | Meaning | English |
|---|
| 1 | Damaged | Damage |
| 2 | Lost | Loss |
| 3 | Delay compensation | Package Delay |
| 4 | Return compensation | Return Compensation |
| 5 | Accidental damage | Accidental Damage |
| 6 | Electrical or mechanical failure | Electrical or Mechanical Failure |
| 7 | Design defect | Design Flaws |
Used by claimCompensationType / compensationMethod. The item-level claimpayoutType is deprecated (do not send it; it is no longer a contract field in the claim webhook either).
| Value | Description |
|---|
| 1 | Partial cash compensation |
| 2 | Full item-price compensation |
| 3 | Full item reshipment (at merchant cost) |
| 4 | Full item reshipment (full price) |
| 5 | Reship parts (at merchant cost) |
| 6 | Reship parts (full price) |
| 7 | Place a consumer order on behalf of the buyer |
| Method | Value |
|---|
| Cash payout (XMH channel) | 1 |
| Points (merchant-granted) | 2 |
| Gift card (merchant-granted) | 3 |
