API Deprecation Policy

Retiring or sunsetting obsolete features.

When Rapyd needs to introduce a breaking change, Rapyd initiates the deprecation process, which proceeds as follows:

Rapyd announces that the feature is deprecated. A notice will appear in the API Changelog and the API Reference, and Rapyd may also send email or add the notice to the developer newsletter. The notice will state the date that the feature will no longer be available, which is a reasonable period after the date of the notice.
During the notice period, the client is responsible for updating all code that is integrated with the feature. The deprecated feature will still be fully functional and documented in the API Reference.
At the end of the notice period, the feature becomes obsolete and will be removed from production and from the API Reference. This status is also known as end-of-life.

The following endpoints will be deprecated on December 31, 2024:

Table 1. Wallet-related Endpoints

Deprecated Endpoint	New Endpoint	Document Link
`GET /v1/user/wallets`	`GET /v1/ewallets`	List Wallets
`POST /v1/user`	`POST /v1/ewallets`	Create Wallet
`GET /v1/user/:ewallet`	`GET /v1/ewallets/:ewallet`	Retrieve Wallet
`PUT /v1/user`	`POST /v1/ewallets/:ewallet`	Update Wallet
`DELETE /v1/user/:ewallet`	`DELETE /v1/ewallets/:ewallet`	Delete Wallet
`PUT /v1/user/enable` `PUT /v1/user/disable`	`POST /v1/ewallets/:ewallet/statuses/:status`	Change Wallet Status
`GET /v1/user/:ewallet/transactions/:transaction`	`GET get/v1/ewallets/:wallet/transactions/:transaction`	Retrieve Details of Wallet Transaction
`GET /v1/user/:ewallet/accounts`	`GET /v1/ewallets/:ewallet/accounts`	Retrieve Balances of Wallet Accounts
`GET /v1/user/:ewallet/transactions`	`GET /v1/ewallets/:ewallet/transactions`	List Wallet Transactions
`POST /v1/user/:ewallet/account/limits`	`POST /v1/ewallets/:ewallet/account/limits`	Set Wallet Account Limit
`DELETE /v1/user/:ewallet/account/limits`	`DELETE /v1/ewallets/:ewallet/account/limits`	Delete Wallet Account Limit
`POST /v1/account/transfer`	`POST /v1/ewallets/transfer`	Transfer Funds Between Wallets
`POST /v1/account/transfer/response`	`POST /v1/ewallets/transfer/response`	Set Transfer Response

Table 2. Payout-related Endpoints

Deprecated Endpoint	New Endpoint	Document Link
`GET /v1/payouts/supported_types`	`GET /v1/payout_methods`	List Payout Method Types
`GET /v1/payouts/:payout_method_type/details`	`GET /v1/payout_methods/:payout_method_type/required_fields`	Get Payout Required Fields

Table 3. Payment-related Endpoints

Deprecated Endpoint	New Endpoint	Document Link
`GET /v1/payment_methods/required_fields/:type`	`GET /v1/payment_methods/:id/required_fields`	Get Payment Method Required Fields

The following table includes endpoints that are in multiple lines due to their length. Please ignore the line breaks.

Table 4. Virtual Account-related Endpoints

Deprecated Endpoint	New Endpoint	Document Link
`POST /v1/issuing/bankaccounts`	`POST /v1/virtual_accounts`	Issue Virtual Account to Wallet
`GET /v1/issuing/bankaccounts/:virtual_account`	`GET /v1/virtual_accounts/:virtual_account`	Retrieve Virtual Account History
`POST /v1/issuing/bankaccounts/:virtual_account`	`POST /v1/virtual_accounts/:virtual_account`	Update Requested Currency
`GET /v1/issuing/bankaccounts/capabilities/:country`	`GET /v1/virtual_accounts/capabilities/:country`	List Capabilities of Virtual Accounts
`GET` `/v1/issuing/bankaccounts/:virtual_account/transactions/` `:transaction`	`GET` `/v1/virtual_accounts/:virtual_account/transactions/` `:transaction`	Retrieve Virtual Account Transaction
`POST /v1/issuing/bankaccounts/bankaccounttransfertobankaccount`	`POST /v1/virtual_accounts/transactions`	Simulate a Bank Transfer to a Virtual Account
`GET /v1/issuing/bankaccounts/list`	`GET /v1/ewallets/:ewallet/virtual_accounts`	List Virtual Accounts by Rapyd Wallet
`GET /v1/issuing/bankaccounts/remitters/:virtual_account/transactions/:issuing_transaction_id`	`GET /v1/virtual_accounts/:virtual_account/transactions/:transaction`	Retrieve Virtual Account Transaction

The following endpoints will be deprecated on March 31, 2025:

Table 5. Localization-related Endpoints

Deprecated Endpoint	New Endpoint	Document Link
`GET /v1/rates/daily`	`GET /v1/fx_rates`	Get FX Rate

Table 6. Wallet-related Endpoints

Deprecated Endpoint	New Endpoint	Document Link
`POST /v1/account/balance/hold`	`POST /v1/ewallets/accounts/balance/hold`	Put Funds on Hold
`POST /v1/account/balance/release`	`POST /v1/ewallets/accounts/balance/release`	Release On-Hold Funds

In this section:

Documentation