Billing

List supported payout countries

Returns the full supported payout-country set and each country's payout-account field schema. Drives a dynamic onboarding form: which fields to collect (bank code/routing number/sort code/IBAN, whether a BVN is required, whether a bank list or mobile-money network applies) comes straight from this response, so build your onboarding UI to render from it rather than hardcoding a country list.

AuthBearer (JWT)
GroupBilling
Rate limitSee Rate Limits
GET/api/orgs/{orgId}/payment-processing/countries

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { Configuration, BillingApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});

const billing = new BillingApi(configuration);
import { Configuration, BillingApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});

const billing = new BillingApi(configuration);

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const { data: result } = await billing.getPayoutCountries("org_DApyzw3miV");
const { data: result } = await billing.getPayoutCountries("org_DApyzw3miV");

Playground

live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

Use the auth endpoints to obtain a JWT.

No Request Yet

Send a request to see the full inspector

Authentication

Requires JWT
Note
Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Path Parameters

NameTypeRequiredDescription
orgIdstringYes-

Responses

200Supported countries and field schemas
json
{
  "success": true,
  "data": {
    "countries": [
      {
        "code": "firewall transmit",
        "name": "Edgar Effertz",
        "currency": "SGD",
        "banksListSupported": false,
        "mobileMoney": false,
        "international": false,
        "fields": [
          {
            "key": "capacitor navigate",
            "label": "alarm hack",
            "type": "bandwidth generate",
            "required": true,
            "pattern": "circuit copy",
            "maxLength": 55853,
            "help": "bandwidth override"
          }
        ]
      }
    ]
  }
}
{
  "success": true,
  "data": {
    "countries": [
      {
        "code": "firewall transmit",
        "name": "Edgar Effertz",
        "currency": "SGD",
        "banksListSupported": false,
        "mobileMoney": false,
        "international": false,
        "fields": [
          {
            "key": "capacitor navigate",
            "label": "alarm hack",
            "type": "bandwidth generate",
            "required": true,
            "pattern": "circuit copy",
            "maxLength": 55853,
            "help": "bandwidth override"
          }
        ]
      }
    ]
  }
}
401-
403-

Errors

CodeMeaning
401-
403-
Run in PostmanDownload OpenAPI

Next

NEXT →API Reference OverviewBase URL, rate limits, pagination, and the full endpoint index.NEXT →AuthenticationAPI keys, Bearer tokens, and user sessions.NEXT →API PlaygroundSearch any endpoint and send a live request.
Edit this page on GitHub
Chat with us