ADadfin
Payment requests

Activate (send) a payment request

put/payment_requests/{id}:activate

Request

  • Base URL
    https://api.adfin.com/api
  • URL
    https://api.adfin.com/api/payment_requests/{id}:activate
  • 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

idstring required

The id of the payment request

Request body

collectionMethod'ONE_TIME_PAYMENT' | 'DIRECT_DEBIT_PAYMENT' | 'NONE'

How the payment is expected to be collected for this invoice.

customMessagestring

An optional message that will be sent to the customer when the invoice is activated.

templateIdstring

The schedule template id used for sending the invoice to customer.

Response

The payment request was activated

Changes

No recorded changes to this operation across all 43 revisions of this API.