Assembly Payments Tools API

The Tools API from Assembly Payments — 1 operation(s) for tools.

Operations 1

GET /tools/status Health check #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-npp-last-domestic-leg-request-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-user-request-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-update-user-request-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-charge-request-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-bank-account-request-body-au-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-item-request-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-virtual-account-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-pay-id-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-pay-id-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-update-va-status-resp-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-deregister-pay-id-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-virtual-accounts-list-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-initiate-payment-status-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-agreement-details-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-validate-agreement-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-amend-agreement-details-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-initiate-payment-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-initiate-payment-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-make-payment-request-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-status-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-callbacks-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-single-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-payment-data-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-supplementary-data-schema.json
📊
JSONSchema
https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-npp-last-domestic-leg-disbursement-schema.json

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API
curl "https://apis.io/api/v1/apis/assembly-payments:assembly-payments-tools-api"
All apis
curl "https://apis.io/api/v1/apis?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.

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

OpenAPI Specification

assembly-payments-tools-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Assembly Tools API
  description: Assembly (formely PromisePay) is a powerful payments engine custom-built for platforms and marketplaces.
  version: '2.4'
  contact:
    email: support@assemblypayments.com
    url: http://docs.assemblypayments.com/
servers:
- url: https://test.api.promisepay.com
  description: Pre-live environment
- url: https://secure.api.promisepay.com
  description: Production environment
- url: https://au-0000.sandbox.auth.assemblypay.com
  description: Pre-Live (Sandbox) Auth issuing server and API
- url: https://au-0000.auth.assemblypay.com
  description: Production Auth issuing server and API
- description: SwaggerHub API Auto Mocking
  url: https://virtserver.swaggerhub.com/AssemblyPlatforms/assembly-api/2.1
security:
- oAuth2ClientCredentials: []
tags:
- name: Tools
paths:
  /tools/status:
    get:
      tags:
      - Tools
      summary: Health check
      description: Displays a health check of the Assembly service.
      operationId: healthCheck
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tools_status'
              examples:
                response:
                  value:
                    status: healthy
components:
  schemas:
    tools_status:
      properties:
        status:
          type: string
          example: healthy
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      description: Please refer to Authentication section within https://developer.assemblypayments.com/reference#authentication
      flows:
        clientCredentials:
          tokenUrl: https://au-0000.sandbox.auth.assemblypay.com/tokens
          scopes: {}
x-explorer-enabled: false
x-samples-languages:
- curl
- ruby
- php
- javascript
- csharp
- go
x-proxy-enabled: true
x-samples-enabled: true
x-provenance:
  method: searched
  source: https://developer.hellozai.com/reference
  harvested: '2026-10-22'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.hellozai.com/reference/authorizepayment.md
  - https://developer.hellozai.com/reference/billpayment.md
  - https://developer.hellozai.com/reference/billpaymentsubwallet.md
  - https://developer.hellozai.com/reference/cancelitem.md
  - https://developer.hellozai.com/reference/capturepayment.md
  - https://developer.hellozai.com/reference/createbankaccount.md
  - https://developer.hellozai.com/reference/createbpayaccount.md
  - https://developer.hellozai.com/reference/createcallback.md
  - https://developer.hellozai.com/reference/createcardaccount.md
  - https://developer.hellozai.com/reference/createcharge.md
  - https://developer.hellozai.com/reference/createcompany.md
  - https://developer.hellozai.com/reference/createdirectdebitauthority.md
  - https://developer.hellozai.com/reference/createfee.md
  - https://developer.hellozai.com/reference/createitem.md
  - https://developer.hellozai.com/reference/createsubwallet.md
  - https://developer.hellozai.com/reference/createuser.md
  - https://developer.hellozai.com/reference/deletecallback.md
  - https://developer.hellozai.com/reference/deleteitem.md
  - https://developer.hellozai.com/reference/deletesubwallet.md
  - https://developer.hellozai.com/reference/generatetoken.md
  - https://developer.hellozai.com/reference/healthcheck.md
  - https://developer.hellozai.com/reference/listbatchtransactions.md
  - https://developer.hellozai.com/reference/listcallbackresponse.md
  - https://developer.hellozai.com/reference/listcallbacks.md
  - https://developer.hellozai.com/reference/listcharges.md
  - https://developer.hellozai.com/reference/listcompanies.md
  - https://developer.hellozai.com/reference/listdirectdebitauthorities.md
  - https://developer.hellozai.com/reference/listdisbursement.md
  - https://developer.hellozai.com/reference/listfees.md
  - https://developer.hellozai.com/reference/listitembatchtransactions.md
  - https://developer.hellozai.com/reference/listitems.md
  - https://developer.hellozai.com/reference/listitemtransactions.md
  - https://developer.hellozai.com/reference/listsubwallets.md
  - https://developer.hellozai.com/reference/listtransactions.md
  - https://developer.hellozai.com/reference/listuserbpayaccounts.md
  - https://developer.hellozai.com/reference/listuseritems.md
  - https://developer.hellozai.com/reference/listusers.md
  - https://developer.hellozai.com/reference/makepayment.md
  - https://developer.hellozai.com/reference/makepaymentasync.md
  - https://developer.hellozai.com/reference/npplastdomesticleg.md
  - https://developer.hellozai.com/reference/redactbankaccount.md
  - https://developer.hellozai.com/reference/redactcardaccount.md
  - https://developer.hellozai.com/reference/refund.md
  - https://developer.hellozai.com/reference/releasepayment.md
  - https://developer.hellozai.com/reference/sendpennyamount.md
  - https://developer.hellozai.com/reference/setuserdisbursementaccount.md
  - https://developer.hellozai.com/reference/showaddress.md
  - https://developer.hellozai.com/reference/showbankaccount.md
  - https://developer.hellozai.com/reference/showbankaccountuser.md
  - https://developer.hellozai.com/reference/showbatchtransaction.md
  - https://developer.hellozai.com/reference/showbpayaccount.md
  - https://developer.hellozai.com/reference/showbpayaccountuser.md
  - https://developer.hellozai.com/reference/showcallback.md
  - https://developer.hellozai.com/reference/showcallbackresponse.md
  - https://developer.hellozai.com/reference/showcardaccount.md
  - https://developer.hellozai.com/reference/showcardaccountuser.md
  - https://developer.hellozai.com/reference/showcharge.md
  - https://developer.hellozai.com/reference/showchargebuyer.md
  - https://developer.hellozai.com/reference/showchargestatus.md
  - https://developer.hellozai.com/reference/showcompany.md
  - https://developer.hellozai.com/reference/showdirectdebitauthority.md
  - https://developer.hellozai.com/reference/showdisbursement.md
  - https://developer.hellozai.com/reference/showdisbursementbankaccounts.md
  - https://developer.hellozai.com/reference/showdisbursementitems.md
  - https://developer.hellozai.com/reference/showdisbursementtransactions.md
  - https://developer.hellozai.com/reference/showdisbursementusers.md
  - https://developer.hellozai.com/reference/showdisbursementwalletaccounts.md
  - https://developer.hellozai.com/reference/showfee.md
  - https://developer.hellozai.com/reference/showitem.md
  - https://developer.hellozai.com/reference/showitembuyer.md
  - https://developer.hellozai.com/reference/showitemfees.md
  - https://developer.hellozai.com/reference/showitemseller.md
  - https://developer.hellozai.com/reference/showitemstatus.md
  - https://developer.hellozai.com/reference/showitemwiredetails.md
  - https://developer.hellozai.com/reference/showmarketplace.md
  - https://developer.hellozai.com/reference/showsubwallet.md
  - https://developer.hellozai.com/reference/showsubwallettransactions.md
  - https://developer.hellozai.com/reference/showsubwalletuser.md
  - https://developer.hellozai.com/reference/showsubwalletwalletaccount.md
  - https://developer.hellozai.com/reference/showtransaction.md
  - https://developer.hellozai.com/reference/showtransactionbankaccount.md
  - https://developer.hellozai.com/reference/showtransactioncardaccount.md
  - https://developer.hellozai.com/reference/showtransactionfees.md
  - https://developer.hellozai.com/reference/showtransactionuser.md
  - https://developer.hellozai.com/reference/showtransactionwalletaccount.md
  - https://developer.hellozai.com/reference/showuser.md
  - https://developer.hellozai.com/reference/showuserbankaccount.md
  - https://developer.hellozai.com/reference/showusercardaccount.md
  - https://developer.hellozai.com/reference/showuserwalletaccounts.md
  - https://developer.hellozai.com/reference/showwalletaccount.md
  - https://developer.hellozai.com/reference/showwalletaccountnbpaydetails.md
  - https://developer.hellozai.com/reference/showwalletaccountnppdetails.md
  - https://developer.hellozai.com/reference/showwalletaccountuser.md
  - https://developer.hellozai.com/reference/token.md
  - https://developer.hellozai.com/reference/transfersubwallet.md
  - https://developer.hellozai.com/reference/updatecallback.md
  - https://developer.hellozai.com/reference/updatecompany.md
  - https://developer.hellozai.com/reference/updateitem.md
  - https://developer.hellozai.com/reference/updatesubwallet.md
  - https://developer.hellozai.com/reference/updateuser.md
  - https://developer.hellozai.com/reference/validateroutingnumber.md
  - https://developer.hellozai.com/reference/verifycard.md
  - https://developer.hellozai.com/reference/verifypennyamount.md
  - https://developer.hellozai.com/reference/verifyuser.md
  - https://developer.hellozai.com/reference/voidpayment.md
  - https://developer.hellozai.com/reference/withdrawfunds.md
  - https://developer.hellozai.com/reference/withdrawfundssubwallet.md
  merge:
    pages: 107
    deduped: 281
    conflicts_kept_first: 0