Zai

Zai Users API

The Users API from Zai — 9 operation(s) for users.

Operations 11

GET /users/{id}/bpay_accounts List User's BPay Accounts #
GET /users/{id}/card_accounts Show User Card Account #
GET /users/{id} Show User #
PATCH /users/{id} Update User #
PATCH /users/{id}/identity_verified Verify User (Prelive Only) #
GET /users/{id}/bank_accounts Show User Bank Account #
PATCH /users/{id}/disbursement_account Set User Disbursement Account #
GET /users List Users #
POST /users Create User #
GET /users/{id}/items List User Items #
GET /users/{id}/wallet_accounts Show User Wallet Account #

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/zai-users-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 email required.

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

OpenAPI Specification

zai-users-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Assembly Users API
  description: Assembly (formely PromisePay) is a powerful payments engine custom-built for platforms and marketplaces.
  version: '2.3'
  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.3
security:
- oAuth2ClientCredentials: []
tags:
- name: Users
paths:
  /users/{id}/bpay_accounts:
    get:
      tags:
      - Users
      summary: List User's BPay Accounts
      description: List the **BPay Accounts** the **User** is associated with using a given `:id`.
      operationId: listUserBPayAccounts
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: 901d8cd0-6af3-0138-967d-0a58a9feac04
        example: 901d8cd0-6af3-0138-967d-0a58a9feac04
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list_bpay_accounts'
              examples:
                response:
                  value:
                    bpay_accounts:
                    - id: b0980390-ac5b-0138-8b2e-0a58a9feac03
                      active: true
                      created_at: '2020-07-20 02:07:33.583000+00:00'
                      updated_at: '2020-07-20 02:07:33.583000+00:00'
                      bpay_details:
                        biller_name: APIBCD AV4
                        account_name: Test Biller
                        biller_code: '93815'
                        crn: '613295205'
                      currency: AUD
                      verification_status: verified
                      links:
                        self: /bpay_accounts/b0980390-ac5b-0138-8b2e-0a58a9feac03
                        users: /bpay_accounts/b0980390-ac5b-0138-8b2e-0a58a9feac03/users
                    meta:
                      limit: 10
                      offset: 0
                      total: 1
                    links:
                      self: /users/901d8cd0-6af3-0138-967d-0a58a9feac04/bpay_accounts
  /users/{id}/card_accounts:
    get:
      tags:
      - Users
      summary: Show User Card Account
      description: Show the user's active card account using a given `:id`.
      operationId: showUserCardAccount
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: buyer-71439598
        example: buyer-71439598
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card_account'
              examples:
                response:
                  value:
                    card_accounts:
                      active: true
                      created_at: '2020-05-06T01:38:29.022Z'
                      updated_at: '2020-05-06T01:38:29.022Z'
                      id: 35977230-7168-0138-0a1d-0a58a9feac07
                      verification_status: not_verified
                      cvv_verified: true
                      currency: AUD
                      card:
                        type: visa
                        full_name: Neol Test
                        number: XXXX-XXXX-XXXX-1111
                        expiry_month: '7'
                        expiry_year: '2021'
                      links:
                        self: /users/buyer-71439598/card_accounts
                        users: /card_accounts/35977230-7168-0138-0a1d-0a58a9feac07/users
  /users/{id}:
    get:
      tags:
      - Users
      summary: Show User
      description: Show details of a specific User using a given `:id`.
      operationId: showUser
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: string
          default: buyer-1556506027
        example: buyer-1556506027
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_user'
              examples:
                response:
                  value:
                    users:
                      created_at: '2019-04-29T02:47:08.348Z'
                      updated_at: '2019-04-29T02:47:08.348Z'
                      full_name: Neol1556506027 Calangi
                      email: neol.calangi+buyer1556506027@promisepay.com
                      mobile: '+21556506027'
                      phone: null
                      logo_url: null
                      color_1: null
                      color_2: null
                      first_name: Neol1556506027
                      last_name: Calangi
                      id: buyer-1556506027
                      custom_descriptor: null
                      location: AUS
                      verification_state: pending
                      held_state: false
                      roles:
                      - customer
                      dob: encrypted
                      government_number: null
                      drivers_license: null
                      flags: {}
                      related:
                        addresses: 00eb5be0-4c57-0137-ad3d-0242ac110002
                      links:
                        self: /users/buyer-1556506027
                        items: /users/buyer-1556506027/items
                        card_accounts: /users/buyer-1556506027/card_accounts
                        paypal_accounts: /users/buyer-1556506027/paypal_accounts
                        payid_accounts: /users/buyer-1556506027/payid_accounts
                        bank_accounts: /users/buyer-1556506027/bank_accounts
                        wallet_accounts: /users/buyer-1556506027/wallet_accounts
    patch:
      tags:
      - Users
      summary: Update User
      description: Update an existing **User's** attributes using a given `:id`.
      operationId: updateUser
      parameters:
      - name: id
        in: path
        description: Unique ID that can be generated by the platform. Cannot contain '.' character.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: buyer-1556506027
        example: buyer-1556506027
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_user_requestBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_user'
              examples:
                response:
                  value:
                    users:
                      created_at: '2019-04-29T02:47:08.348Z'
                      updated_at: '2019-04-29T02:47:08.348Z'
                      full_name: Neol1556506027 Calangi
                      email: neol.calangi+buyer1556506027@promisepay.com
                      mobile: '+21556506027'
                      phone: null
                      logo_url: null
                      color_1: null
                      color_2: null
                      first_name: Neol1556506027
                      last_name: Calangi
                      id: buyer-1556506027
                      custom_descriptor: null
                      location: AUS
                      verification_state: pending
                      held_state: false
                      roles:
                      - customer
                      dob: encrypted
                      government_number: null
                      drivers_license: null
                      flags: {}
                      related:
                        addresses: 00eb5be0-4c57-0137-ad3d-0242ac110002
                      links:
                        self: /charges/4d7d73f5-c7f0-477d-aff8-7570d2c7e7d9/buyers
                        items: /users/buyer-1556506027/items
                        card_accounts: /users/buyer-1556506027/card_accounts
                        paypal_accounts: /users/buyer-1556506027/paypal_accounts
                        payid_accounts: /users/buyer-1556506027/payid_accounts
                        bank_accounts: /users/buyer-1556506027/bank_accounts
                        wallet_accounts: /users/buyer-1556506027/wallet_accounts
  /users/{id}/identity_verified:
    patch:
      tags:
      - Users
      summary: Verify User (Prelive Only)
      description: 'Sets a user''s verification state to `approved` on pre-live given the **User** `:id`. Ensure that a **User** has the required user verification information before using this call, otherwise the call will fail. **Note**: This API call will only work in our pre-live environment. The user verification workflow holds for all users in production.

        '
      operationId: verifyUser
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: buyer-1556506027
        example: buyer-1556506027
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_user'
              examples:
                response:
                  value:
                    users:
                      created_at: '2019-04-29T02:47:08.348Z'
                      updated_at: '2019-04-29T02:47:08.348Z'
                      full_name: Neol1556506027 Calangi
                      email: neol.calangi+buyer1556506027@promisepay.com
                      mobile: '+21556506027'
                      phone: null
                      logo_url: null
                      color_1: null
                      color_2: null
                      first_name: Neol1556506027
                      last_name: Calangi
                      id: buyer-1556506027
                      custom_descriptor: null
                      location: AUS
                      verification_state: pending
                      held_state: false
                      roles:
                      - customer
                      dob: encrypted
                      government_number: null
                      drivers_license: null
                      flags: {}
                      related:
                        addresses: 00eb5be0-4c57-0137-ad3d-0242ac110002
                      links:
                        self: /charges/4d7d73f5-c7f0-477d-aff8-7570d2c7e7d9/buyers
                        items: /users/buyer-1556506027/items
                        card_accounts: /users/buyer-1556506027/card_accounts
                        paypal_accounts: /users/buyer-1556506027/paypal_accounts
                        payid_accounts: /users/buyer-1556506027/payid_accounts
                        bank_accounts: /users/buyer-1556506027/bank_accounts
                        wallet_accounts: /users/buyer-1556506027/wallet_accounts
  /users/{id}/bank_accounts:
    get:
      tags:
      - Users
      summary: Show User Bank Account
      description: Shows the user's active bank account using a given `:id`.
      operationId: showUserBankAccount
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: 46deb476-c1a6-41eb-8eb7-26a695bbe5bc
        example: 46deb476-c1a6-41eb-8eb7-26a695bbe5bc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bank_account_au'
              examples:
                response:
                  value:
                    bank_accounts:
                      id: 46deb476-c1a6-41eb-8eb7-26a695bbe5bc
                      created_at: '2016-04-12T09:20:38.540Z'
                      updated_at: '2016-04-12T09:20:38.540Z'
                      active: true
                      verification_status: not_verified
                      currency: AUD
                      bank:
                        bank_name: Bank of Australia
                        country: AUS
                        account_name: Samuel Seller
                        routing_number: XXXXX3
                        account_number: XXX234
                        holder_type: personal
                        account_type: checking
                        direct_debit_authority_status: null
                      links:
                        self: /users/46deb476-c1a6-41eb-8eb7-26a695bbe5bc/bank_accounts
                        users: /bank_accounts/46deb476-c1a6-41eb-8eb7-26a695bbe5bc/users
                        direct_debit_authorities: /bank_accounts/46deb476-c1a6-41eb-8eb7-26a695bbe5bc/direct_debit_authorities
  /users/{id}/disbursement_account:
    patch:
      tags:
      - Users
      summary: Set User Disbursement Account
      description: Set the **User's Disbursement Account** using a given **User** `:id` and a **Bank Account** `:account_id`.
      operationId: setUserDisbursementAccount
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        schema:
          type: string
          default: Seller_1234
        example: Seller_1234
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bank_account_id_requestBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_user'
              examples:
                response:
                  value:
                    users:
                      created_at: '2020-04-03T07:59:00.379Z'
                      updated_at: '2020-04-03T07:59:00.379Z'
                      id: Seller_1234
                      full_name: Samuel Seller
                      email: sam@example.com
                      mobile: 69543131
                      phone: null
                      logo_url: null
                      color_1: null
                      color_2: null
                      first_name: Samuel
                      last_name: Seller
                      custom_descriptor: Sam Garden Jobs
                      location: AUS
                      verification_state: pending
                      held_state: false
                      roles:
                      - customer
                      dob: encrypted
                      government_number: encrypted
                      drivers_license: null
                      flags: {}
                      related:
                        addresses: 11111111-2222-3333-4444-55555555555,
                      links:
                        self: /bank_accounts/901d8cd0-6af3-0138-967d-0a58a9feac04/users
                        items: /users/e6bc0480-57ae-0138-c46e-0a58a9feac03/items
                        card_accounts: /users/e6bc0480-57ae-0138-c46e-0a58a9feac03/card_accounts
                        paypal_accounts: /users/e6bc0480-57ae-0138-c46e-0a58a9feac03/paypal_accounts
                        payid_accounts: /users/e6bc0480-57ae-0138-c46e-0a58a9feac03/payid_accounts
                        bank_accounts: /users/e6bc0480-57ae-0138-c46e-0a58a9feac03/bank_accounts
                        wallet_accounts: /users/e6bc0480-57ae-0138-c46e-0a58a9feac03/wallet_accounts
  /users:
    get:
      tags:
      - Users
      summary: List Users
      description: Retrieve an ordered and paginated list of existing **Users**.
      operationId: listUsers
      parameters:
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      - name: search
        in: query
        description: A text value to be used for searching users
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: ''
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/users'
              examples:
                response:
                  value:
                    users:
                    - id: seller-71460518
                      full_name: Assembly seller71460518
                      first_name: Assembly
                      last_name: seller71460518
                      created_at: '2020-05-06T07:26:59.479Z'
                      updated_at: '2020-05-06T07:26:59.479Z'
                      email: neol_seller71460518@assemblypayments.com
                      mobile: '+1588750018'
                      phone: null
                      location: N/A
                      links:
                        self: /users/seller-71460518
                        items: /users/seller-71460518/items
                        card_accounts: /users/seller-71460518/card_accounts
                        paypal_accounts: /users/seller-71460518/paypal_accounts
                        bank_accounts: /users/seller-71460518/bank_accounts
                        wallet_accounts: /users/seller-71460518/wallet_accounts
                    - id: buyer-71439598
                      full_name: Buyer
                      first_name: Buyer
                      last_name: ''
                      created_at: '2020-05-06T01:38:19.116Z'
                      updated_at: '2020-05-06T02:03:25.941Z'
                      email: assemblybuyer71439598@assemblypayments.com
                      mobile: null
                      phone: null
                      location: N/A
                      links:
                        self: /users/buyer-71439598
                        items: /users/buyer-71439598/items
                        card_accounts: /users/buyer-71439598/card_accounts
                        paypal_accounts: /users/buyer-71439598/paypal_accounts
                        bank_accounts: /users/buyer-71439598/bank_accounts
                        wallet_accounts: /users/buyer-71439598/wallet_accounts
                    meta:
                      limit: 2
                      offset: 0
                      total: 16
                    links:
                      self: /users
    post:
      tags:
      - Users
      summary: Create User
      description: 'Create a **User** that can be associated with **Items** as either a buyer or a seller. **Users** can''t be both the buyer and seller for the same **Item**. You can also use this endpoint to create a **company** for the user. To create a company for the user, you need to send company parameters in the same request. **Note**: Some parameters are required for user verification. See our guide on [Onboarding a Payout User/Seller](https://developer.hellozai.com/docs/onboarding-a-pay-out-user) for more information.

        '
      operationId: createUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/user_requestBody'
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_user'
              examples:
                response:
                  value:
                    users:
                      created_at: '2019-04-29T02:47:08.348Z'
                      updated_at: '2019-04-29T02:47:08.348Z'
                      full_name: Neol1556506027 Calangi
                      email: neol.calangi+buyer1556506027@promisepay.com
                      mobile: '+21556506027'
                      phone: null
                      logo_url: null
                      color_1: null
                      color_2: null
                      first_name: Neol1556506027
                      last_name: Calangi
                      id: buyer-1556506027
                      custom_descriptor: null
                      location: AUS
                      verification_state: pending
                      held_state: false
                      roles:
                      - customer
                      dob: encrypted
                      government_number: null
                      drivers_license: null
                      flags: {}
                      related:
                        addresses: 00eb5be0-4c57-0137-ad3d-0242ac110002
                      links:
                        self: /charges/4d7d73f5-c7f0-477d-aff8-7570d2c7e7d9/buyers
                        items: /users/buyer-1556506027/items
                        card_accounts: /users/buyer-1556506027/card_accounts
                        paypal_accounts: /users/buyer-1556506027/paypal_accounts
                        payid_accounts: /users/buyer-1556506027/payid_accounts
                        bank_accounts: /users/buyer-1556506027/bank_accounts
                        wallet_accounts: /users/buyer-1556506027/wallet_accounts
  /users/{id}/items:
    get:
      tags:
      - Users
      summary: List User Items
      description: Retrieve an ordered and paginated list of existing **Items** the **User** is associated with using a given `:id`.
      operationId: listUserItems
      parameters:
      - $ref: '#/components/parameters/offsetParam'
      - $ref: '#/components/parameters/limitParam'
      - name: id
        in: path
        description: User ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: test-user-1592459047-22
        example: test-user-1592459047-22
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/items'
              examples:
                response:
                  value:
                    items:
                    - id: 7139651-1-2046
                      name: Item 7139651-1-2046
                      description: Test Item 7139651-1-2046
                      created_at: '2020-05-05T12:26:50.782Z'
                      updated_at: '2020-05-05T12:31:03.654Z'
                      state: payment_deposited
                      payment_type_id: 2
                      status: 22200
                      amount: 109
                      deposit_reference: '100014012501482'
                      buyer_name: Buyer Last Name
                      buyer_country: AUS
                      buyer_email: assemblybuyer71391895@assemblypayments.com
                      seller_name: Assembly seller71391950
                      seller_country: AUS
                      seller_email: neol_seller71391950@assemblypayments.com
                      tds_check_state: NA
                      currency: AUD
                      links:
                        self: /items/7139651-1-2046
                        buyers: /items/7139651-1-2046/buyers
                        sellers: /items/7139651-1-2046/sellers
                        status: /items/7139651-1-2046/status
                        fees: /items/7139651-1-2046/fees
                        transactions: /items/7139651-1-2046/transactions
                        batch_transactions: /items/7139651-1-2046/batch_transactions
                        wire_details: /items/7139651-1-2046/wire_details
                        bpay_details: /items/7139651-1-2046/bpay_details
                    links:
                      self: /items
                    meta:
                      limit: 10
                      offset: 0
                      total: 1
  /users/{id}/wallet_accounts:
    get:
      tags:
      - Users
      summary: Show User Wallet Account
      description: Show the **User's Wallet Account** using a given `:id`.
      operationId: showUserWalletAccounts
      parameters:
      - name: id
        in: path
        description: User ID
        required: true
        style: simple
        explode: false
        schema:
          type: string
          default: aed45af0-6f63-0138-901c-0a58a9feac03
        example: aed45af0-6f63-0138-901c-0a58a9feac03
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/wallet_account'
              examples:
                response:
                  value:
                    wallet_accounts:
                      id: 5c1c6b10-4c56-0137-8cd7-0242ac110002
                      active: true
                      created_at: '2019-04-29T02:42:31.536Z'
                      updated_at: '2020-05-03T12:01:02.254Z'
                      balance: 663337
                      currency: AUD
                      links:
                        self: /transactions/aed45af0-6f63-0138-901c-0a58a9feac03/wallet_accounts
                        users: /wallet_accounts/5c1c6b10-4c56-0137-8cd7-0242ac110002/users
                        batch_transactions: /wallet_accounts/5c1c6b10-4c56-0137-8cd7-0242ac110002/batch_transactions
                        transactions: /wallet_accounts/5c1c6b10-4c56-0137-8cd7-0242ac110002/transactions
                        bpay_details: /wallet_accounts/5c1c6b10-4c56-0137-8cd7-0242ac110002/bpay_details
                        npp_details: /wallet_accounts/5c1c6b10-4c56-0137-8cd7-0242ac110002/npp_details
                        virtual_accounts: /wallet_accounts/5c1c6b10-4c56-0137-8cd7-0242ac110002/virtual_accounts
components:
  schemas:
    single_user:
      type: object
      properties:
        users:
          $ref: '#/components/schemas/user'
    bank_account_id_requestBody:
      type: object
      required:
      - account_id
      properties:
        account_id:
          description: Account ID (Bank account)
          type: string
          example: 901d8cd0-6af3-0138-967d-0a58a9feac04
          default: 901d8cd0-6af3-0138-967d-0a58a9feac04
    bank_account_au:
      type: object
      properties:
        bank_accounts:
          type: object
          properties:
            active:
              type: boolean
              example: true
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
            id:
              type: string
              format: uuid
              example: 46deb476-c1a6-41eb-8eb7-26a695bbe5bc
            currency:
              type: string
              example: AUD
            verification_status:
              type: string
              enum:
              - not_verified
              - in_progress
              - processed
              example: not_verified
            verification:
              type: object
              properties:
                verified_at:
                  type: string
                  format: date-time
                verification_method:
                  type: string
                  enum:
                  - COP
                result:
                  type: object
                  properties:
                    match_result:
                      type: string
                      enum:
                      - MTCH
                      - MTCO
                      - CMTC
                      - WMTC
                      - NMTC
                      - NMTO
                      - NINF
                      - NFND
                      - CLSD
            bank:
              type: object
              properties:
                bank_name:
                  type: string
                  example: Bank of Australia
                country:
                  type: string
                  example: AUS
                account_name:
                  type: string
                  example: Samuel Seller
                routing_number:
                  type: string
                  example: XXXXX3
                account_number:
                  type: string
                  example: XXX234
                holder_type:
                  type: string
                  enum:
                  - personal
                  - business
                  example: personal
                account_type:
                  type: string
                  enum:
                  - savings
                  - checking
                  example: checking
                direct_debit_authority_status:
                  type: string
                  readOnly: true
                  enum:
                  - 'null'
                  - approved
                  example: approved
            links:
              type: object
              properties:
                self:
                  type: string
                users:
                  type: string
                direct_debit_authorities:
                  type: string
    item:
      type: object
      required:
      - id
      - name
      - amount
      - payment_type
      - buyer_id
      - seller_id
      properties:
        id:
          type: string
          example: 7190770-1-2908
        name:
          type: string
          example: 'Item #001'
        description:
          type: string
          example: My first Item.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        state:
          type: string
          enum:
          - pending
          - payment_required
          - wire_pending
          - payment_pending
          - payment_held
          - payment_authorized
          - void_pending
          - voided
          - fraud_hold
          - payment_deposited
          - work_completed
          - problem_flagged
          - problem_resolve_requested
          - problem_escalated
          - completed
          - cancelled
          - refunded
          - refund_pending
          - refund_flagged
          - off_platform_refunded
          - partial_completed
          - partial_paid
          - off_platform_chargedback
          example: pending
        status:
          type: integer
          enum:
          - 22000
          - 22100
          - 22110
          - 22150
          - 22175
          - 22180
          - 22185
          - 22195
          - 22190
          - 22200
          - 22300
          - 22400
          - 22410
          - 22420
          - 22500
          - 22575
          - 22600
          - 22610
          - 22650
          - 22670
          - 22700
          - 22800
          - 22680
          example: 22000
        amount:
          type: integer
          example: 20000
        payment_type_id:
          type: integer
          example: 2
        currency:
          type: string
          example: AUD
        buyer_name:
          type: string
          example: Sample Buyer
        buyer_email:
          type: string
          format: email
          example: sample.buyer@assemblypayments.com
        buyer_country:
          type: string
          example: AUS
        seller_name:
          type: string
          example: Sample Seller
        seller_email:
          type: string
          format: email
          example: sample.seller@assemblypayments.com
        seller_country:
          type: string
          format: email
          example: AUS
        tds_check_state:
          type: string
          format: email
          example: NA
        batch_state:
          type: string
          example: null
        invoice_url:
          type: string
          example: null
        payout_descriptor:
          type: string
          example: null
        remaining_amount:
          type: integer
          example: 0
        requested_release_amount:
          type: integer
          example: 0
        custom_descriptor:
          type: string
      

# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zai/refs/heads/main/openapi/zai-users-api-openapi.yml