XExeroapi
Accounting

Updates a specific payment for invoices and credit notes

Changed on
post/Payments/{PaymentID}

Request

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

Path parameters

PaymentIDstring uuid required

Unique identifier for a Payment

Headers

Idempotency-Keystring

This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

Request body

Statusstring required

The status of the payment.

Response

Success - return response of type Payments array for updated Payment

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