Skip to main content

Documentation

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 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.

  • Breaking change

    • Get FX RateGet 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 - Added the required_customer_fields object and the payment_method_required_fields object.

  • Breaking change

    • 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.

  • New fields

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