OFX · Schema

GetV1BusinessBeneficiariesBeneficiaryidResponse

CompanyPaymentsMoney TransferFintechBanking

Properties

Name	Type	Description
id	string	UUID identifying the beneficiary
name	string
firstName	string	First name of the beneficiary
lastName	string	Last name of the beneficiary
companyName	string
email	string	Email of the beneficiary
currency	string	Currency the beneficiary will receive
entityType	string	Type of beneficiary
ABN	string	Australian Business Number of this beneficiary
address	string	The full address of the beneficiary
country	string	Country where the beneficiary resides
state	string	State where the beneficiary resides
city	string	City where the beneficiary resides
postCode	string	PostCode of the beneficiary's address
accountNumber	string	The primary account number of the beneficiary
bankAccountHolderName	string	The name on the bank account holder
paymentType	string	The type of payment rail this beneficiary is using
payIdType	string	If the payment type is payId, the type of payId the beneficiary is using
customerReferenceNumber	string	BPAY customer reference number
bankCode	string	The value for the institution/bank‑level code
bankCodeValue	string	The actual routing value for the selected bankCodeType
bankCodeType	string	The type of the bank code
bankInfo	object	All the information about the bank account
BICSWIFT	string	Bank Identifier Code / SWIFT code for this beneficiary, if applicable.
IBAN	string	International Bank Account Number for this beneficiary, if applicable.
preferredXeroAccountCode	string	The preferred xero account code for this beneficiary
createdAt	string	ISO 8601 UTC datetime
updatedAt	string	ISO 8601 UTC datetime
updatedBy	string	UUID of the last updating user
status	string	The status of the beneficiary
validatedAt	string	UTC datetime of when the beneficiary was last validated

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ofx/main/json-schema/ofx-get-v1-business-beneficiaries-beneficiaryid-response-schema.json",
  "title": "GetV1BusinessBeneficiariesBeneficiaryidResponse",
  "x-generated": "2026-09-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_ae-authored/ofx-openapi-generated.yml#/components/schemas/GetV1BusinessBeneficiariesBeneficiaryidResponse",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID identifying the beneficiary"
    },
    "name": {
      "type": "string"
    },
    "firstName": {
      "type": "string",
      "description": "First name of the beneficiary"
    },
    "lastName": {
      "type": "string",
      "description": "Last name of the beneficiary"
    },
    "companyName": {
      "type": "string"
    },
    "email": {
      "type": "string",
      "description": "Email of the beneficiary"
    },
    "currency": {
      "type": "string",
      "description": "Currency the beneficiary will receive"
    },
    "entityType": {
      "type": "string",
      "description": "Type of beneficiary"
    },
    "ABN": {
      "type": "string",
      "description": "Australian Business Number of this beneficiary"
    },
    "address": {
      "type": "string",
      "description": "The full address of the beneficiary"
    },
    "country": {
      "type": "string",
      "description": "Country where the beneficiary resides"
    },
    "state": {
      "type": "string",
      "description": "State where the beneficiary resides"
    },
    "city": {
      "type": "string",
      "description": "City where the beneficiary resides"
    },
    "postCode": {
      "type": "string",
      "description": "PostCode of the beneficiary's address"
    },
    "accountNumber": {
      "type": "string",
      "description": "The primary account number of the beneficiary"
    },
    "bankAccountHolderName": {
      "type": "string",
      "description": "The name on the bank account holder"
    },
    "paymentType": {
      "type": "string",
      "description": "The type of payment rail this beneficiary is using"
    },
    "payIdType": {
      "type": "string",
      "description": "If the payment type is payId, the type of payId the beneficiary is using"
    },
    "customerReferenceNumber": {
      "type": "string",
      "description": "BPAY customer reference number"
    },
    "bankCode": {
      "type": "string",
      "description": "The value for the institution/bank‑level code"
    },
    "bankCodeValue": {
      "type": "string",
      "description": "The actual routing value for the selected bankCodeType"
    },
    "bankCodeType": {
      "type": "string",
      "description": "The type of the bank code"
    },
    "bankInfo": {
      "type": "object",
      "description": "All the information about the bank account"
    },
    "BICSWIFT": {
      "type": "string",
      "description": "Bank Identifier Code / SWIFT code for this beneficiary, if applicable."
    },
    "IBAN": {
      "type": "string",
      "description": "International Bank Account Number for this beneficiary, if applicable."
    },
    "preferredXeroAccountCode": {
      "type": "string",
      "description": "The preferred xero account code for this beneficiary"
    },
    "createdAt": {
      "type": "string",
      "description": "ISO 8601 UTC datetime"
    },
    "updatedAt": {
      "type": "string",
      "description": "ISO 8601 UTC datetime"
    },
    "updatedBy": {
      "type": "string",
      "description": "UUID of the last updating user"
    },
    "status": {
      "type": "string",
      "description": "The status of the beneficiary"
    },
    "validatedAt": {
      "type": "string",
      "description": "UTC datetime of when the beneficiary was last validated"
    }
  }
}

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/ofx-get-v1-business-beneficiaries-beneficiaryid-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.

GitHub Google LinkedIn

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