Billing

Enable payment processing for organization

Creates a payment-collection subaccount for the org with the provided bank details. Use USD-capable bank (e.g. country US) for USD settlement. BVN only required when country is NG. Requires owner or admin role.

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

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.enablePaymentProcessing(
  "org_1Dzo1P7c4j",
  {
    accountBank: "array reboot",
    accountNumber: "driver connect",
    country: "Benin",
    businessName: "Clifford Hammes",
    businessMobile: "1-533-211-2406",
    bvn: "interface program"
  }
);
const { data: result } = await billing.enablePaymentProcessing(
  "org_1Dzo1P7c4j",
  {
    accountBank: "array reboot",
    accountNumber: "driver connect",
    country: "Benin",
    businessName: "Clifford Hammes",
    businessMobile: "1-533-211-2406",
    bvn: "interface program"
  }
);

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

Request Body

json
{
  "accountBank": "card compress",
  "accountNumber": "transmitter calculate",
  "country": "Japan",
  "businessName": "Vada Jacobson",
  "businessMobile": "1-855-263-8265 x7981",
  "bvn": "port navigate"
}
{
  "accountBank": "card compress",
  "accountNumber": "transmitter calculate",
  "country": "Japan",
  "businessName": "Vada Jacobson",
  "businessMobile": "1-855-263-8265 x7981",
  "bvn": "port navigate"
}

Responses

200Payment processing enabled (or already enabled)
json
{
  "success": true,
  "message": "Stylish Keyboard designed to make you stand out with lively looks",
  "data": {
    "subaccountId": "gvsfLOF82D2EM2QY",
    "alreadyEnabled": false
  }
}
{
  "success": true,
  "message": "Stylish Keyboard designed to make you stand out with lively looks",
  "data": {
    "subaccountId": "gvsfLOF82D2EM2QY",
    "alreadyEnabled": false
  }
}
400
401
403
500

Errors

CodeMeaning
400
401
403
500
Edit this page on GitHub