Skip to main content

Customer Payment Account Update

Customer payment account update. Accepts PaymentAccountProxy, CreditCardProxy, or BankAccount. Priority order: PaymentAccountProxy, BankAccount, CreditCardProxy. Preferred option is PaymentAccountProxy.

addtionalPaymentAccountProxies object[]

Additional PaymentAccountProxies. Proxy is generated using the Payments Plugin for bank account and card or /cardProxies API for card.

  • Array [
  • labelstring

    Label for the account.

    Max length: <= 80 characters

    proxystringrequired

    Card or bank account proxy. Proxy is generated using the Payments Plugin for bank account and card or /cardProxies api for card.

    Max length: <= 40 characters

  • ]
  • bankAccount object

    Customer bank account details. Provide valid BSB and Account Number.

    accountNamestringrequired

    Account Holder name.

    Constraints: <= 32 characters, Value must match regular expression [\u0020-\u007E]*

    accountNumberstringrequired

    Bank Account number.

    Format: Value must match regular expression ^([0-9]{4,10})

    bankBranchstring

    Bank branch.

    Max length: <= 50 characters

    bankNamestring

    Bank Name.

    Max length: <= 50 characters

    bsbstringrequired

    BSB Number. Format: 000000.

    Max length: <= 6 characters

    isPayToboolean

    Bank account is PayTo if true.

    labelstring

    Label for the account.

    Max length: <= 50 characters

    payToStatusinteger<int32>

    If PayTo account, this field will let you know the status of the Mandate.

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

    creditCardProxy object

    Customer credit / debit card proxy. Proxy is generated using the /cardProxies API or Payments Plugin.

    cardProxystringrequired

    Card proxy generated by the /cardproxies api.

    Max length: <= 40 characters

    labelstring

    Label for the card.

    Max length: <= 80 characters

    paymentAccountProxy object

    This replaces the BankAccount and CreditCardProxy. Proxy is generated using the Payments Plugin for bank account and card or /cardProxies API for card.

    labelstring

    Label for the account.

    Max length: <= 80 characters

    proxystringrequired

    Card or bank account proxy. Proxy is generated using the Payments Plugin for bank account and card or /cardProxies api for card.

    Max length: <= 40 characters

    Customer Payment Account Update
    {
    "addtionalPaymentAccountProxies": [
    {
    "label": "string",
    "proxy": "string"
    }
    ],
    "bankAccount": {
    "accountName": "string",
    "accountNumber": "string",
    "bankBranch": "string",
    "bankName": "string",
    "bsb": "string",
    "isPayTo": true,
    "label": "string",
    "payToStatus": 0
    },
    "creditCardProxy": {
    "cardProxy": "string",
    "label": "string"
    },
    "paymentAccountProxy": {
    "label": "string",
    "proxy": "string"
    }
    }