html {
  /* Force scrollbar to always appear to prevent content jumps */
  overflow-y: scroll;
}

#navbar {
  background: black !important;
  color-scheme: dark;
  color: white !important;
}

#navbar-transition {
  background: black !important;
}

#navbar .text-gray-800,
#navbar .text-gray-600,
#navbar .text-gray-700 {
  color: white !important;
}

.nav-logo.hidden {
  display: block !important;
}

.nav-logo.block {
  display: none !important;
}

#search-bar-entry {
  background: black !important;
  color: white !important;
  border: 1px solid rgba(255, 255, 255, 0.9);
}

#assistant-entry {
  background: white;
}

#assistant-entry .text-gray-700,
#assistant-entry .text-gray-500 {
  color: black !important;
}

#chat-assistant-sheet {
  border-left: 1px solid #e5e7eb;
}

/* Override the default height of the active tab indicator, too thin when we have a black header on white page */
.nav-tabs [class*="h-[1.5px]"] {
  height: 3px !important;
}

/* Add gradient to header button */
#navbar a[href="https://app.runa.io"] .bg-primary-dark
{
  background: linear-gradient(20deg, #00ffa3, #93ff82, #eefc51) border-box;
}
#navbar a[href="https://app.runa.io"] .text-white, #navbar a[href="https://app.runa.io"] svg
{
  color: black;
}

/* Make page sidebar navigation links show in a higher contrast colour in light mode */
#navigation-items .text-primary {
  /* Force text to be black */
  color: black;
}
#navigation-items .dark\:text-primary-light:is(.dark *) {
  /* Restore colour on dark mode, default is fine */
  color: rgb(var(--primary-light) / var(--tw-text-opacity));
}
#navigation-items .bg-primary {
  /* The icon also needs to be black */
  background-color: black;
}
#navigation-items .dark\:bg-primary-light:is(.dark *) {
  /* Restore icon colour on dark mode, default is fine */
  background-color: rgb(var(--primary-light) / var(--tw-bg-opacity));
}
#navigation-items .bg-primary\/10 {
  /* The icon also needs to be black */
  background-color: rgb(var(--primary) / 0.2);
}
#navigation-items .dark\:bg-primary-light\/10:is(.dark *) {
  background-color: rgb(var(--primary-light) / 0.2);
}


.hero-button {
  background:
    linear-gradient(black, black) padding-box,
    linear-gradient(to top right, #00ffa3, #93ff82, #eefc51) border-box;
  border-radius: 50em;
  border: 2px solid transparent;
  border-radius: 3rem;
  padding: 0.75rem 2rem;
  font-size: 1rem;
  color: white;
  font-weight: bold;
  text-decoration: none;
  text-transform: uppercase;
  transition: all 0.3s ease-in-out;
}

.hero-button:hover {
  background:
    linear-gradient(black, black) padding-box,
    linear-gradient(to right, white, white) border-box;
}


Get the details and status of a specific order. Use to poll for the status of your order after it's been accepted.

Get an order's details and status.

AccountPayment

AccountPaymentType

The discount multiplier of the order item. e.g. 0.1 means 10% discount. The discount is applied on the price of the order item before any fees are applied.

Discount Multiplier

The distribution method used for the payout link.

Distribution Method

Face Value

Payout

Price

The product(s) the end user can redeem the payout link on.

Products

The URL (payout link) the end user uses to redeem.

Redemption Url

CompletedOrderItem

Email distribution. Send the payout link to the end user directly via email.

The email address of the end user to send the payout link to.

Email Address

The template ID for a User Redemption Template.

Template ID

EmailDistribution

EmailDistributionType

Link distribution. Send the payout link to the end user yourself.

LinkDistribution

LinkDistributionType

Multiple products. The end user will be able to split the payout link's value
between these products.

The codes for the products the end user can choose from when redeeming their payout link. All products _must_ use the same currency.

Values

MultipleProduct

Multiple products. When more than one product code is provided.

MultipleProductType

OrderStatusEnum

Expiry Date

Time that the payout link status was last updated

Status Updated At

PayoutDetails

Payout selection template. Template having predefined set of products.

The template ID for a Payout Selection Template.

The codes for products selected for Payout Selection Template.

PayoutSelectionTemplateDetailed

PayoutSelectionTemplateType

Current status of the payout link. An `ACTIVE` link is live but has not been claimed yet, it will change to `CLAIMED` once that has happened. If you request a cancellation the status will reflect this as `CANCELLED`. Finally if your account is configured with expiry, when a link expires it will be marked as `EXPIRED`.

Payout status

Single product. The end user will be able to redeem the payout link for this
specific product.

The code for the product the end user will get when redeeming their payout link.

Value

SingleProduct

Single product. When only one product code is provided.

SingleProductType

Product(s) unknown. It was not possible to determine which products were included
in the order.

It is not currently possible to determine which products were selected when this item was ordered.

Type

UnknownProduct

ApiKeyAuth

Used for an order that has completed. This class is typically used when returning
a *single order* to the client.

CompletedOrderWithFullDetails

Order that has been accepted but is not complete.

IncompleteOrder

APIErrorResponse

Send instant B2C payments your recipients will love

Runa Developer Hub

Welcome

Where global payouts take shape: access APIs, guides, use cases, and tools to embed instant, flexible payouts - at scale, anywhere

Introduction

Steps

Learn about the different API environments available in Runa

Environments

Create an API key to authenticate your requests

Creating an API key

Before going live, your account must pass compliance checks and be funded, here's what to expect

Moving to production

Fetch the latest catalog of products available for use in payouts

Product catalog

Check what you will be charged for an order before you pay

Estimate the price of an order

Check your balance using the API and set up alerts to notify you when your balance is low

Managing your balances

Choose what products are available to your recipients when sending a payout link

Limiting available products

Add your own branding and customize the redemption experience for your recipients

Customizing and branding the redemption experience

Save a curated list of merchants to re-use between orders, update the selection, or remove merchants from the list without API changes needed

Save product selections between orders

Use Runa Embedded FX to pay for an order using your funds in another currency

Paying for an order using another currency

Before you go live ensure your integration is reliable and secure

Getting ready to go live

How to manage authentication when using the Runa API

Authentication

Best practices for securing your integration with the Runa API

Security

Safe retrying of requests without accidentally performing the same operation twice

Idempotency

How to handle error scenarios when using the Runa API

Handling Errors

How to handle rate limits when using the Runa API

Rate Limits

Keep up to date with the latest Runa API version

API versioning

API Updates

Find out what brands and payout types have been added to the network. 

Additions

Occasionally our merchant partners make changes to their product offering. To ensure a smooth experience and to make sure these changes are reflected on your platform you may need to make an API call to our products endpoint.

Changes

Find out what brands and payout types have been removed from the Runa Network.

balance

products

orders

Get an order's details and status.

Authorizations

Headers

Path Parameters

Response