ADadfin
Invoices

Resume collection for an invoice

Changed on

Starts collection of every payment request raised for this invoice by the named methods again. Those payment requests keep being collected even while the customer as a whole is paused. Methods that are not named keep their current state.

put/invoices/{invoiceId}:resume_collection

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/invoices/{invoiceId}:resume_collection
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.staging.adfin.com/api/oauth2/token
    • or OAuth 2
      Client credentials
      Token URL: https://api.adfin.com/api/oauth2/token

Path parameters

invoiceIdstring uuid required

The identifier of the invoice.

Request body

collectionMethodsstring[] required

The collection methods to resume. At least one method is required.

Response

Collection is resumed for the named methods.

Changes

  • cbec1c02c8cfRevision changes
    • breaking

      the request property's minItems was increased to 1

  • 15c1340dcb72Revision changes
    • info

      the endpoint scheme security Biller Access Token (Production) was added to the API

    • info

      the endpoint scheme security Biller Access Token (Staging) was added to the API