CancelPayment Method

Cancels a scheduled bill payment.

Object Oriented Interface

public function doCancelPayment($paymentid);

Procedural Interface

ipworksofx_billpayment_do_cancelpayment($res, $paymentid);


This function generates the Signon and Payment Cancellation request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

The PaymentId parameter identifies the payment to be canceled. This is the id assigned and returned by the server at the time the payment was scheduled (that was stored in PaymentId).

The following properties should be set when this method is called:

FIUrl (required)
FIId (required)
FIOrganization (required)
OFXAppId (required)
OFXAppVersion (required)
OFXUser (required)
OFXPassword (required)

Upon successful response, the server will return the PaymentId which echoes the PaymentId.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OFX 2020 PHP Edition - Version 20.0 [Build 7941]