--- title: "API Changelog Archive" source_url: https://docs.rapyd.net/en/api-changelog-archive.html lang: en --- # API Changelog Archive Additions and updates to the API. Unless explicitly stated otherwise, all changes are backward compatible and non-breaking. For a list of deprecated APIs, see [API Deprecation Policy](https://docs.rapyd.net/en/api-deprecation-policy.md "API Deprecation Policy"). > **Note:** > > Lists the updates before 2025. For recent changelog data, see [API Changelog](https://docs.rapyd.net/en/api-changelog.md "API Changelog"). #### December 2024 - Enhancements - [Delete Wallet](https://docs.rapyd.net/en/delete-wallet.md "Delete Wallet") - New requirement: Close virtual accounts. Effective in both sandbox and production. - [Delete Virtual Account](https://docs.rapyd.net/en/delete-virtual-account.md "Delete Virtual Account") - New requirement: No transactions can be on hold for compliance review. #### November 2024 - New Pages - [Upload Documents](https://docs.rapyd.net/en/upload-documents.md "Upload Documents") - Methods for uploading and managing documents to payouts. - Enhancements - [Delete Wallet](https://docs.rapyd.net/en/delete-wallet.md "Delete Wallet") - New requirement: Close virtual accounts. (Sandbox only). - [Initiate Merchant Query](https://docs.rapyd.net/en/initiate-merchant-query.md "Initiate Merchant Query") - Updated phone number format. #### October 2024 - New fields or objects - [Wallet](https://docs.rapyd.net/en/wallet.md "Wallet") branch - New `parent_ewallet` field. Effective in both sandbox and production. - New Pages - [Simulating a Payout Returned Status](https://docs.rapyd.net/en/simulating-a-payout-returned-status.md "Simulating a Payout Returned Status") - Simulate the action of a third party that is required for returning the payout. - [Update Beneficiary](https://docs.rapyd.net/en/update-beneficiary.md "Update Beneficiary") - Update a beneficiary with additional fields. - [Recurring Digital Wallet Payments](https://docs.rapyd.net/en/recurring-digital-wallet-payments.md "Recurring Digital Wallet Payments") - Settings for subsequent [Create Payment](https://docs.rapyd.net/en/create-payment.md "Create Payment") and hosted checkout page payments via digital wallets. - Enhancements - [List Payout Method Types](https://docs.rapyd.net/en/list-payout-method-types.md "List Payout Method Types") - Updated the endpoint and enhanced the response data. - [Creating a Card Payment With 3DS Authentication - External 3DS](https://docs.rapyd.net/en/creating-a-card-payment-with-3ds-authentication---external-3ds.md "Creating a Card Payment With 3DS Authentication - External 3DS") - Removed the `tavv` and `xid` fields. - [Card Network Lookup Service](https://docs.rapyd.net/en/card-network-lookup-service.md "Card Network Lookup Service") branch - Documentation improvements. - Cryptocurrency transactions: - [Create Payment](https://docs.rapyd.net/en/create-payment.md "Create Payment") - Added a description and examples. - [Payment Errors](https://docs.rapyd.net/en/payment-errors.md "Payment Errors") - Added ERROR_CRYPTOCURRENCY_PURCHASE_TRANSACTION. #### September 2024 - New webhooks - [Payment Updated Webhook](https://docs.rapyd.net/en/payment-updated-webhook.md "Payment Updated Webhook") - Notifies the client that a payment was updated using [Update Payment](https://docs.rapyd.net/en/update-payment.md "Update Payment"). - New fields or objects - Webhook Root Parameters - Added the `extended_timestamp` field. Effective in both sandbox and production. - Enhancements - [Add Contact to Wallet](https://docs.rapyd.net/en/add-contact-to-wallet.md "Add Contact to Wallet") and [Update Wallet Contact](https://docs.rapyd.net/en/update-wallet-contact.md "Update Wallet Contact") - `date_of_birth` request parameter: Added the YYYY-MM-DD format. Effective in both sandbox and production. - [Retrieve Card Eligibility Details](https://docs.rapyd.net/en/retrieve-card-eligibility-details.md "Retrieve Card Eligibility Details") - Request Body Parameters: Changed `card_token` to `card_id`. - [Create Extended Beneficiary](https://docs.rapyd.net/en/create-extended-beneficiary.md "Create Extended Beneficiary") - Updated the date of incorporation format. #### August 2024 - New webhooks - [Wallet Status Changed Webhook](https://docs.rapyd.net/en/wallet-status-changed-webhook.md "Wallet Status Changed Webhook") - Notifies the client that the status of a wallet changed. - [Wallet Closed Webhook](https://docs.rapyd.net/en/wallet-closed-webhook.md "Wallet Closed Webhook") - Notifies the client that the wallet status is permanently closed (CLO). - [Virtual Account Status Webhook](https://docs.rapyd.net/en/virtual-account-status-webhook.md "Virtual Account Status Webhook") - Notifies the client that the status of a virtual account changed. - Breaking change - [Retrieve Virtual Account Transaction](https://docs.rapyd.net/en/retrieve-virtual-account-transaction.md "Retrieve Virtual Account Transaction") - The response includes the remitter details. [Retrieve Remitter Details](https://docs.rapyd.net/en/retrieve-remitter-details.md "Retrieve Remitter Details") is deprecated. Effective in production from August 13, 2024. - New fields or objects - [Create Checkout Page](https://docs.rapyd.net/en/create-checkout-page.md "Create Checkout Page") - Added the `recurrence_type` and the `require_card_cvv` fields. - [Create Beneficiary Tokenization Page](https://docs.rapyd.net/en/create-beneficiary-tokenization-page.md "Create Beneficiary Tokenization Page") - Added the `beneficiary_extended_fields` field. - New pages - [Card Network Lookup Service](https://docs.rapyd.net/en/card-network-lookup-service.md "Card Network Lookup Service") - New branch. - [Verify Direct API Solution](https://docs.rapyd.net/en/verify-direct-api-solution.md "Verify Direct API Solution") - New guide. - Enhancements - [Add Contact to Wallet](https://docs.rapyd.net/en/add-contact-to-wallet.md "Add Contact to Wallet") and [Update Wallet Contact](https://docs.rapyd.net/en/update-wallet-contact.md "Update Wallet Contact") - `date_of_birth` request parameter: Added the YYYY-MM-DD format (Sandbox only). #### July 2024 - New endpoints. The deprecated endpoints are supported until March 31, 2025. - [Retrieve Card Eligibility Details](https://docs.rapyd.net/en/retrieve-card-eligibility-details.md "Retrieve Card Eligibility Details") - Retrieve card eligibility for Original Credit Transactions (OCT) and Account Funding Transactions (AFT). - [Add Card to Google Pay - Google Pay Push Provisioning](https://docs.rapyd.net/en/add-card-to-google-pay---google-pay-push-provisioning.md "Add Card to Google Pay - Google Pay Push Provisioning") - Add a card to a Google Pay wallet using Google Pay Push Provisioning. - [Payout](https://docs.rapyd.net/en/payout.md "Payout") - Create a beneficiary that includes all compliance related data for payouts. - Breaking change - [Create Payment](https://docs.rapyd.net/en/create-payment.md "Create Payment") - In production, the default value of `save_payment_method` is **false**. This now matches the sandbox behavior. - [Retrieve Virtual Account Transaction](https://docs.rapyd.net/en/retrieve-virtual-account-transaction.md "Retrieve Virtual Account Transaction") - The response includes the remitter details. [Retrieve Remitter Details](https://docs.rapyd.net/en/retrieve-remitter-details.md "Retrieve Remitter Details") is deprecated. Effective in the sandbox from July 16, 2024. - New fields or objects - [Payout](https://docs.rapyd.net/en/payout.md "Payout") and [Beneficiary](https://docs.rapyd.net/en/beneficiary.md "Beneficiary") methods - `bin_details` object added to the relevant response parameters. - [Add Payment Method to Customer](https://docs.rapyd.net/en/add-payment-method-to-customer.md "Add Payment Method to Customer") - Option to define `currency` in `payment_method_options` object. Also available in [Create Customer](https://docs.rapyd.net/en/create-customer.md "Create Customer") with payment method. - New errors - [Foreign Exchange Errors](https://docs.rapyd.net/en/foreign-exchange-errors.md "Foreign Exchange Errors") - ERROR_GET_FX_RATE Effective in the sandbox from the week of July 14, 2024, and in production from the week of July 28, 2024. - Enhancements - [Transaction Types](https://docs.rapyd.net/en/transaction-types.md "Transaction Types")- Added the `PayoutReturnCredit` transaction type. - [Create Payout](https://docs.rapyd.net/en/create-payout.md "Create Payout") - Added the `returned` status. - [Payout Returned Webhook](https://docs.rapyd.net/en/payout-returned-webhook.md "Payout Returned Webhook") - Updated the scenarios when the webhook is sent. - [Get FX Rate](https://docs.rapyd.net/en/get-fx-rate.md "Get FX Rate") - Added note: In the sandbox, the FX rate is based on test data. - [Card Numbers for Testing Payouts](https://docs.rapyd.net/en/card-numbers-for-testing-payouts.md "Card Numbers for Testing Payouts") - New page that includes card numbers for simulating payouts and payout errors. #### June 2024 - New endpoints. The deprecated endpoints are supported until March 31, 2025. - [Put Funds on Hold](https://docs.rapyd.net/en/put-funds-on-hold.md "Put Funds on Hold") - [Release On-Hold Funds](https://docs.rapyd.net/en/release-on-hold-funds.md "Release On-Hold Funds") - Breaking change - [Get FX Rate](https://docs.rapyd.net/en/get-fx-rate.md "Get FX Rate") - FX rates are dynamic, not daily. - New endpoint. The deprecated endpoint is supported until March 31, 2025. - New fields or objects - [Create Checkout Page](https://docs.rapyd.net/en/create-checkout-page.md "Create Checkout Page") - Added the `required_customer_fields` object and the `payment_method_required_fields` object. - New errors - [Payment Errors](https://docs.rapyd.net/en/payment-errors.md "Payment Errors") - ERROR_CREATE_PAYMENT_CUSTOMER_NOT_PRESENT - Enhancements - [Change Wallet Status](https://docs.rapyd.net/en/change-wallet-status.md "Change Wallet Status") - Marked the `status` request path parameter as required. - [Delete Wallet Account Limit](https://docs.rapyd.net/en/delete-wallet-account-limit.md "Delete Wallet Account Limit") - Changed the body parameters to request query parameters. #### May 2024 - New Webhook - [Duplicate Contact Webhook](https://docs.rapyd.net/en/duplicate-contact-webhook.md "Duplicate Contact Webhook") - Notifies the client that an existing contact has been duplicated. - Breaking change - [Create Payment](https://docs.rapyd.net/en/create-payment.md "Create Payment") - In the sandbox, the default value of `save_payment_method` is **false**. When `save_payment_method` is **false**, the values of `payment_method` and `payment_method_data.id` in the response are **null**. - [Create Rapyd Verify Application](https://docs.rapyd.net/en/create-rapyd-verify-application.md "Create Rapyd Verify Application") - The request body `country` parameter must match the wallet contact `country` parameter. - [Verify Identity](https://docs.rapyd.net/en/verify-identity.md "Verify Identity") - The request body `country` parameter must match the wallet contact `country` parameter. - [Create Identity Verification Page](https://docs.rapyd.net/en/create-identity-verification-page.md "Create Identity Verification Page") - The request body `country` parameter is required and must match the wallet contact `country` parameter. - New fields - [Create Payment Link](https://docs.rapyd.net/en/create-payment-link.md "Create Payment Link") - Added a field for indicating the the maximum number of times the payment link can be used. #### April 2024 - Breaking change - [Create Wallet](https://docs.rapyd.net/en/create-wallet.md "Create Wallet") - `country` field in `contact` object will be required in this method. Effective in the sandbox from the week of April 15, 2024, and in production from the week of May 6, 2024. - New endpoints. The old endpoints are deprecated but still supported. - [Transfer Funds Between Wallets](https://docs.rapyd.net/en/transfer-funds-between-wallets.md "Transfer Funds Between Wallets") - [Set Transfer Response](https://docs.rapyd.net/en/set-transfer-response.md "Set Transfer Response") - [Create Subscription by Hosted Page](https://docs.rapyd.net/en/create-subscription-by-hosted-page.md "Create Subscription by Hosted Page") - Enhancements - [Update Wallet Contact](https://docs.rapyd.net/en/update-wallet-contact.md "Update Wallet Contact") - Added the fields that can be updated only once. - [Create Payment Link](https://docs.rapyd.net/en/create-payment-link.md "Create Payment Link") - Added support for FX payments. - Removed the `org_id` response parameter from code examples and descriptions. #### March 2024 - Breaking change - [Create Wallet](https://docs.rapyd.net/en/create-wallet.md "Create Wallet") - `country` field in `contact` object will be required in this method. Effective in the sandbox from the week of April 15, 2024, and in production from the week of May 6, 2024. - New limitation - [List Payouts](https://docs.rapyd.net/en/list-payouts.md "List Payouts") - Maximum returned payouts is 1000. - New fields - [Create Payment](https://docs.rapyd.net/en/create-payment.md "Create Payment") - `payment_account_reference` (response) - New pages - [Creating a Card Payment With 3DS Authentication - External 3DS](https://docs.rapyd.net/en/creating-a-card-payment-with-3ds-authentication---external-3ds.md "Creating a Card Payment With 3DS Authentication - External 3DS") - Enhancements - [Payment Method Types](https://docs.rapyd.net/en/payment-method-types.md "Payment Method Types") - Added a table summarizing the most prominent payment methods. - [Create Checkout Page](https://docs.rapyd.net/en/create-checkout-page.md "Create Checkout Page") - `cart_items` supports discounts. #### February 2024 - New limitation - [Transfer Funds Between Wallets](https://docs.rapyd.net/en/transfer-funds-between-wallets.md "Transfer Funds Between Wallets") - No longer available to client wallets of type **collect**. - New fields - Wallet transactions - `subtype` - [Issue Virtual Account to Wallet](https://docs.rapyd.net/en/issue-virtual-account-to-wallet.md "Issue Virtual Account to Wallet") - `branch_code` (response) - New pages - [Creating a Payment with Apple Pay (decrypted)](https://docs.rapyd.net/en/creating-a-payment-with-apple-pay--decrypted-.md "Creating a Payment with Apple Pay (decrypted)") #### January 2024 - New API methods - [Delete Virtual Account](https://docs.rapyd.net/en/delete-virtual-account.md "Delete Virtual Account") - Updated API methods - [Cancel Subscription](https://docs.rapyd.net/en/cancel-subscription.md "Cancel Subscription") - `cancel_at_period_end` is now a query parameter. - [Create Subscription](https://docs.rapyd.net/en/create-subscription.md "Create Subscription") - `simultaneous_invoice` default value is changed to **true**. - [List Issued Cards](https://docs.rapyd.net/en/list-issued-cards.md "List Issued Cards") - Added the following query parameters: - `activation_end_date` - `activation_start_date` - `creation_end_date` - `creation_start_date` - `status` - [List Virtual Accounts by Rapyd Wallet](https://docs.rapyd.net/en/list-virtual-accounts-by-rapyd-wallet-365103.md "List Virtual Accounts by Rapyd Wallet") - Now available in production. - [Set Wallet Account Limit](https://docs.rapyd.net/en/set-wallet-account-limit.md "Set Wallet Account Limit") - Updated endpoint. - [Delete Wallet Account Limit](https://docs.rapyd.net/en/delete-wallet-account-limit.md "Delete Wallet Account Limit") - Updated endpoint. - [Update Wallet Contact](https://docs.rapyd.net/en/update-wallet-contact.md "Update Wallet Contact") - The following fields are no longer modifiable: - `country` - `date_of_birth` - `first_name` - `identification_number` - `identification_type` - `last_name` - `nationality` - [Simulating Cardholder Disputes](https://docs.rapyd.net/en/simulating-cardholder-disputes.md "Simulating Cardholder Disputes") - new field `payment_method_options.3d_required` - New fields - **Virtual account** - `branch_code` - see [Issue Virtual Account to Wallet](https://docs.rapyd.net/en/issue-virtual-account-to-wallet.md "Issue Virtual Account to Wallet"). - **Payout** - see [List Payouts](https://docs.rapyd.net/en/list-payouts.md "List Payouts"). - `gc_error_code` - `batch_file` - New pages - [Request Rate Limits](https://docs.rapyd.net/en/request-rate-limits.md "Request Rate Limits") - [Creating a Payment with a European Card on File](https://docs.rapyd.net/en/creating-a-payment-with-a-european-card-on-file.md "Creating a Payment with a European Card on File") - [Saving a European Card While Creating a Payment](https://docs.rapyd.net/en/saving-a-european-card-while-creating-a-payment.md "Saving a European Card While Creating a Payment") #### December 2023 - New API methods - [Create Subscription by Hosted Page](https://docs.rapyd.net/en/create-subscription-by-hosted-page.md "Create Subscription by Hosted Page") - Updated API methods - [Create Subscription](https://docs.rapyd.net/en/create-subscription.md "Create Subscription") - [Update Wallet](https://docs.rapyd.net/en/update-wallet.md "Update Wallet") - New statuses - Wallet - CLO (closed) - New fields - Invoice - `automatic_attempt_count` - `discount_amount` - Subscription - `enable_retries` - `retry_options` - Updated Finite State Diagrams - [Listing Wallets](https://docs.rapyd.net/en/listing-wallets.md "Listing Wallets") - New manuals - POSitive App Guide - archived 2026-03 - [Rapyd App Guide](https://docs.rapyd.net/en/rapyd-app-guide.md "Rapyd App Guide") #### November 2023 - New information - [Versioning for API Methods](https://docs.rapyd.net/en/versioning-for-api-methods.md "Versioning for API Methods") - [API Deprecation Policy](https://docs.rapyd.net/en/api-deprecation-policy.md "API Deprecation Policy") - Deprecated API methods - **Disable Wallet** - replaced by [Change Wallet Status](https://docs.rapyd.net/en/change-wallet-status.md "Change Wallet Status") but still supported. - **Enable Wallet** - replaced by [Change Wallet Status](https://docs.rapyd.net/en/change-wallet-status.md "Change Wallet Status") but still supported. - New webhooks - [Transfer Request Updated Webhook](https://docs.rapyd.net/en/transfer-request-updated-webhook.md "Transfer Request Updated Webhook") - New manuals - [Payment Terminal Troubleshooting Guide](https://docs.rapyd.net/en/payment-terminal-troubleshooting-guide.md "Payment Terminal Troubleshooting Guide") #### October 2023 - New endpoints. The old endpoints are deprecated but still supported. - [Get Payment Method Required Fields](https://docs.rapyd.net/en/get-payment-method-required-fields.md "Get Payment Method Required Fields") - [List Payout Method Types](https://docs.rapyd.net/en/list-payout-method-types.md "List Payout Method Types") - [Get Payout Required Fields](https://docs.rapyd.net/en/get-payout-required-fields.md "Get Payout Required Fields") - [Create Wallet](https://docs.rapyd.net/en/create-wallet.md "Create Wallet") - [Update Wallet](https://docs.rapyd.net/en/update-wallet.md "Update Wallet") - [List Wallets](https://docs.rapyd.net/en/list-wallets.md "List Wallets") - [Retrieve Wallet](https://docs.rapyd.net/en/retrieve-wallet.md "Retrieve Wallet") - [Delete Wallet](https://docs.rapyd.net/en/delete-wallet.md "Delete Wallet") - [List Wallet Transactions](https://docs.rapyd.net/en/list-wallet-transactions.md "List Wallet Transactions") - [Retrieve Balances of Wallet Accounts](https://docs.rapyd.net/en/retrieve-balances-of-wallet-accounts.md "Retrieve Balances of Wallet Accounts") - [Retrieve Details of Wallet Transaction](https://docs.rapyd.net/en/retrieve-details-of-wallet-transaction.md "Retrieve Details of Wallet Transaction") - [Change Wallet Status](https://docs.rapyd.net/en/change-wallet-status.md "Change Wallet Status") - New endpoint - [Update Requested Currency](https://docs.rapyd.net/en/update-requested-currency.md "Update Requested Currency") - Deprecated endpoints. These endpoints are deprecated but still supported. - **Disable Wallet** - **Enable Wallet** - Updated webhook: - [Application Status Change Webhook](https://docs.rapyd.net/en/application-status-change-webhook.md "Application Status Change Webhook") - new values for `status` field. - Payout Returned webhook - removed - Wallet transactions - new statuses **HLD REJ PEN**. See [Transfer Funds Between Wallets](https://docs.rapyd.net/en/transfer-funds-between-wallets.md "Transfer Funds Between Wallets"). - New parameter `requested_currency` - see [Issue Virtual Account to Wallet](https://docs.rapyd.net/en/issue-virtual-account-to-wallet.md "Issue Virtual Account to Wallet").