Documentation

Upload Documents - Methods for uploading and managing documents to payouts.

Delete Wallet - New requirement: Close virtual accounts. (Sandbox only).

Initiate Merchant Query - Updated phone number format.

Wallet branch - New parent_ewallet field.

Effective in both sandbox and production.

Simulating a Payout Returned Status - Simulate the action of a third party that is required for returning the payout.

Update Beneficiary - Update a beneficiary with additional fields.

Recurring Digital Wallet Payments - Settings for subsequent Create Payment and hosted checkout page payments via digital wallets.

List Payout Method Types - Updated the endpoint and enhanced the response data.

Creating a Card Payment with an External 3DS Provider - Removed the tavv and xid fields.

Card Network Lookup Service branch - Documentation improvements.

Cryptocurrency transactions:

Payment Updated Webhook - Notifies the client that a payment was updated using Update Payment.

Webhook Root Parameters - Added the extended_timestamp field. Effective in both sandbox and production.

Add Contact to Wallet and Update Wallet Contact - date_of_birth request parameter: Added the YYYY-MM-DD format. Effective in both sandbox and production.

Retrieve Card Eligibility Details - Request Body Parameters: Changed card_token to card_id.

Create Extended Beneficiary - Updated the date of incorporation format.

SDKs - Added a section for Beta SDK releases.

Wallet Status Changed Webhook - Notifies the client that the status of a wallet changed.

Wallet Closed Webhook - Notifies the client that the wallet status is permanently closed (CLO).

Virtual Account Status Webhook - Notifies the client that the status of a virtual account changed.

Retrieve Virtual Account Transaction - The response includes the remitter details. Retrieve Remitter Details is deprecated.

Effective in production from August 13, 2024.

Create Checkout Page - Added the recurrence_type and the require_card_cvv fields.

Create Beneficiary Tokenization Page - Added the beneficiary_extended_fields field.

Card Network Lookup Service - New branch.

Verify Direct API Solution - New guide.

Add Contact to Wallet and Update Wallet Contact - date_of_birth request parameter: Added the YYYY-MM-DD format (Sandbox only).

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 - Add a card to a Google Pay wallet using Google Pay Push Provisioning.

Payout - Create a beneficiary that includes all compliance related data for payouts.

Create Payment - In production, the default value of save_payment_method is false. This now matches the sandbox behavior.

Retrieve Virtual Account Transaction - The response includes the remitter details. Retrieve Remitter Details is deprecated.

Effective in the sandbox from July 16, 2024.

Payout and Beneficiary methods - bin_details object added to the relevant response parameters.

Add Payment Method to Customer - Option to define currency in payment_method_options object. Also available in Create Customer with payment method.

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.

Transaction Types- Added the PayoutReturnCredit transaction type.

Create Payout - Added the returned status.

Payout Returned Webhook - Updated the scenarios when the webhook is sent.

Get FX Rate - Added note: In the sandbox, the FX rate is based on test data.

Card Numbers for Testing Payouts - New page that includes card numbers for simulating payouts and payout errors.

Put Funds on Hold

Release On-Hold Funds

Get FX Rate

Create Checkout Page - Added the required_customer_fields object and the payment_method_required_fields object.

Payment Errors - ERROR_CREATE_PAYMENT_CUSTOMER_NOT_PRESENT

Change Wallet Status - Marked the status request path parameter as required.

Delete Wallet Account Limit - Changed the body parameters to request query parameters.

Duplicate Contact Webhook - Notifies the client that an existing contact has been duplicated.

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 - The request body country parameter must match the wallet contact country parameter.

Verify Identity - The request body country parameter must match the wallet contact country parameter.

Create Identity Verification Page - The request body country parameter is required and must match the wallet contact country parameter.

Create Payment Link - Added a field for indicating the the maximum number of times the payment link can be used.

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.

Transfer Funds Between Wallets

Set Transfer Response

Create Subscription by Hosted Page

Update Wallet Contact - Added the fields that can be updated only once.

Create Payment Link - Added support for FX payments.

Removed the org_id response parameter from code examples and descriptions.

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.

List Payouts - Maximum returned payouts is 1000.

Create Payment - payment_account_reference (response)

Creating a Card Payment with an External 3DS Provider

Payment Method Types - Added a table summarizing the most prominent payment methods.

Create Checkout Page - cart_items supports discounts.

Transfer Funds Between Wallets - No longer available to client wallets of type collect.

Wallet transactions - subtype

Issue Virtual Account to Wallet - branch_code (response)

Creating a Payment with Apple Pay (decrypted)

Delete Virtual Account

Cancel Subscription - cancel_at_period_end is now a query parameter.

Create Subscription - simultaneous_invoice default value is changed to true.

List Issued Cards - Added the following query parameters:

List Virtual Accounts by Rapyd Wallet - Now available in production.

Set Wallet Account Limit - Updated endpoint.

Delete Wallet Account Limit - Updated endpoint.

Update Wallet Contact - The following fields are no longer modifiable:

Simulating Cardholder Disputes - new field payment_method_options.3d_required

Virtual account - branch_code - see Issue Virtual Account to Wallet.

Payout - see List Payouts.

Request Rate Limits

Creating a Payment with a European Card on File

Saving a European Card While Creating a Payment

Create Subscription by Hosted Page

Create Subscription

Update Wallet

Wallet - CLO (closed)

Invoice

Subscription

Listing Wallets

POSitive App Guide

Rapyd App Guide

Versioning for API Methods

API Deprecation Policy

Disable Wallet - replaced by Change Wallet Status but still supported.

Enable Wallet - replaced by Change Wallet Status but still supported.

Transfer Request Updated Webhook

POS Terminal Troubleshooting Guide