Assembly Payments · Schema

InitiatePaymentResponse

CompanyPaymentsFintechMarketplacesDigital WalletsPayoutsAustraliaPayTo

Properties

Name Type Description
payment_request_uuid string Unique identifier for the payment request in UUID format.
agreement_uuid string Unique agreement identifier.
instruction_id string Unique identifier for the payment request generated as per NPPA guidelines.
status string Payment initiation request statuses:
CodeDescription
PENDING_PAYMENT_INITIATIONPayment request is pending for initiation.
PAYMENT_INIT
created_at string Payment request creation date in UTC format.
updated_at string Payment request modification date in UTC format.
agreement_id string Unique agreement identifier generated by NPPA.

JSON Schema

assembly-payments-initiate-payment-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/assembly-payments/main/json-schema/assembly-payments-initiate-payment-response-schema.json",
  "title": "InitiatePaymentResponse",
  "x-generated": "2026-10-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/assembly-payments-payto-api-openapi.yml#/components/schemas/InitiatePaymentResponse",
  "type": "object",
  "properties": {
    "payment_request_uuid": {
      "maxLength": 36,
      "minLength": 36,
      "type": "string",
      "description": "Unique identifier for the payment request in UUID format."
    },
    "agreement_uuid": {
      "maxLength": 36,
      "minLength": 36,
      "type": "string",
      "description": "Unique agreement identifier."
    },
    "instruction_id": {
      "maxLength": 35,
      "minLength": 1,
      "type": "string",
      "description": "Unique identifier for the payment request generated as per NPPA guidelines."
    },
    "status": {
      "title": "Status",
      "type": "string",
      "description": "Payment initiation request statuses:<table><tr><td>Code</td><td>Description</td></tr><tr><td>PENDING_PAYMENT_INITIATION</td><td>Payment request is pending for initiation.</td></tr><tr><td>PAYMENT_INITIATION_REJECTED</td><td>Payment request is rejected.</td></tr></table>",
      "enum": [
        "PENDING_PAYMENT_INITIATION",
        "PAYMENT_INITIATION_REJECTED"
      ]
    },
    "created_at": {
      "type": "string",
      "description": "Payment request creation date in UTC format."
    },
    "updated_at": {
      "type": "string",
      "description": "Payment request modification date in UTC format."
    },
    "agreement_id": {
      "type": "string",
      "description": "Unique agreement identifier generated by NPPA."
    }
  }
}

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-initiate-payment-response"
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.

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