charge_requestBody

CompanyPaymentsFintechMarketplacesDigital WalletsPayoutsAustraliaPayTo

Properties

Name	Type	Description
account_id	string	Bank Account or Card Account ID
name	string	Description of the Charge being created.
amount	integer	The cost being charged in cents.
email	string	Email of the user associated with the account being charged.
zip	integer	Postcode
country	string	[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements) country code of the User being charged.
user_id	string	The ID of the User
fee_ids	string	A comma separated list of fee IDs to apply
currency	string	[ISO 4217 alpha-3](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. This is an optional field and if not provided, the item will be created with the default currency of the marketpl
retain_account	boolean	True - Enables the account to be charged in the future. False - Redacts the account after this charge.
device_id	string	Device Information for the device initiating the payment
ip_address	string	IP Information for the device initiating the payment
custom_descriptor	string	When `custom_descriptors` are enabled, this is the information to appear on credit card and direct debit statements.
cvv	string	CVV / CVC

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/assembly-payments/main/json-schema/assembly-payments-charge-request-body-schema.json",
  "title": "charge_requestBody",
  "x-generated": "2026-10-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/assembly-payments-api-openapi.yml#/components/schemas/charge_requestBody",
  "type": "object",
  "required": [
    "account_id",
    "amount",
    "email",
    "zip",
    "country"
  ],
  "properties": {
    "account_id": {
      "description": "Bank Account or Card Account ID",
      "type": "string",
      "default": "5ef44050-4c56-0137-abdf-0242ac110002"
    },
    "name": {
      "description": "Description of the Charge being created.",
      "type": "string"
    },
    "amount": {
      "description": "The cost being charged in cents.",
      "type": "integer",
      "default": "1000"
    },
    "email": {
      "description": "Email of the user associated with the account being charged.",
      "type": "string",
      "default": "buyer-1556505753@promisepay.com"
    },
    "zip": {
      "description": "Postcode",
      "type": "integer",
      "default": "3000"
    },
    "country": {
      "description": "[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements) country code of the User being charged.",
      "type": "string",
      "default": "AUS"
    },
    "user_id": {
      "description": "The ID of the User",
      "type": "string"
    },
    "fee_ids": {
      "description": "A comma separated list of fee IDs to apply",
      "type": "string"
    },
    "currency": {
      "description": "[ISO 4217 alpha-3](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. This is an optional field and if not provided, the item will be created with the default currency of the marketplace.",
      "type": "string"
    },
    "retain_account": {
      "description": "True - Enables the account to be charged in the future. False - Redacts the account after this charge.\n",
      "type": "boolean"
    },
    "device_id": {
      "description": "Device Information for the device initiating the payment",
      "type": "string"
    },
    "ip_address": {
      "description": "IP Information for the device initiating the payment",
      "type": "string"
    },
    "custom_descriptor": {
      "description": "When `custom_descriptors` are enabled, this is the information to appear on credit card and direct debit statements.",
      "type": "string"
    },
    "cvv": {
      "description": "CVV / CVC",
      "type": "string"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/assembly-payments-charge-request-body"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.