The following transaction-level fields apply to all CNY payments to China, regardless of the underlying payment rail (CNAPS or CUP).
To find the bank code for the destination bank, use the Bank Codes lookup (search by English bank name).
| Field | Description | Required | Type | Constraints |
|---|---|---|---|---|
purposeCode | Purpose of payment | Required | ENUM | See valid values below |
Chinese payment regulations require a supporting document (invoice or purchase order) for all CNY trade payments. This applies to CN_TRADE (B2B) and CN_INDIVIDUAL_TRADE (B2C) use cases with purpose codes GDDS (goods) or SCVE (services).
UI customers: Upload the invoice or purchase order directly in the payment submission flow.
API customers: Document attachment via the API is not yet available. Until this feature is released, coordinate invoice submission with your Ripple representative to ensure payments are not held by the partner or beneficiary bank.
Salary payments (CN_INDIVIDUAL, purpose code SALA or FAMI) are not subject to this requirement.
| Code | Description |
|---|---|
FAMI | Family support |
GDDS | Purchase or sale of goods |
SALA | Salary payment |
SCVE | Purchase or sale of services |
Unlike purposeCode, receiverRelationship is not required for all CNY payments. It applies only to individual-to-individual (C2B2C) family support payments (FAMI).
| Field | Description | Required | Type | Constraints |
|---|---|---|---|---|
receiverRelationship | Relationship to the debtor | Required for C2B2C FAMI payments | ENUM | See valid values below |
| Code | Description |
|---|---|
CHIL | Child |
GCHI | Grandchild |
GPAR | Grandparents |
PARE | Parent |
SELF | Self |
SIBL | Sibling |
SPOU | Covering spouse/partner |