telecoms.cart.checkout function

Home > misc-functions > func.telecoms.cart.checkout

function telecoms.cart.checkout

See also:

telecoms.cart functions
additional arguments for suppliers using a master account

Standard Arguments

arg	required?	syntax	info
`cartID`	Y	posint	the `cartID` of the cart instance; see `telecoms.cart.list` to get a list of all cartIDs
`pay_method`	Y	enum:interactive\|stored_card\|after_invoice	the method to use to pay for the items in the cart

Additional Arguments if pay_method is "after_invoice"

arg	required?	syntax	info
`paymentcardID`	Y	posint	the `paymentcardID` of a previously stored payment card; see `paymentcard.list` to get a list of all paymentcardIDs

Additional Arguments if pay_method is "stored_card"

No additiional arguments necessary.

Return Values

This function returns the updated cart and also indicates any failures. The returned structure is the same as for telecoms.cart.create.

Additional Arguments for suppliers using a master account

arg	required?	syntax	info
`supplier_custID`	see description	posint	Supply the master account custID if you're using one of our master API accounts, otherwise don't supply this argument. Requires one of billcomp, billcompID.
`custID`	see description	posint	custID of the customer who is to own the shopping cart (leave blank to use your own account)