Syntax

 createRebillingPayment(
     purchase_id
 )

Only for Vendors with permission for Billing on demand. 

Triggered rebilling means: You - the vendor - triggers the payments via api.

To enable this, set "Billing mode" to "by trigger" in the payment plan details.

Access rights

Full access required.

In addition, the “Billing on demand” right must be enabled for the vendor account.

Arguments

purchase_id – The id the purchase the rebilling payment should be triggered for.

Return data

purchase_id - the order  - same as the argument order id

payment_status - status of the payment:

  • completed
  • pending
  • uncertain
  • refused
  • error

payment_message - in case of error: the error message

biling_status - of the purchase:

  • paying - you may process payments
  • aborted - buyer/support stopped rebilling payments
  • unpaid - the order does not have an initial payment
  • completed - order is completely paid (for single payments and installments)
  • payment_data_update_required- indicates, if follow up payments can be processed
    • Y - payments are possible
    • N - the buyer needs to update the payment data - see payment_data_update_url
  • payment_data_update_url - direct the user to this url, so that he can enter new payment data (e.g. new credit card data)