The following transaction-level fields apply to all USD payments to the United States, regardless of payment rail or use case.
| Field | Description | Required | Type | Constraints |
|---|---|---|---|---|
purposeCode | Purpose of payment | Required | ENUM | See valid values below |
paymentMemo | Payment memo | Optional | STRING | 0–500 chars. Pattern: ^[\w #@!,.&()\/\\-]{0,500}$ |
The following constraints apply to address fields on identities used in US USD payments. The payout partner enforces stricter formatting than the base identity schema allows, so values that pass identity creation may still cause payment failures if the format does not match.
| Field | Description | Required | Type | Constraints |
|---|---|---|---|---|
stateOrProvince | State or territory | Required | STRING | Use the 2-letter USPS state abbreviation (for example, NY, CA, TX). Full state names such as New York are not accepted. For Puerto Rico, use Puerto Rico, not PR. Pattern: ^[A-Za-z]{2,25}$ |
| Code | Description |
|---|---|
ACCT | Account Management |
EDUC | Education |
FAMI | Family Support Related Payments |
FEES | Payment of Fees |
GDDS | Purchase or Sale of Goods |
INSU | Insurance Premium |
IVPT | Invoice Payment |
ROYA | Royalties |
SALA | Salary Payment |
SAVG | Savings |
SCVE | Purchase or Sale of Services |
UBIL | Utility Bill Payments |