API Changelog
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.
New webhooks
Payment Updated Webhook - Notifies the client that a payment was updated using 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 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
tocard_id
.Create Extended Beneficiary - Updated the date of incorporation format.
SDKs - Added a section for Beta SDK releases.
Card Payment Message Sequences - Improvements.
New webhooks
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.
Breaking change
Retrieve Virtual Account Transaction - The response includes the remitter details. Retrieve Remitter Details is deprecated.
Effective in production from August 13, 2024.
New fields or objects
Create Checkout Page - Added the
recurrence_type
and therequire_card_cvv
fields.Create Beneficiary Tokenization Page - Added the
beneficiary_extended_fields
field.
New pages
Card Network Lookup Service - New branch.
orVerify Direct API Solution - New guide.
Enhancements
Add Contact to Wallet and Update Wallet Contact -
date_of_birth
request parameter: Added the YYYY-MM-DD format (Sandbox only).
New endpoints. The deprecated endpoints are supported until March 31, 2025.
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.
Breaking change
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.
New fields or objects
Payout and Beneficiary methods -
bin_details
object added to the relevant response parameters.Add Payment Method to Customer - Option to define
currency
inpayment_method_options
object. Also available in Create Customer with payment method.
New errors
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- 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.
New endpoints. The deprecated endpoints are supported until March 31, 2025.
Breaking change
FX rates are dynamic, not daily.
New endpoint. The deprecated endpoint is supported until March 31, 2025.
New fields or objects
Create Checkout Page - Added the
required_customer_fields
object and thepayment_method_required_fields
object.
New errors
Payment Errors - ERROR_CREATE_PAYMENT_CUSTOMER_NOT_PRESENT
Enhancements
Change Wallet Status - Marked the
status
request path parameter as required.Delete Wallet Account Limit - Changed the body parameters to request query parameters.
New Webhook
Duplicate Contact Webhook - Notifies the client that an existing contact has been duplicated.
Breaking change
Create Payment - In the sandbox, the default value of
save_payment_method
is false. Whensave_payment_method
is false, the values ofpayment_method
andpayment_method_data.id
in the response are null.Create Rapyd Verify Application - The request body
country
parameter must match the wallet contactcountry
parameter.Verify Identity - The request body
country
parameter must match the wallet contactcountry
parameter.Create Identity Verification Page - The request body
country
parameter is required and must match the wallet contactcountry
parameter.
New fields
Create Payment Link - Added a field for indicating the the maximum number of times the payment link can be used.
Breaking change
Create Wallet -
country
field incontact
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.
Enhancements
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.
Breaking change
Create Wallet -
country
field incontact
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 - Maximum returned payouts is 1000.
New fields
Create Payment -
payment_account_reference
(response)
New pages
Enhancements
Payment Method Types - Added a table summarizing the most prominent payment methods.
Create Checkout Page -
cart_items
supports discounts.
New limitation
Transfer Funds Between Wallets - No longer available to client wallets of type collect.
New fields
Wallet transactions -
subtype
Issue Virtual Account to Wallet -
branch_code
(response)
New pages
New API methods
Updated API methods
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:
activation_end_date
activation_start_date
creation_end_date
creation_start_date
status
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:
country
date_of_birth
first_name
identification_number
identification_type
last_name
nationality
Simulating Cardholder Disputes - new field
payment_method_options.3d_required
New fields
Virtual account -
branch_code
- see Issue Virtual Account to Wallet.Payout - see List Payouts.
gc_error_code
batch_file
New pages
New API methods
Updated API methods
New statuses
Wallet - CLO (closed)
New fields
Invoice
automatic_attempt_count
discount_amount
Subscription
enable_retries
retry_options
Updated Finite State Diagrams
New manuals
New information
Deprecated API methods
Disable Wallet - replaced by Change Wallet Status but still supported.
Enable Wallet - replaced by Change Wallet Status but still supported.
New webhooks
New manuals
New endpoints. The old endpoints are deprecated but still supported.
New endpoint
Deprecated endpoints. These endpoints are deprecated but still supported.
Updated webhook:
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.
New parameter
requested_currency
- see Issue Virtual Account to Wallet.