National Australia Bank (NAB) Gateway Payments API

openapi: 3.0.0
x-source: https://nabgateway-developer.nab.com.au/api-reference-assets/specs/cybs_merged.json
x-converted-from: swagger-2.0 (verbatim original at openapi/_original/national-australia-bank-gateway-payments-swagger.json, converted with swagger2openapi)
x-ownership: "Served by NAB's own NAB Gateway developer portal (nabgateway-developer.nab.com.au, HTTP 200, 2026-10-20), which is a white-label of the Cybersource (Visa Acceptance Solutions) Developer Center: its llms.txt titles itself Cybersource Developer Center and links this same merged spec as its API Reference (OpenAPI Spec), its API reference page is rendered from it, and its SDK/sample-code links go to github.com/CyberSource; servers[] therefore name apitest.cybersource.com, the gateway platform NAB resells."
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
tags:
  - name: payments
    description: >
      A payment authorizes the amount for the transaction. There are a number of
      supported payment

      instruments, such as Credit Card, Debit Card, e-Wallet, and Alternative Payments. A payment

      response includes the status of the request. It also includes processor-specific information

      when the request is successful and errors if unsuccessful.
  - name: capture
    description: >
      When you are ready to fulfill a customer’s order and transfer funds from
      the customer’s

      bank to your bank, capture the payment for that order.
  - name: reversal
    description: An authorization reversal releases the hold that the payment placed
      on the customer’s funds.
  - name: refund
    description: >
      A refund is a follow-on transaction that uses the ID returned from either
      a payment or capture request.
  - name: credit
    description: >
      A credit is a stand-alone transaction that is not linked to any previous
      transactions. It takes money from

      your merchant bank account and returns it to the customer.
  - name: void
    description: >
      A void cancels a payment or capture. A transaction can be voided only when
      CyberSource has not already

      submitted the capture to your processor. You cannot undo a void.
  - name: options
    description: >
      An option is a service that is used to retrieve meta data, rendering
      details and different payment options available from Cybersource.

      It can be used in many ways and Merchants must consult their Technical Partner in Cybersource for further details.
  - name: billingAgreements
    description: >
      A billingAgreement is a stand-alone transaction that is not linked to any
      previous transactions. It takes money from

      your merchant bank account and returns it to the customer.
  - name: orders
    description: >
      An order is a service that is used for initiating a transaction with
      itemized details, shipping, billing and buyer information. 
  - name: payment-tokens
    description: >
      A payment-tokens is a service that is used for retrieving vault details or
      deleting vault id/payment method.
  - name: TransactionBatches
    description: >
      Get a list of batch files or details of Individual file processed through
      the Offline Transaction Submission Services.
  - name: Tokenize
    description: >
      An orchestration resource used to combine multiple API calls into a single
      request.
  - name: Network Tokens
    description: >
      A Network Token represents a tokenized version of a card number (PAN) that
      can be used for payment transactions and, it's represented by a Tokenized
      Card in TMS.
  - name: Device
    description: >
      A Device represents a registered device with its certificates for client
      device authentication.
  - name: Instrument Identifier
    description: >
      An Instrument Identifier represents a unique card number(PAN) or bank
      account (echeck).

      It can also be associated with a Network Token that can be used for payment transactions.
  - name: Customer Payment Instrument
    description: >
      A Customer Payment Instrument is linked to a Customer and an Instrument
      Identifier.

      It stores additional information in relation to a card number(PAN) or bank account (echeck).
  - name: Payment Instrument
    description: >
      A stand-alone Payment Instrument is linked to an Instrument Identifier.

      It stores additional information in relation to a card number(PAN) or bank account (echeck).
  - name: Customer
    description: >
      A Customer can be linked to multiple Payment Instruments and Shipping
      Addresses.

      With one Payment Instrument and Shipping Address designated as the default.

      It stores merchant reference information for the Customer such as email and merchant defined data.
  - name: Customer Shipping Address
    description: |
      A Customer Shipping Address is linked to a Customer.
      It stores shipping information in relation to the Customer.
  - name: Tap
    description: >
      A Tap represents a payment tap.

      It stores track and EMV tag data for a defined period of time before being deleted.
  - name: Microform Integration
  - name: Flex API
    description: >
      The Flex API enables merchants to securely accept customer payment
      information captured within a server-side application using a set of APIs.

      These APIs protect your customer's primary account number (PAN), card verification number (CVN), and other payment information by embedding it within a transient token.

      This allows payment data to be stored and transported and complies with the Payment Card Industry Data Security Standard (PCI DSS) policies and procedures. These transient tokens can be validated by the receiver to ensure the data integrity and protect against data injection attacks.


      **Warning:** Flex API is intended for server-side applications only.  Do not use the Flex API in client-side applications.  To add secure payments directly into client-side code, use Unified Checkout.


      **How It Works**<br>

      Follow these steps to capture payments using the Flex API:

      * Establish a payment session with a predefined customer context.

      * Validate the JSON Web Token.

      * Populate the JSON Web Token with customer information.


      **Customer Context**<br>

      An important benefit of the Flex API is managing Personal Identifiable Information (PII). You can set up your customer context to include all PII associated with transactions, protecting this information from third parties.
  - name: Decision Manager
    description: REST API for the Decision Manager Service
  - name: Risk Services
    description: REST APIs for Risk Services
  - name: Visa Protect Risk Insights
    description: REST API for Visa Protect Risk Insights — Transaction Risk Scoring
      and Transaction Risk Labeling
  - name: Pull Funds
    description: >
      Cybersource Payouts Funds Transfer REST API for Account Funding
      Transaction (AFT)
  - name: Push Funds
    description: >
      A payout enables an originator to send funds on behalf of itself,
      merchants, or customers to credit card

      accounts using an Original Credit Transaction (OCT). An originator is a merchant, government entity, or

      corporation with a merchant account from an acquiring bank.
  - name: Payouts
    description: >
      A payout enables an originator to send funds on behalf of itself,
      merchants, or customers to credit card

      accounts using an Original Credit Transaction (OCT). An originator is a merchant, government entity, or

      corporation with a merchant account from an acquiring bank.
  - name: Foreign Exchange Rates
    description: |
      Retrieve current foreign exchange rates for cross-border payouts.
  - name: Transaction Query
    description: |
      Query the status and details of payouts transactions.
  - name: installments
    description: >
      Provides Visa Installment & Issuer Installment Solution for CyberSource
      Merchant.

      This API can be used for sending an installment inquiry transaction to either Visa (for Visa Installments)

      or to the cardholder's issuing bank (for issuer funded installments). The response for this API call

      will contain list of installment plans that the card holder might be eligible for. This service is applicable

      for Credit Cards only.
  - name: Plans
    description: |
      Create and manage Plans for subscriptions.
  - name: Subscriptions
    description: >
      Create and manage Recurring Subscriptions.


      You have option to link subscription to plan or create independent subscriptions.
  - name: Subscriptions Follow-Ons
    description: >
      Create a Follow-On Subscription from an already existing successful
      Transaction.


      You have option to link subscription to plan or create independent subscriptions.
  - name: Reports
    description: API for creation and retrieval of Reports
  - name: Report Definitions
    description: Get report definition information
  - name: Report Downloads
    description: API for creation and retrieval of Reports
  - name: Report Subscriptions
    description: API for creation and retrieval of Report Subscriptions
  - name: Net Fundings
    description: API for retrieving the netfunding data for an account or a merchant
  - name: Notification Of Changes
    description: API for Notification Of Change
  - name: Purchase And Refund Details
    description: API for Purchase and Refund Details
  - name: Payment Batch Summaries
    description: API for payment batch summary reports
  - name: Conversion Details
    description: API for retrieving conversion data for merchant
  - name: Download DTD
    description: API to download report DTDs
  - name: Download XSD
    description: API to download report XSDs
  - name: Chargeback Summaries
    description: API for requesting Chargeback Summaries.
  - name: Chargeback Details
    description: API for requesting Chargeback Details.
  - name: Retrieval Summaries
    description: API for requesting Retrieval Summaries
  - name: Retrieval Details
    description: API for requesting Retrieval Details.
  - name: Interchange Clearing Level Details
    description: API for requesting Interchange Clearing Level data for an account
      or a merchant.
  - name: File Details
    description: API to access file information
  - name: File Downloads
    description: API to download a file
  - name: Invoices
    description: >
      Offer your customers a simple, convenient, and fast way to pay with the
      new online invoicing tool.
  - name: Invoice Settings
    description: |
      Update the settings for the invoice payment page.
  - name: Payment Links
    description: >
      Offer your customers a simple, convenient, and fast way to pay with the
      new online pay by link tool.
  - name: Merchant Defined Fields
    description: |
      Define reusable custom fields for Purchase and Donation pay by link types.
  - name: management
    description: management rest resources
  - name: account number
    description: account number lookup
  - name: taxes
    description: tax calculation service
  - name: surcharge
    description: Surcharge service
  - name: Merchant Boarding
    description: Manage Boarding Registrations
  - name: Create New Webhooks
    description: |
      Create a new webhook connection
  - name: Manage Webhooks
    description: >
      - Manage your webhooks. This will allow for you to update existing
      webhooks, test webhooks, or delete them.
  - name: Create and Update devices
    description: Create and update terminal devices.
  - name: Device Search
    description: Search and Retrieve Devices.
  - name: Device De-Association
    description: Remove Association of a Device.
  - name: Device De-Association V3
    description: Remove Association of a Device V3 with Organization ID.
  - name: Activation Codes and Certificates
    description: Endpoints for Activation Codes and Certificates.
  - name: Customizations
    description: Endpoints for  Customizations.
  - name: Unified Checkout Capture Context
    externalDocs:
      description: Find out more
      url: https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html
  - name: Unified Checkout V1 Capture Context
    externalDocs:
      description: Find out more
      url: https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-about-guide.html
  - name: Transient Token Data v2
    externalDocs:
      url: https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-about-guide.html
      description: Find out more
  - name: Unified Click To Pay Capture Context
    externalDocs:
      url: https://developer.cybersource.com/docs/cybs/en-us/unified-click-to-pay/developer/all/rest/unified-click-to-pay/uctp-about-guide.html
      description: Find out more
  - name: Batches
    description: >
      Once a batch is created its status can be checked using the status
      resource.

      When the batch status is COMPLETED its report can then be retrieved.
  - name: bankAccountValidation
    description: >
      The Visa Bank Account Validation Service is a new standalone product
      designed to validate customer's routing and bank account number
      combination for ACH transactions. Merchant's can use this standalone
      product to validate their customer's account prior to processing an ACH
      transaction against the customer's account to comply with Nacha's account
      validation mandate for Web-debit transactions.
  - name: Offers
    description: |
      Operations related to creating, retrieving, and updating offers.
  - name: Enrollment
    description: Register a consumer's payment card for agentic and e-commerce
      transactions, creating a tokenized reference that can be used in
      subsequent purchase intents and payment credential retrieval.
  - name: Purchase_Intent
    description: Create, update, and cancel purchase intents (instructions) that
      define what a consumer wants to buy, including payment instrument
      references, mandates, spending limits, and merchant preferences.
  - name: Payment_Events
    description: Retrieve tokenized payment credentials for an authorized purchase
      intent and confirm transaction events across the payment lifecycle.
  - name: Credentials
    description: MPP (Machine Payment Protocol) token provisioning and encrypted
      credential generation. Use these APIs to provision encrypted payment
      credentials for use in MPP Authorization Payment headers. Accepts an
      instrument identifier and merchant challenge context, returns RSA-OAEP
      encrypted token payloads.
  - name: Agent_Registration
  - name: Merchant_Registration
  - name: Product_Feed
    description: >
      Enables merchants to expose structured, discoverable endpoints, product
      catalogs, and commerce capabilities to agent platforms. This allows agents
      to identify the right merchant interfaces, ingest relevant data, access
      checkout flows, and complete transactions in a consistent, interoperable
      way across the ecosystem.
  - name: ACP_Checkout
    description: >
      Enables ACP Agent to securely initiate and route transactions using
      network tokenization, while establishing verifiable identity and intent
      signals. This allows merchants and infrastructure providers to recognize
      trusted agents, differentiate them from generic automation, and reliably
      process agent-driven payment requests end-to-end.
  - name: UCP_Checkout
    description: >
      Enables UCP Agent to securely initiate and route transactions using
      network tokenization, while establishing verifiable identity and intent
      signals. This allows merchants and infrastructure providers to recognize
      trusted agents, differentiate them from generic automation, and reliably
      process agent-driven payment requests end-to-end.


# --- truncated at 32 KB (19434 KB total) ---
# Full source: https://artifacts.apis.io/national-australia-bank/openapi/national-australia-bank-gateway-payments-api-openapi.yml