Buyer details, billing/shipping addresses, basket items (incl. tax and prices), currency and total amount. Setup could differ for different types of integrations. Your Ratepay representative will support you for further clarification.
Yes - multiple captures are supported per transaction, aligned with partial shipments.
Yes - line‑item or amount‑based (only on Payment API v2) partial refunds are supported after capture.
Show alternative payment methods or fallback flows. Use the API’s response codes for user messaging.
Yes. Use sandbox endpoints, test data, and usual test cases to simulate outcomes.
Credentials are provided during onboarding by your Ratepay representative. For Payment API v1, the authentication happens via the request itself (Profile ID & Security Code). For Payment API v2 and further APIs, the OAuth 2.0 protocol will be used for authentication. Store secrets securely.
Yes — send idempotency keys on Payment API v2 for retried requests to avoid duplicate actions.
Retry safely with idempotency and exponential backoff. Avoid retrying non‑idempotent operations without safeguards.
For Payment API v2, some authorizations might require OTP, depending on contractual agreement. Implement the OTP flow in your checkout, where the buyer can enter their SMS code. Also consider a retry logic and error handling.
Use Incremental Authorization (v2) to increase amounts. For decreases, capture only shipped items or cancel remaining parts.
Yes - use the Decline categories section in the docs. Implement mapping to user‑friendly messages and log technical details for support.
Store Ratepay’s Transaction ID & Reference for payment and your Order ID to ensure reconciliation, correct invoicing and support diagnostics.
Yes - multiple refunds are supported up to the captured amount.
Create multiple captures and refunds against a single authorization in sandbox to validate your ERP/e‑commerce logic.