Integration overview
attention
Before the Go live...
- Contractual agreements have to be done,
- Tests and Invoicing must be checked & approved by Ratepay!
Transaction flow
Test / Integration phase
Logins / credentials
- Get test credentials from your Ratepay representative
- Set up your test environment
- Give your team members access to ORCA test environment
Technical integration
Frontend
- Show Ratepay payment method(s) in your checkout (Optional: Logos can be found here )
- Display Ratepay's legal requirements in your checkout & GTC
-
If not already requested in your checkout: Implement fields for...
- B2C: Name of customer, addresses, e-mail, date of birth, telephone number
- B2B: Company name, addresses, e-mail, VAT ID
- Payment method "SEPA Direct Debit": Bank account owner & IBAN
- Implement Device Fingerprinting for online shop orders
- For SEPA Direct Debit:
-
For One Time Password (OTP) if contractually agreed:
- Implement the user interface for one time password (OTP) screens
Backend
- OAuth token handling (via Authentication API)
- Optional, but recommended to ensure data consistency: Idempotency handling
- Perform transaction with buyer- & shopping basket data (Authorize transaction)
- Handle successful transaction / errors / rejections and show it in frontend
-
For One Time Password (OTP) if contractually agreed:
- Implement OTP endpoints and connect them with the frontend screens for OTP entry and regeneration
- Forward ratepay_transaction_id for followup operations & ratepay_payment_reference for Invoicing to ERP
- Implement followup operations (e. g. in ERP):
General
- Do the Testing
- Create or adjust the invoicing document for the buyer
- Optional & if contractually agreed: Submit Regular Customers
- Optional & if contractually agreed: Implement Transaction Status API
Live
Logins / credentials
- Get live credentials from your Ratepay representative
- Set up your live environment
- Give your team members access to ORCA live environment