Billing

Get payout-onboarding status for organization

Returns the current onboarding/approval state for the org's payout account. Poll this after calling enable, or before calling initialize-payment, to confirm the org is actually approved rather than assuming a 200 from enable means payments are live. Never returns the raw payout-account id, only whether one exists.

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

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.getPaymentProcessingStatus("org_siDhrMddMl");
const { data: result } = await billing.getPaymentProcessingStatus("org_siDhrMddMl");

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

200Payout-onboarding status
json
{
  "success": true,
  "data": {
    "onboarded": false,
    "enabled": false,
    "approvalStatus": "protocol copy",
    "status": "driver copy",
    "rejectionReason": "firewall generate",
    "stablecoin": {
      "enabled": true,
      "kycVerified": true,
      "settlementFiat": "panel navigate",
      "walletCount": 22
    }
  }
}
{
  "success": true,
  "data": {
    "onboarded": false,
    "enabled": false,
    "approvalStatus": "protocol copy",
    "status": "driver copy",
    "rejectionReason": "firewall generate",
    "stablecoin": {
      "enabled": true,
      "kycVerified": true,
      "settlementFiat": "panel navigate",
      "walletCount": 22
    }
  }
}
401-
403-

Errors

CodeMeaning
401-
403-
Edit this page on GitHub
Chat with us