Documentation

The demo for Rapyd Hosted Checkout has been updated. Explore the new checkout experience.

The Hosted Subscription Checkout Page now supports coupons. You can pass the coupon ID for the coupon parameter to include coupons in the hosted page.

You can now view the status of your Virtual Account in Client Portal.

You can now save a draft when creating a payout. Other users linked to your account can create payouts. The payout draft is then approved by the account Owner or Administrator before the payout is created.

A Bank-level Payout Method Type (POMT) with Ukraine as the payout country has been created.

New reports have been updated for the Client Portal. View the documentation for the Merchant Reconciliation Report version 1.8. You can also download a Failed Payments Report in the Client Portal.

View the new documentation for creating a wallet in Client Portal. You can use the Contact Reference ID to label your contacts in Client Portal and enhance your contact management.

The documentation about bank payouts has been updated. Learn more about how to make local payouts using bank transfers.

The process for ordering issued cards through Client Portal has been redesigned. It is now easier to order physical issued cards which you can use for your business needs.

You can create a dispute for a card transaction in Client Portal. This allows you to dispute payments which appear unauthorized or fraudulent. See Creating a Dispute for more information.

You can now download invoices for your subscriptions in PDF format. This new feature in Client Portal allows you to view and manage the subscription invoices for your business.

Global SWIFT has been updated to be able to send in CA (Canada) and CAD (Canadian Dollar).

A bank-level Payout Method Type (POMT) with Japan as the payout country has been updated with a new aggregated POMT format: jp_local_bank.

A bank-level Payout Method Type (POMT) with Indonesia as the payout country has been updated with a new aggregated POMT format: id_local_bank.

It is recommended to switch to the new POMT format as soon as possible, which provides a more streamlined payout experience.

The flow for creating a Sender and Beneficiary in Client Portal has been updated. See Create a Sender and Create a Beneficiary for more information.

When a payout is blocked by a Rapyd Protect fraud rule, you will receive an error message informing you of the blocked payout. See Create a Payout for more information.

The page for webhooks has been redesigned. You can easily select which webhooks you want to receive from Rapyd. See Defining a Webhook Endpoint for more information.

You can upload your bank statement to easily verify your bank account. You would provide this information to link a bank account for settlement purposes. See Adding a Bank Account for more details.

You can download the receipts for your payments in PDF format. See Viewing Payment Details for more information.

The Rapyd Checkout Toolkit has a new Pending Status added. This allows the payment to be kept in a pending state so the customer can have more time to complete the payment. They are redirected to a pending status page. Learn more at Checkout Toolkit Integration.

You can now set an optional requested currency for a VA (Virtual Account) issued, and each incoming transaction to the VA will be converted to the set currency. The requested currency can be updated to a different currency or null (default currency). FX rates will apply as described in Payout with FX.

Global SWIFT has been updated to be able to send in NZ (New Zealand) and NZD (New Zealand Dollar).

A bank-level Payout Method Type (POMT) with Malaysia as the payout country has been updated with a new aggregated POMT format, my_local_bank. The new POMT has the beneficiary required field bic_swift, which uses the SWIFT code as a bank identifier. It is recommended to switch to the new POMT format as soon as possible, which provides a more streamlined payout experience. Aggregated POMTs such as id_local_bank and jp_local_bank are planned for the upcoming releases.Payment / Payout Method Types

Updated changes have been made to the Rapyd Verify process for an improved user experience. Learn more about Rapyd Verify Hosted Page.

Rapyd Disburse has been updated to no longer support numerical values in the beneficiary first and last name or company name. Payouts with beneficiary first name, last name, or company name with numerical values will fail. This also applies to any previously saved Beneficiaries.

Rapyd Disburse has been updated to mask identification data of the beneficiary, including Tax ID and passport number, with asterisks (*) in API responses, webhooks, and checkout pages. The beneficiary will be protected from malicious actors who engage in identity theft, financial fraud, and social engineering attacks.

Merchant Reconciliation Report has been updated to include values for the Presentment amount and Presentment currency for the following transactions: Chargeback, Chargeback Win, Chargeback Lose, and Pre-disputes.

Issuing transactions have updated logic to now calculate FX markup from the transaction currency to the wallet currency. The markup will be deducted from the wallet (Fixed side: sell). Previously the FX markup was calculated from the wallet currency to the transaction currency.

The Payment Links section of the Client Portal has been updated to include a more user-friendly workflow to generate one-time or reusable links.

The Hosted Subscription Checkout Page has been updated to make the subscription payment processes more streamlined by removing optional fields and information in the user interface that is already provided in the customer token.

The Settings section has been updated in the Client Portal to minimize navigation links for a better user experience and a wider view of the sections under settings.

The Merchant Reconciliation Reports have been updated to include more details about Settlements in escrow. For merchants using escrow for settlements, there will be an included escrow release transaction, and funds are added to the wallet. As clients receive settlements, the escrow release transaction will be processed, and a settlement object will be created for the client to receive the expected funds.

SEPA Direct Debit payment methods are now supported on the Hosted Subscription Page, the Hosted Checkout Page, and the Checkout Toolkit. To pay via SEPA Direct Debit, customers must provide their IBAN and complete an OTP process through a redirected portal.

The Hosted Subscriptions, Checkout Page, and Checkout Toolkit have been updated to include additional call-to-action selections, including Pay and Purchase. You can customize the CTA button as described in the Client Portal Guide, Customizing Your Hosted Page.

The Checkout Toolkit has been updated, and you can now omit the CTA button from the iframe by passing a hide_submit_button param. You can generate your own button and control it outside using the postMessage event. Learn more at Checkout Toolkit Integration.

The Developers section in the Client Portal has been updated to include an improved user experience. The Webhooks section has been redesigned to organize each webhook event by each Rapyd product or object, including: Collect, Disburse, Issuing Wallets, Protect, and the Customer object.

The Rapyd API has been updated to allow clients to simulate error responses for Redirect Payments and the Toolkit in Sandbox. Learn more at Redirect Payments.

The Hosted Payout Tracker page has been updated to include an estimated date of arrival of funds for the beneficiary or recipient. Learn more about the Payout Tracker Link.

The create payout process has been updated to allow the sender to fix the sender details while creating a payout. When the sender is using the Swift Bank payout method and the required fields are not valid, the sender can edit and fix sender details including city, postal code, and state.

Following the development of multi-merchant clients. Clients can now create another Rapyd account with their existing users. The account will be completely new and will need to be verified and KYB-approved.

The Hosted Solutions pages have been updated to improve the customer experience and usability. The following pages have been updated:

The Hosted Checkout Page has been updated to improve error statuses to be more descriptive. Specific error codes are now exposed in error messages from the Rapyd API to the hosted UI. Previously generic messages were shown. For more information on card and hosted page errors, refer to Card network error messages, card transaction errors, and hosted page errors.

The bin_details object will be shown in a card payment response and webhook.

The Brazil Pix eWallet br_pix_ewallet has been updated to now include refunds. Refer to Pix to learn more about the bank payment method.

Realtime Payment Methods have been added, including gb_realtime_bank and de_realtime_bank for both GB (Great Britain) and DE (Germany). For more information on payment methods, refer to List Payment Method by Country.

KYB Approval is required to complete a transaction in Production. Refer to Activating Your Account (KYB) to learn more.

The Client Portal has been updated to include a Mobile Version. Users can log on to m.dashboard.rapyd.net/login with an optimized view for any mobile device. The CP mobile version currently has selected functionality, and capabilities will continue to expand soon.

The RBA (Rapyd Business Account) will now begin charging $99/month after your account has been approved and found in Activating Your Rapyd Business Account.

This charge will begin to be deducted from your RBA Balance. The client will be charged for each month on the 10th of the month. If there are no funds in your account, then a negative balance will begin to occur each month. Refer to the RBA Monthly Flat Fee to learn more about account negative changes and reconciliation.

The Financial Questionnaire section of Rapyd Verify is no longer required. Previously this section was required to move forward with business verification.

Virtual Account has been updated to include List Capabilities of Virtual Accounts per Country to list the capabilities of virtual accounts you can issue to a Rapyd Wallet. Listed capabilities (e.g., supported currencies, account type, refundable, etc.) are found in the API response and described in the Virtual Account Number Object Page.

The Rapyd API has been updated to include Retrieve Apple Pay Session to retrieve the details of an Apple Pay payment session. Each payment that uses Apple Pay requires a new Apple Pay session. Refer to the Digital Wallet Object for more details on the fields.

The Hosted IDV Page has been updated to allow a Toolkit Integration to embed the page and IDV flow on your website.

The Beneficiary Account Details section now reflects the existing Beneficiary Account Details to embed the page and user flow on your website.

Clients who are non-PCI-DSS compliant can now use the Hosted Card Activation Page to generate a hosted page to activate an issued card. A secured hosted page is sent to card users (private or corporate cards) to activate a card that has been personalized but not yet activated by receiving a PIN code (Rapyd randomly generates a PIN code and displays it to the user).

The Client Portal has been updated to reflect an improved user experience in the Payment Methods section with regional filtering, payment method logos, country tags, and activation switches. You can still view the payment methods in the table view described in Viewing Payment Methods.

The Client Portal has been updated to allow you to choose your settlement frequency from daily, weekly, or monthly as described in Modifying Bank Account Details .

The Client Portal has been redesigned to reflect an improved customer experience, a more modern look, and faster performance. Refer to the Client Portal or Client Portal Guide for more information.

The Card to Card Payment has been updated to add the ability to reuse destination cards and transfer funds to saved cards. Rapyd’s Card to Card Payment method moves funds from one cardholder to another. For more information, refer to Card to Card Payments or Card to Card object.

You can now style the frame and content of the Save Card Details Page with CSS properties when embedding the page within your website or app (toolkit integration). Refer to Save Card Details Using Checkout Toolkit Method and Checkout Toolkit CSS Properties.

Rapyd Verify is now available to clients domiciled in the UK to gather business details for KYB (Know Your Business) verification.

A new Create Payout workflow has been updated in the Client Portal. This new flow has an improved client experience and adjusts to show the relevant fields dependent on the payout details configuration (e.g. individual, or business entity type, etc.). The classic version can still be accessed by clicking the link in the announcement above the Create Payout section.

You can now share a link with a live payout status tracker when you create a payout. The payout tracker pops up in a dialogue box when you create the payout or find it on the payout details page or side panel in the Client Portal.

You can now generate a Hosted Subscription Checkout Page via API or the Client Portal. Use POST https://sandboxapi.rapyd.net/v1/checkout/subscription1 to receive a redirect URL in the response, or follow Creating a Hosted Subscription Checkout Page and choose to generate a checkout page in Client Portal.

The Subscriptions Object is still available solely via API for clients with PCI Level 1 and wants to build a separate interface for creating a subscription and integrating with the Rapyd core API.

The Supported Currencies Page now displays a full list of currencies across Rapyd Collect, Disburse, Issuing, and Wallet.

The Swift Payout Method is now available to pay others using Rapyd Disburse. The payout method type field is standardized as xx_swift_bank. However, each country has different requirements for the payout required field information as described in the linked Swift Payout page.

Rapyd Verify has been updated to link new business wallets to an approved business wallet that has already completed the KYB process. Merchants with approved business wallets no longer have to resubmit individual KYB forms for a new business wallet.

Rapyd Verify now includes two additional entity types: Nonprofits and Partnerships. Previously there were only private company and sole proprietorship entity types.

Merchant Reconciliation Reports have been updated to version 1.7, including merged fields and columns with the Merchant Reconciliation beta.

The Rotate API Keys feature is now available in Client Portal. Account owners can set a time to rotate their secret and access keys in the sandbox or production, creating a new unique set of keys.

To coordinate when to replace all your keys in sandbox or production, you can choose to set the reset time between now, 1 hour, 24 hours, three days, or seven days.

You can now accept SEPA Direct Debit payments through the [Hosted Checkout Page and the Toolkit Integration embedded into your website.SEPA Direct Debit

Note: An additional step for bank payment simulations has been added in Sandbox, as shown in the diagram.

Italian and Turkish translation support has been added to all hosted pages. To see a full list of languages, refer to Checkout Toolkit Integration Translations or List Hosted Page Supported Languages.

The Client Portal has been updated to include new assets aligned with Rapyd’s design and brand. Pages and navigation will remain the same throughout the Client Portal dashboard.

Payment Links have been added to the Client Portal to generate a reusable link to accept customer payments. You can create a set or open amount where customers can edit their amount to pay. Refer to Creating a Payment Link to generate a payment link.

The Client Portal has been updated to include a Report Settings page, which allows clients to edit the reconciliation report type and format of the CSV document. Refer to Reports Settings in the Client Portal Guide for more details.

The Plugins page has been redesigned in the Client Portal. Refer to the Plugins Guides for more details.

The Payment Method Type has been updated to include the conditions array of objects, which defines specific conditions when a field is required for a payment method.Payment / Payout Method Types

For example, identification_value can be required if the value of the payment field amount is greater than 100.

The Client Portal has been updated to include a Subscriptions section to view details, create new subscriptions, and view pricing plans and invoices. Learn more in the Client Portal Guide to view all guides on Subscriptions.

Updates have been made for How to Download a Virtual Account PDF Confirmation. You can now view how to download Proof of Account Ownership and Virtual International Bank Account Numbers.

The Client Portal Guide has been updated and includes more information on the Customer Details page. You can generate a payment request for the customer directly within the Client Portal. A Virtual Terminal can also accept a saved payment method type immediately.

The Hosted Checkout Page card payment experience has been improved to automatically identify the card payment method type when inputting the card number into the corresponding field. The extra step of selecting a card payment method type prior has been removed.

The Client Portal has been updated to create and save table filters for any table. You can select the filter button in the upper right corner of the page to customize your table view and follow the steps to save your Filter Group to return to your settings at any time.

You can now set the default language of a Hosted Page to Greek. The end-user can also select Greek as a supported language in the checkout language menu.

The Checkout Toolkit Integration now includes Google Pay. Refer to the Client Portal Guide on activating.

The Client Portal has been updated to include submitting support tickets directly in the dashboard. You can create a support ticket by clicking the question mark icon at the top right > Create Ticket. You can also view your support tickets by going to the Support Center.

You can now request payment into escrow all within the Client Portal. Sign into the Client Portal, navigate to Collect, Request Payment, and check the Hold in Escrow box > Next.

Google Pay is now available for clients in Europe. Refer to the Client Portal Guide on activating Google Pay in the Client Portal.

Virtual Accounts has been updated to include a Get request to List Virtual Accounts by a Rapyd Wallet. Use ewallet_id.

Note: To use the Virtual Accounts feature, contact Rapyd Client Support.

Error messages have been updated to include new dedicated error messages for failed card network transactions. The error message provides details on the cause and corrective action.

The updates to error messages help improve the overall payment experience, reduce frustration, and eventually increase the conversion rate by encouraging customers to resubmit their payments.

Virtual Account has been updated to include List Capabilities of Virtual Accounts per Country to list the capabilities of virtual accounts you can issue to a Rapyd Wallet. Listed capabilities (e.g., supported currencies, account type, refundable, etc.) are found in the API response and described in the Virtual Account Number Object Page.

The Rapyd API has been updated to include Retrieve Apple Pay Session to retrieve the details of an Apple Pay payment session. Each payment that uses Apple Pay requires a new Apple Pay session. Refer to the Digital Wallet Object for more details on the fields.

The Hosted IDV Page has been updated to allow a Toolkit Integration to embed the page and IDV flow on your website.

The Beneficiary Account Details section now reflects the existing Beneficiary Account Details to embed the page and user flow on your website.

Clients who are non-PCI-DSS compliant can now use the Hosted Card Activation Page to generate a hosted page to activate an issued card. A secured hosted page is sent to card users (private or corporate cards) to activate a card that has been personalized but not yet activated by receiving a PIN code (Rapyd randomly generates a PIN code and displays it to the user).

The Client Portal has been updated to reflect an improved user experience in the Payment Methods section with regional filtering, payment method logos, country tags, and activation switches. You can still view the payment methods in the table view described in Viewing Payment Methods.

The Client Portal has been updated to allow you to choose your settlement frequency from daily, weekly, or monthly as described in Modifying Bank Account Details .

The Client Portal has been redesigned to reflect an improved customer experience, a more modern look, and faster performance. Refer to the Client Portal or Client Portal Guide for more information.

The Card to Card Payment has been updated to add the ability to reuse destination cards and transfer funds to saved cards. Rapyd’s Card to Card Payment method moves funds from one cardholder to another. For more information, refer to Card to Card Payments or Card to Card object.

You can now style the frame and content of the Save Card Details Page with CSS properties when embedding the page within your website or app (toolkit integration). Refer to Save Card Details Using Checkout Toolkit Method and Checkout Toolkit CSS PropertiesSave Card Details With Rapyd Checkout - DEPRECATED

Rapyd Verify is now available to clients domiciled in the UK to gather business details for KYB (Know Your Business) verification

Rapyd’s card-to-card payment method moves funds from one cardholder to another card. A sender uses their card as the funding source within the Rapyd wallet to send to a destination card. The funds will load directly onto the destination card and any transactions will be reflected in the sender’s wallet ledger.

Note: The card issuer may require verification before adding a source card and/or sending the payment from the source card to the destination card.

Apple Pay is now available for clients domiciled in Europe. Refer to the Client Portal Guide on activating Apple Pay in the Client Portal.

You can retrieve the most updated languages offered for Hosted Pages with a GET request to https://sandboxapi.rapyd.net/v1/hosted/config/supported-languages.

Production: GET https://api.rapyd.net/v1/hosted/config/supported-languages

Postman: GET {{base_uri}}/hosted/config/supported-languages

The Client Portal has been updated to improve how clients request access to payment methods based on country and category rather than one specific payment method.

Enhancements have been made to interchange reporting to offer more detailed client reports with a breakdown of each card network transaction and interchange fees. Refer to Interchange Plus Pricing.

Plugins have been updated with a new design and for an improved user experience to search what countries and payment categories each plugin supports.

Wallet features have been updated to transfer funds or create a payout in any currencies we support for FX.

Updates have been made to Client Portal to allow wallet transfers with FX from one wallet type to another (e.g., Client to Client, End user to end user, client to End user).

The Create Payout function in the client portal has been updated to add an optional field, Statement Descriptor, that includes the reason for the payout as described in Payout Object.

The country field has been moved to the top of the screen and the required fields will update based on the country selected. Refer to Rapyd Verify Hosted Page for more information on the use case.

The “CUSTOMER_PAYMENT_METHOD_CREATED” webhook has been updated to include the next_action field, which indicates the next step for verifying and capturing a payment method relevant to the type (e.g., 3d_verification for 3DS cards).

The Identity Verification object has been updated to make back_side_image optional for all application types except for the passport.

The Client Portal guide to View the List of Values within the Client Portal has been posted.

Updates have been made to Client Portal to improve the Wallet Balances Account Summary under My Account. You can view balances of different currencies, wallet transactions, and fees. Learn more at Viewing Client Wallet Balances, or Previewing Client Wallet Details.

A Disputes section has been added to Client Portal to help you accept, or challenge the dispute sent by the card issuer or bank. Learn more at Listing Disputes or Viewing Dispute Details.

The Client Portal guide to request a payment method or a payout method within the Client Portal has been posted. Find out how to view all your Payment or Payout Methods at Viewing Payment Methods or Viewing Payout Methods.

The Client Portal guide to creating a customer within the Client Portal has been posted. Learn more at Creating a Customer to view the Client Portal guide or [Create Customer] to view the API.

The Get Daily Rate API now allows the user to provide a range of dates in the past. Clients can request the exchange rate for the range of dates in the past as opposed to a single date. For example, the date could be 2020-08-22 with the format of YYYY-MM-DD.

Client Portal Accounts now can use a Two-Factor Authenticator (2FA) App as described in the Client Portal Guide. New user accounts signing up for Client Portal can follow the Use Two-Factor Authentication App page.

The Sandbox Card payment has been updated to reflect an improved design and user experience. Refer to Card Payment with 3DS Verification for more details.

The Sandbox Bank Redirect payment has been updated to reflect an improved design and user experience. Refer to Bank Redirect for more details.

Two new fields have been added to the Wallet Contact object required for Brazilian real (BRL) KYB regulation: transaction_permissions and role_in_company. Refer to the issued_card_data object under Wallet Contact for more details.

The following Javascript events have been updated to reflect a more accurate description. The former event names will be deprecated.

The following events have been added.

The cardholder_preferred_currency parameter within the custom_elements object will be renamed to dynamic_currency_conversion. The former parameter name will become deprecated.

The following Javascript events have been updated to reflect a more accurate description. The former event names will be deprecated.

The following Javascript events have been updated to reflect a more accurate description. The former event names will be deprecated in the future.

The following events have been added

The following Javascript events have been updated to reflect a more accurate description. The former event names will be deprecated in the future.

The following events have been added.

The following Javascript events have been updated to reflect a more accurate description. The former event names will be deprecated in the future.

The following events have been added.

Merchants can now generate a Hosted Checkout Page and split the payment between multiple wallets based on percentages or payment amounts.

Improved user experience for payment required fields of string type limited to digits-only values. These fields now accept only digits inputs; az numpad is opened on mobile by default. Additionally, there is validation on the input length so that the user cannot type in more digits than required.

Hosted pages now have dedicated webpage titles rather than a general "Checkout" header as the title. Please note this only applies to the full-page desktop view.

A new field has been added, next_action, that indicates the action for completing the payment. (e.g., the next step for 3DS verification and capturing a payment relevant to card payments or non-card confirming a payment). Learn more details on the Payment Object fields table.

Virtual Accounts are used to move funds using bank transfers to another Virtual Account tied to a user wallet. The following APIs have been created to help retrieve Virtual Account details:

Clients can now generate a hosted IDV page with custom URLs for requests when the page is completed or canceled. The user is redirected to the URL when completing the IDV flow or canceling it.

Virtual Accounts are used to move funds using bank transfers to another Virtual Account tied to a user's wallet. The following APIs have been created to help retrieve Virtual Account details:

All the hosted pages now support the following translations: Japanese, French, Hindi, Vietnamese, and Bahasa Malayu (Malaysian).

The languages menu has been redesigned for an improved display of all the available languages (17 in total, including English). The languages are sorted to prioritize the first listed language based on the location of the buyer.

Added tooltips to the Rapyd plugin page on Woocommerce.

Client reports enhancements (Reconciliation and Settlement).

Added issued card information to client reports for Rapyd-issued card transactions.

The Client Portal has been updated with new designs and features for you to manage your Rapyd accounts as described below:

The card payment method types displayed to the customer on the hosted checkout page and hosted tokenization page are now based on the customer’s country (e.g., from the Create Checkout Page request).

If the merchant doesn't have any relevant payment method types assigned to them, the payment method types that are being displayed are based on the country.

Dutch translation is now available for all the hosted pages. Refer to Checkout Toolkit Integration - Translations for more details.

The Checkout page user flow has been optimized for failed/canceled redirect-type payments (e.g., card with 3DS, bank_redirect, ewallet type redirect). When the customer is redirected to the URL to complete the payment, and the payment cancels or fails, the customer is now redirected back to the checkout payment page, where they can attempt to pay again.

This workflow improves the user experience to keep the user within the checkout page rather than directing to a separate error page.

Hosted Checkout Page user experience optimization:

Card payments on the Hosted Checkout page.

Checkout Integration Improvements

Foreign Exchange

Card input fields (e.g., card exp. date, CVV, etc.) have been reordered for a more intuitive user experience.

UI improvements have been made for the cart items feature and the mobile flow to include the item details (e.g., item name, amount, quantity) from the shopping cart to be displayed on the checkout page.

Clients who implement the Checkout Toolkit on their website (iframe) and allow their users to change the language (e.g., a language picker on the page) can now ensure that the language of the checkout payment fields within the iframe is updated accordingly in real-time.

The Save Card Details Page allows merchants to redirect users to custom URLs when exiting the page before completion and after tokenizing a card.

When a Hosted Page is generated with an unsupported language in the request, the default language of the user’s browser is now being used, or will default to English.

The Hosted IDV (Identify Verification) Page is now available in all our supported languages, including Spanish, Icelandic, German, Indonesian, Korean, Portuguese, Thai, Tagalog, Simplified Chinese, and Traditional Chinese. Refer to Checkout Toolkit Translations for a full list of languages.

The Currency Object has been updated to include the ISO-4217 numeric code standards (numeric_code) and the number of digits after the decimal point. See List Currencies.