PaymentMethod Property

The intended payment method when using Canada Post.

Syntax

 canadapostship.getPaymentMethod([callback])
 canadapostship.setPaymentMethod( paymentMethod, [callback])

Possible Values

  0 (pmAccount), 
  1 (pmCreditCard)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getPaymentMethod([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setPaymentMethod([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This field is used to specify the intended method of payment when shipping via Canada Post.

The available values are:

Note: This value is only used when a CanadaPostContractId is specified.

Data Type

Integer