Skip to main content

Payment API

One REST API for the payment lifecycle.

Create payments, manage refunds, receive transaction updates and build payment operations directly into your product — through a single, consistently structured API.
Get startedRead documentation (opens in a new tab)

Capabilities

Payments

Create, retrieve, list, confirm and decline payments.

Refunds

Full or partial refunds against a payment token.

Payouts

Initiate supported payout operations.

Balance

Available and held balance by currency.

Disputes

Recent dispute records for your account.

Notifications

Server callbacks when a status changes.

Authentication

Bearer private key over HTTPS, kept server-side.

Sandbox

A separate environment that emulates processing.

Lifecycle

From request to callback.

  1. Merchant server

    Creates the payment with your private key.

    POST /api/v1/payments

  2. Rainbow Pay API

    Validates the request and returns a payment token.

    200 · token

  3. Payment processing

    The customer pays; authentication runs where required.

  4. Result

    The payment reaches a final status.

    approved | declined

  5. Callback

    Status is posted to your callback URL.

    POST callbackUrl

Authentication

Every request is made over HTTPS and authenticated with your private API key in an Authorization: Bearer header. Keys are issued per environment — sandbox and production keys are separate — and must only ever be used from your server.

Conventions

Requests and responses are JSON. Amounts are expressed in minor units of the currency. Each payment, refund and payout is identified by a token, and every response states whether the call succeeded and, if not, which error occurred.

Related products

Online PaymentsAccept customer payments through a modern API and supported checkout experiences.Hosted CheckoutA Rainbow Pay-hosted payment experience designed to minimise integration complexity.Refunds & Payment OperationsHandle the payment lifecycle from authorisation through refund and dispute workflows.

Ready to discuss your payment setup?

Tell us how your business accepts payments today and what you need from your next payment integration.

Get startedContact sales

Cookie preferences

Choose which optional cookies we may use. Strictly necessary cookies are always active because the website cannot work without them.

  • Strictly necessary

    Security, load balancing, form protection and remembering your cookie choice.

    Always active

  • Remembering settings such as your language choice.

  • Aggregated measurement of how pages are used so we can improve them. No payment data is collected.

  • Measuring the effectiveness of our own campaigns. Off unless you switch it on.

Read the Cookie Policy