National Australia Bank Report Definitions API
Get report definition information
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/national-australia-bank:national-australia-bank-report-definitions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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
openapi: 3.2.0
info:
description: All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
version: 0.0.1
title: CyberSource Merged Spec Report Definitions API
servers:
- url: https://apitest.cybersource.com/
tags:
- name: Report Definitions
description: Get report definition information
paths:
/reporting/v3/report-definitions/{reportDefinitionName}:
get:
tags:
- Report Definitions
summary: Get Report Definition
description: View the attributes of an individual report type. For a list of values for reportDefinitionName, see the Reporting Developer Guide
operationId: getResourceInfoByReportDefinition
x-queryParameterDefaults:
organizationId: testrest
parameters:
- name: reportDefinitionName
in: path
description: Name of the Report definition to retrieve
required: true
schema:
type: string
- name: subscriptionType
in: query
description: 'The subscription type for which report definition is required. By default the type will be CUSTOM.
Valid Values:
- CLASSIC
- CUSTOM
- STANDARD
'
required: false
schema:
type: string
- name: reportMimeType
in: query
description: 'The format for which the report definition is required. By default the value will be CSV.
Valid Values:
- application/xml
- text/csv
'
required: false
schema:
type: string
- name: organizationId
in: query
description: Valid Organization Id
required: false
schema:
type: string
maxLength: 32
minLength: 1
pattern: '[a-zA-Z0-9-_]+'
responses:
'200':
description: Ok
content:
application/hal+json:
schema:
title: reportingV3ReportDefinitionsNameGet200Response
type: object
properties:
type:
type: string
reportDefinitionId:
type: integer
format: int32
reportDefintionName:
type: string
attributes:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
description:
type: string
filterType:
type: string
description: Attribute Filter Type.
example: MULTI
default:
type: boolean
required:
type: boolean
supportedType:
type: string
description: Valid values for the filter.
example:
- ics_score
- ics_ap_auth
- ics_ap_auth_reversal
- ics_ap_billing_agreement
- ics_ap_cancel
- ics_ap_capture
- ics_ap_initiate
- ics_ap_options
- ics_ap_order
- ics_ap_refund
- ics_ap_sale
- ics_ap_sessions
- ics_ap_check_status
- ics_auto_auth_reversal
- ics_bank_transfer
- ics_bank_transfer_real_time
- ics_bank_transfer_refund
- ics_bin_lookup
- ics_boleto_payment
- ics_cm_action
- ics_china_payment
- ics_china_refund
- ics_auth
- ics_auto_full_auth_reversal
- ics_auth_refresh
- ics_auth_reversal
- ics_credit
- ics_bill
- ics_risk_update
- ics_dcc
- ics_dcc_update
- ics_decision
- ics_dm_event
- ics_direct_debit
- ics_direct_debit_mandate
- ics_direct_debit_refund
- ics_direct_debit_validate
- ics_ecp_authenticate
- ics_ecp_credit
- ics_ecp_debit
- ics_get_masterpass_data
- ics_get_visa_checkout_data
- ics_create_isv
- ics_get_isv_history
- ics_add_value_to_isv
- ics_get_isv_info
- ics_modify_isv
- ics_get_isv_profiles
- ics_redeem_isv
- ics_ifs_setup
- ics_ifs_update
- ics_ipgeo
- ics_oct
- ics_pa_enroll
- ics_pa_validate
- paypal_mip_agreement_ipn
- ics_paypal_button_create
- ics_paypal_credit
- ics_paypal_authorization
- ics_paypal_create_agreement
- ics_paypal_update_agreement
- ics_paypal_ec_order_setup
- ics_paypal_auth_reversal
- ics_paypal_ec_do_payment
- ics_paypal_do_ref_transaction
- ics_paypal_refund
- ics_paypal_do_capture
- paypal_ipn
- ics_paypal_preapproved_payment
- ics_pinless_debit
- ics_pinless_debit_validate
- ics_pinless_debit_reversal
- ics_export
- ics_service_fee_auth
- ics_service_fee_auth_reversal
- ics_service_fee_bill
- ics_service_fee_credit
- ics_service_fee_ecp_credit
- ics_service_fee_ecp_debit
- ics_pay_subscription_create
- ics_pay_subscription_create_dup
- ics_pay_subscription_delete
- ics_pay_subscription_update
- ics_dav
- ics_download
- ics_tax
- ics_timeout_auth_reversal
- ics_timeout_oct_reversal
- ics_void
- ics_pin_debit_purchase
- ics_pin_debit_credit
- ics_pin_debit_reversal
- ics_timeout_pin_debit_reversal
- ics_gift_card_activation
- ics_gift_card_balance_inquiry
- ics_gift_card_redemption
- ics_gift_card_refund
- ics_gift_card_reload
- ics_gift_card_void
- ics_gift_card_reversal
supportedFormats:
type: array
uniqueItems: true
items:
type: string
description: 'Valid values:
- application/xml
- text/csv
'
description:
type: string
defaultSettings:
title: reportDefinitionDefaultSettings
type: object
properties:
reportMimeType:
type: string
example: application/xml
description: "Report Format\nValid values:\n - application/xml\n - text/csv\n"
reportFrequency:
type: string
example: DAILY
description: "Report Frequency Value\nValid Values:\n - DAILY\n - WEEKLY\n - MONTHLY\n - ADHOC\n"
reportName:
type: string
description: Report Name
example: My Transaction Request Detail Report
timezone:
type: string
description: Time Zone
example: America/Chicago
startTime:
type: string
description: Start Time
example: '0000'
startDay:
type: integer
format: int32
description: Start Day
example: 1
reportFilters:
type: object
additionalProperties:
type: array
items:
type: string
description: List of filters to apply
example:
Application.Name:
- ics_auth
- ics_bill
reportPreferences:
type: object
description: Report Preferences
properties:
signedAmounts:
type: boolean
description: Indicator to determine whether negative sign infront of amount for all refunded transaction
fieldNameConvention:
type: string
description: 'Specify the field naming convention to be followed in reports (applicable to only csv report formats)
Valid values:
- SOAPI
- SCMP
'
subscriptionType:
type: string
example: CLASSIC
description: '''The subscription type for which report definition is required. By default the type will be CUSTOM.''
Valid Values:
- ''CLASSIC''
- ''CUSTOM''
- ''STANDARD''
'
'400':
description: Invalid request
content:
application/hal+json:
schema:
title: reportingV3ReportDefinitionsNameGet400Response
type: object
required:
- submitTimeUtc
- reason
- message
- details
properties:
submitTimeUtc:
type: string
format: date-time
description: "Time of request in UTC. \n"
example: '2016-08-11T22:47:57Z'
reason:
type: string
description: 'Documented reason code
'
example: INVALID_DATA
message:
type: string
description: 'Short descriptive message to the user.
'
example: One or more fields contains invalid data
details:
type: array
description: 'Error field list
'
items:
type: object
properties:
field:
type: string
description: 'Field in request that caused an error
'
reason:
type: string
description: 'Documented reason code
'
description: 'Provides failed validation input field detail
'
description: HTTP status code for client application
'404':
description: Report not found
/reporting/v3/report-definitions:
get:
tags:
- Report Definitions
summary: Get Reporting Resource Information
description: View a list of supported reports and their attributes before subscribing to them.
operationId: getResourceV2Info
x-queryParameterDefaults:
organizationId: testrest
parameters:
- in: query
name: subscriptionType
required: false
description: 'Valid Values:
- CLASSIC
- CUSTOM
- STANDARD
'
schema:
type: string
- name: organizationId
in: query
description: Valid Organization Id
required: false
schema:
type: string
maxLength: 32
minLength: 1
pattern: '[a-zA-Z0-9-_]+'
responses:
'200':
description: Ok
content:
application/hal+json:
schema:
title: reportingV3ReportDefinitionsGet200Response
type: object
properties:
reportDefinitions:
type: array
items:
type: object
properties:
type:
type: string
reportDefinitionId:
type: integer
format: int32
description: '| Id | Definition Class |
| --- | --------------------------------- |
| 210 | TransactionRequestClass |
| 211 | PaymentBatchDetailClass |
| 212 | ExceptionDetailClass |
| 213 | ProcessorSettlementDetailClass |
| 214 | ProcessorEventsDetailClass |
| 215 | FundingDetailClass |
| 216 | AgingDetailClass |
| 217 | ChargebackAndRetrievalDetailClass |
| 218 | DepositDetailClass |
| 219 | FeeDetailClass |
| 220 | InvoiceSummaryClass |
| 221 | PayerAuthDetailClass |
| 222 | ConversionDetailClass |
| 225 | BillableTransactionsDetailClass |
| 270 | JPTransactionDetailClass |
| 271 | ServiceFeeDetailClass |
| 310 | GatewayTransactionRequestClass |
| 400 | DecisionManagerEventDetailClass |
| 401 | DecisionManagerDetailClass |
| 410 | FeeSummaryClass |
| 420 | TaxCalculationClass |
| 520 | POSTerminalExceptionClass |
| 620 | SubscriptionDetailClass |
| 630 | StandardBillingDataPackageClass |
| 706 | StandardMonthlyFeeClass |
'
reportDefintionName:
type: string
supportedFormats:
type: array
uniqueItems: true
items:
type: string
description: 'Valid values:
- application/xml
- text/csv
'
description:
type: string
defaultSettings:
title: reportDefinitionDefaultSettings
type: object
properties:
reportMimeType:
type: string
example: application/xml
description: "Report Format\nValid values:\n - application/xml\n - text/csv\n"
reportFrequency:
type: string
example: DAILY
description: "Report Frequency Value\nValid Values:\n - DAILY\n - WEEKLY\n - MONTHLY\n - ADHOC\n"
reportName:
type: string
description: Report Name
example: My Transaction Request Detail Report
timezone:
type: string
description: Time Zone
example: America/Chicago
startTime:
type: string
description: Start Time
example: '0000'
startDay:
type: integer
format: int32
description: Start Day
example: 1
reportFilters:
type: object
additionalProperties:
type: array
items:
type: string
description: List of filters to apply
example:
Application.Name:
- ics_auth
- ics_bill
reportPreferences:
type: object
description: Report Preferences
properties:
signedAmounts:
type: boolean
description: Indicator to determine whether negative sign infront of amount for all refunded transaction
fieldNameConvention:
type: string
description: 'Specify the field naming convention to be followed in reports (applicable to only csv report formats)
Valid values:
- SOAPI
- SCMP
'
subscriptionType:
type: string
example: CLASSIC
description: '''The subscription type for which report definition is required. By default the type will be CUSTOM.''
Valid Values:
- CLASSIC
- CUSTOM
- STANDARD
'
'400':
description: Invalid request
content:
application/hal+json:
schema:
title: reportingV3ReportDefinitionsGet400Response
type: object
required:
- submitTimeUtc
- reason
- message
- details
properties:
submitTimeUtc:
type: string
format: date-time
description: "Time of request in UTC. \n"
example: '2016-08-11T22:47:57Z'
reason:
type: string
description: 'Documented reason code
'
example: INVALID_DATA
message:
type: string
description: 'Short descriptive message to the user.
'
example: One or more fields contains invalid data
details:
type: array
description: 'Error field list
'
items:
type: object
properties:
field:
type: string
description: 'Field in request that caused an error
'
reason:
type: string
description: 'Documented reason code
'
description: 'Provides failed validation input field detail
'
description: HTTP status code for client application
'404':
description: Report not found