XExeroapi
Accounting

Retrieves a specific batch payment using a unique batch payment Id

Changed on
get/BatchPayments/{BatchPaymentID}

Request

  • Base URL
    https://api.xero.com/api.xro/2.0
  • URL
    https://api.xero.com/api.xro/2.0/BatchPayments/{BatchPaymentID}
  • Auth
    OAuth 2
    Authorization code: https://login.xero.com/identity/connect/authorize
    Token URL: https://identity.xero.com/connect/token scopes: accounting.transactions, accounting.transactions.read

Path parameters

BatchPaymentIDstring uuid required

Unique identifier for BatchPayment

Response

Success - return response of type BatchPayments array with matching batch payment Id

Changes

  • de95a0883a4aRevision changes
    • info

      the response optional property ///// became not read-only for the status

    • info

      the response optional property /////// became not read-only for the status

    • info

      the response optional property ////////// became not read-only for the status

    • info

      the response optional property //////// became not read-only for the status

  • a6564fbc9cd6Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      the response optional property ///// became not read-only for the status

    • info

      the response optional property ///// became not read-only for the status

    • info

      the response optional property ///// became not read-only for the status