Action Required: New paymentScheme Values for USD Payments

To provide greater clarity for USD payments, we are deprecating the WIRE and SWIFT payment schemes. They are being replaced by DOMESTIC_WIRE and INTERNATIONAL_WIRE respectively.

This update requires a change to your integration to use the new paymentScheme values.

Scheme Mapping

Deprecated Scheme	New paymentScheme	Description
`WIRE`	`DOMESTIC_WIRE`	For domestic USD wire transfers within the United States
`SWIFT`	`INTERNATIONAL_WIRE`	For international (cross-border) USD wire transfers

Implementation Timeline

Now: You can begin updating your integration to use the new paymentScheme values in preparation for the release.

October 8, 2025: Grace Period Begins

The new schemes (DOMESTIC_WIRE, INTERNATIONAL_WIRE) will be live on Sandbox and Production. For a two-week grace period, we will automatically map the deprecated schemes to the new ones during the creation of new payments and returns to ensure service continuity.

⚠️ Important: Grace Period Scope & Filtering

The automatic mapping during the grace period applies only to the creation of new transactions (e.g., POST /payments).

This mapping does not apply to filtering. Any integration that fetches data using the old schemes (e.g., GET /payments?paymentScheme=WIRE) will stop returning results.

You must update your filtering logic to use the new DOMESTIC_WIRE and INTERNATIONAL_WIRE schemes by this date.

October 22, 2025: Deprecation Complete After this date, API calls using the deprecated WIRE and SWIFT schemes will be rejected. You must use the new schemes for all USD payments.

Example API Update Update the paymentScheme field in your create payment and create return requests.

Before:

{
  "amount": "1000",
  "currency": "USD",
  "paymentScheme": "SWIFT",
}

After

{
  "amount": "1000",
  "currency": "USD",
  "paymentScheme": "INTERNATIONAL_WIRE",
}

Impact on Existing Data

Payees: All existing USD payees with WIRE access have been updated to DOMESTIC_WIRE. Payees with SWIFT access have been granted access to both SWIFT and INTERNATIONAL_WIRE.

Historical Payments: Historical payment records will be updated to reflect the new classification. This is a data change only and will not affect any completed transactions.

❗️
Important Note on Existing SWIFT Payees
Payees previously enabled for SWIFT will retain this access type to support potential future direct integrations with the SWIFT network. However, for now, all new international USD payments must use the new INTERNATIONAL_WIRE scheme.