Guides

Integration And Go-Live Guide

A high-level implementation guide for technical setup, operational readiness, and compliance onboarding before production launch.

Before You Start

Prerequisites

  • Active merchant account and API key.
  • Sandbox access for development and QA.
  • Webhook endpoint for asynchronous events.
  • Internal data store for IDs, statuses, and reconciliation records.

Environment Model

All endpoints are versioned under /v1. Build and validate in sandbox, then promote to production with the same API contracts.

Sandbox: https://sandbox-api.platform.raenest.com
Production: https://api.platform.raenest.com

Authentication, Requests, and Responses

Authentication

Send your merchant API key as a Bearer token for authenticated endpoints.

Authorization: Bearer YOUR_API_KEY

Production IP Allowlisting

Production API access is restricted to allowlisted source IP addresses. Share your static outbound IPs before go-live.

If your egress IP changes, requests may be blocked until the new IP is approved.

Response Envelope

Responses use a consistent envelope. Always inspect errors and preserve request references for auditability.

{
  "message": "success",
  "errors": null,
  "data": { ... }
}

Recommended Integration Flow

1. Create Customers

Create and store customer records first to anchor downstream workflows.

2. Run KYC/CIP

Complete identity checks and only proceed with approved outcomes.

3. Generate Accounts

Create virtual accounts for eligible customers and persist account IDs.

4. Prepare Transfers

Fetch requirements and quotes before transfer initiation.

5. Execute Transfers

Submit transfers with idempotent references from your platform.

6. Reconcile

Use transactions plus webhook events to maintain ledger and status integrity.

End-To-End Sequence Diagram

Raelic integration sequence diagram

Webhooks and Testing Strategy

Sandbox Validation

  • Test happy-path and failure-path flows for customer, CIP, account, and transfer lifecycles.
  • Validate idempotent webhook handling for duplicate deliveries.
  • Verify recovery for delayed and out-of-order events.

Production Readiness

  • Verify webhook signatures for every callback.
  • Store raw webhook payloads and processing outcomes for audits.
  • Alert on failed processing and retry backlog growth.

UAT Readiness

UAT Entry Criteria

  • Core sandbox integration completed for customers, CIP, accounts, transfers, and webhooks.
  • Test data set prepared for happy-path, failure-path, and edge-case scenarios.
  • Monitoring, alerting, and reconciliation reports visible to operations teams.

UAT Exit Criteria and Sign-Off

  • Live UAT demo walkthrough is completed with the Raelic team before final sign-off.
  • Business and operations stakeholders confirm expected behavior in end-to-end scenarios.
  • No open critical or high defects related to money movement, KYC, or reconciliation.
  • Technical, compliance, and business sign-off recorded before production enablement.

Security and Technical Documentation

  • Latest Vulnerability Assessment (VA) report.
  • Most recent Penetration Test (Pentest) report, including remediation status.
  • Production architecture overview.
  • Incident response process (high-level summary).

Technical Contact Information

  • Primary technical contact: name, title, email, phone.
  • Secondary or backup technical contact.
  • Technical escalation contact (if different).

Compliance Documentation

  • AML (Anti-Money Laundering) policy.
  • Customer support policy and operating procedures.
  • Compliance framework overview: KYC, transaction monitoring, sanctions screening.
  • Data protection and privacy policy (if applicable).

Compliance Contact Details

  • Head of Compliance or MLRO.
  • Compliance escalation contact.
  • Compliance team shared email (if available).

Billing and Settlement Information

  • Legal entity name.
  • Registered business address.
  • Billing contact: name, email, phone.
  • Accounts payable contact email.
  • US bank account details for invoice settlement:
    • Bank name.
    • Account name.
    • Account number.
    • Routing number (ACH/Wire).
    • SWIFT/BIC (if applicable).

Launch Checklist

  • All technical and compliance documents submitted and approved.
  • Production IP allowlist confirmed.
  • Webhook monitoring and incident escalation tested.
  • Reconciliation and reporting validated by operations and compliance teams.
  • Production credentials rotated, stored securely, and access reviewed.

Use this guide as your operational checklist, then move to the API Reference for endpoint-level request/response definitions.