You are here: CashBox1800APIGuide > 18 The Transaction Object > 18.3 Transaction Methods > finalizeCarrierBilling


The finalizeCarrierBilling method completes the process of signing up for a subscription using CarrierBilling as a payment method. This method enables merchants to pass a PIN, sent to customer’s phone, back to the Carrier for validation. Merchants must also pass a transactionVid, an ID from the initial transaction object returned by the Autobill.update() call, to finalizeCarrierBilling. Use this method only when you are working with an AutoBill that is paid for with a CarrierBilling-based payment method.

CashBox generates the validation transaction when you create the AutoBill by calling the update() method with the validatePaymentMethod flag turned on. The update() call returns an initialTransaction object. You should use the initialTransaction.VID in the finalizeCarrierBilling call. Upon return of the Autobill.update() call, prompt the customer to enter the PIN they received in a test from the Carrier. Once the customer provides this PIN, call finalizePayPalAuth()with this PIN and transactionVid. AutoBill will begin billing only after this finalize call is complete.


srd: sparse response description, a SOAP string (which must be a JSON object), in which you specify the elements you want returned.This parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call.

Some fields are required, either practically or in the WSDL, and will be returned regardless of the srd. A null srd returns the complete response.

transactionVid: Vindicia-generated ID (VID) for the Transaction. This will be available in the Transaction returned by the AutoBill.update() or Transaction.authCapture() call.

confirmationCode: Set this to the code the carrier sent to your customer’s phone, or to true if Boku redirected the customer to your Success web page (returnUrl). If Boku redirected the customer to your Failure page, set this to false.


return: an object of type Return that indicates the success or failure of the call.

authStatus: Status of the underlying validation transaction. This also contains responses received from PayPal.

autobill: Resultant AutoBill object. CashBox populates this only if there is no error processing the call.