National Australia Bank Payment Batch Summaries API

API for payment batch summary reports

Operations 1

GET /reporting/v3/payment-batch-summaries Get Payment Batch Summary Data #

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/national-australia-bank:national-australia-bank-payment-batch-summaries-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

national-australia-bank-payment-batch-summaries-api-openapi.yml Raw ↑
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 Payment Batch Summaries API
servers:
- url: https://apitest.cybersource.com/
tags:
- name: Payment Batch Summaries
  description: API for payment batch summary reports
paths:
  /reporting/v3/payment-batch-summaries:
    get:
      tags:
      - Payment Batch Summaries
      summary: Get Payment Batch Summary Data
      description: Scope can be either account/merchant or reseller.
      operationId: getPaymentBatchSummary
      x-queryParameterDefaults:
        organizationId: testrest
        startTime: '2019-05-01T12:00:00Z'
        endTime: '2019-08-30T12:00:00Z'
      parameters:
      - name: startTime
        in: query
        description: "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)\n\n**Example date format:**\n  - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n"
        required: true
        schema:
          type: string
          format: date-time
      - name: endTime
        in: query
        description: "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)\n\n**Example date format:**\n  - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n"
        required: true
        schema:
          type: string
          format: date-time
      - name: organizationId
        in: query
        description: Valid Organization Id
        required: false
        schema:
          type: string
          maxLength: 32
          minLength: 1
          pattern: '[a-zA-Z0-9-_]+'
      - name: rollUp
        in: query
        description: Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant
        required: false
        schema:
          type: string
      - name: breakdown
        in: query
        description: Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant.
        required: false
        schema:
          type: string
      - name: startDayOfWeek
        in: query
        description: Optional - Start day of week to breakdown data for weeks in a month
        required: false
        schema:
          type: integer
          format: int32
          maximum: 7
          minimum: 1
      responses:
        '200':
          description: Ok
          content:
            application/hal+json:
              schema:
                title: reportingV3PaymentBatchSummariesGet200Response
                type: object
                properties:
                  startTime:
                    type: string
                    format: date-time
                  endTime:
                    type: string
                    format: date-time
                  paymentBatchSummaries:
                    type: array
                    items:
                      type: object
                      properties:
                        currencyCode:
                          type: string
                          example: USD
                        paymentSubTypeDescription:
                          type: string
                          example: Diners Club
                        startTime:
                          type: string
                          format: date-time
                        endTime:
                          type: string
                          format: date-time
                        salesCount:
                          type: integer
                          example: 10
                          format: int32
                        salesAmount:
                          type: string
                          example: '5000.01'
                        creditCount:
                          type: integer
                          example: 10
                          format: int32
                        creditAmount:
                          type: string
                          example: '5000.01'
                        accountName:
                          type: string
                          example: ubmerchant296
                        accountId:
                          type: string
                          example: ubmerchant296_acct
                        merchantId:
                          type: string
                          example: ubmerchant296_3
                        merchantName:
                          type: string
                          example: ubmerchant296_3
            text/csv:
              schema:
                title: reportingV3PaymentBatchSummariesGet200Response
                type: object
                properties:
                  startTime:
                    type: string
                    format: date-time
                  endTime:
                    type: string
                    format: date-time
                  paymentBatchSummaries:
                    type: array
                    items:
                      type: object
                      properties:
                        currencyCode:
                          type: string
                          example: USD
                        paymentSubTypeDescription:
                          type: string
                          example: Diners Club
                        startTime:
                          type: string
                          format: date-time
                        endTime:
                          type: string
                          format: date-time
                        salesCount:
                          type: integer
                          example: 10
                          format: int32
                        salesAmount:
                          type: string
                          example: '5000.01'
                        creditCount:
                          type: integer
                          example: 10
                          format: int32
                        creditAmount:
                          type: string
                          example: '5000.01'
                        accountName:
                          type: string
                          example: ubmerchant296
                        accountId:
                          type: string
                          example: ubmerchant296_acct
                        merchantId:
                          type: string
                          example: ubmerchant296_3
                        merchantName:
                          type: string
                          example: ubmerchant296_3
            application/xml:
              schema:
                title: reportingV3PaymentBatchSummariesGet200Response
                type: object
                properties:
                  startTime:
                    type: string
                    format: date-time
                  endTime:
                    type: string
                    format: date-time
                  paymentBatchSummaries:
                    type: array
                    items:
                      type: object
                      properties:
                        currencyCode:
                          type: string
                          example: USD
                        paymentSubTypeDescription:
                          type: string
                          example: Diners Club
                        startTime:
                          type: string
                          format: date-time
                        endTime:
                          type: string
                          format: date-time
                        salesCount:
                          type: integer
                          example: 10
                          format: int32
                        salesAmount:
                          type: string
                          example: '5000.01'
                        creditCount:
                          type: integer
                          example: 10
                          format: int32
                        creditAmount:
                          type: string
                          example: '5000.01'
                        accountName:
                          type: string
                          example: ubmerchant296
                        accountId:
                          type: string
                          example: ubmerchant296_acct
                        merchantId:
                          type: string
                          example: ubmerchant296_3
                        merchantName:
                          type: string
                          example: ubmerchant296_3
        '400':
          description: Invalid request
          content:
            application/hal+json:
              schema:
                title: reportingV3PaymentBatchSummariesGet200Response
                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
            text/csv:
              schema:
                title: reportingV3PaymentBatchSummariesGet200Response
                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
            application/xml:
              schema:
                title: reportingV3PaymentBatchSummariesGet200Response
                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: Payment Batch Summary not found