Cross-border Enums

Use the titles below in your interface and send the exact codes in API requests. Values apply to both production and sandbox unless a section explicitly says otherwise. Currency, country, and collection availability still depend on the routes enabled for your account.

Purposes

purpose is required on every new request.

Title	Code
Salary	`salary`
Service payment	`service_payment`
Goods payment	`goods_payment`
Family support	`family_support`

Sub-purposes

subPurpose is required on every new request, including salary and family support. Every purpose accepts the same list below; choose the value that describes the payment. Missing, null, empty, or unsupported values return 400 VALIDATION_ERROR.

Title	Code
Clothes, bags and shoes	`clothes_bags_shoes`
Daily supplies and cosmetics	`daily_supplies_and_cosmetics`
Electronics and home appliances	`electronics_and_home_appliances`
Toys, kids and babies	`toys_kids_babies`
Interpretation service	`interpretation_service`
Translation service	`translation_service`
Human resources service	`human_resource_service`
Estate agency service	`estate_agency_service`
Software development service	`software_development_service`
Web design or development service	`web_design_or_development_service`
Legal drafting service	`drafting_legal_service`
Legal certification service	`legal_related_certification_service`
Accounting service	`accounting_service`
Tax service	`tax_service`
Architectural and decoration design service	`architectural_decoration_design_service`
Advertising service	`advertising_service`
Market research service	`market_research_service`
Exhibition booth service	`exhibition_booth_service`
Other service	`other_service`

Collection methods

Use chargeDetails.method. Both methods are supported in production and sandbox, subject to account collection availability.

Title	Code
Mobile money	`momo`
Bank transfer	`bank`

Both methods require firstName, lastName, country, and email. Mobile money also requires phoneNumber and momoOperatorId; omit these two fields for bank collections.

Payout methods

Use payoutDetails.method when creating a beneficiary. This selects how the recipient is paid, independently of the collection method.

Title	Code
Bank transfer	`bank`
Alipay	`alipay`

Alipay requires an individual sender and beneficiary. See China processing hours.

Request types

Use requestType on request creation.

Title	Code
Transfer	`transfer`

Currencies

Title	Code	API field
Kenyan shilling	`KES`	`chargeCurrency` on requests; `senderCurrency` on quotes
Nigerian naira	`NGN`	`chargeCurrency` on requests; `senderCurrency` on quotes
Chinese yuan	`CNY`	`receiverCurrency`

Sender and beneficiary types

Use type when registering a sender or beneficiary.

Title	Code
Individual	`individual`
Business	`business`

Identity document types

Use idType. Individuals use a passport or national ID with idNumber; businesses use a business registration number with registrationNumber.

Title	Code
Passport	`passport`
National ID	`national-id`
Business registration number	`business-registration-number`

Supporting document types

Use type when uploading a supporting document. The request's requiredDocuments determines which types are required; file format is specified separately by its MIME type.

Title	Code
Proforma Invoice	`proforma_invoice`
Contract	`contract`

See supporting documents for required groups, replacement, and submission.

Request statuses

These values appear in request status and crossborder_updated events. See status, webhooks and retries for the meaning and next action for each status.

Title	Code
Documents required	`documents_required`
Documents submitted	`documents_submitted`
Documents rejected	`documents_rejected`
Documents approved	`documents_approved`
Pending charge	`pending_charge`
Charge initiated	`charge_initiated`
Charge successful	`charge_successful`
Charge failed	`charge_failed`
Payout initiated	`payout_initiated`
Payout successful	`payout_successful`
Payout failed	`payout_failed`
Refund initiated	`refund_inititated`
Refund successful	`refund_successful`
Refund failed	`refund_failed`
Closed	`closed`

refund_inititated is the exact API spelling. Request statuses differ from a payment transaction's chargeStatus.

Quote statuses

These values appear in quote status. Use expiresAt separately: an active quote may already have expired. See Cross-border Quotes.

Title	Code	Meaning
Active	`active`	Not consumed; usable only before `expiresAt` and for matching request details
Consumed	`consumed`	Used for a charge attempt; cannot be reused

Transaction statuses

A charge or payout transaction uses chargeStatus. A successful charge alone does not confirm beneficiary payout.

Title	Code
Pending	`pending`
Successful	`successful`
Failed	`failed`

Sandbox document outcomes

Use optional outcome on the sandbox POST /documents/submit endpoint only.

Title	Code
Approve documents	`documents_approved`
Reject documents	`documents_rejected`

Omit outcome to leave the submission awaiting review. Do not send it to production. See the sandbox testing guide for full scenarios and payment test values.