Disable, Activate and Update sub-clients

You can disable and activate sub-clients. Deposits sent to a disabled sub-client will no longer be booked against your balance.

Disabling a sub-client

JavaScript

const bodyJSON = {
  variables: {
    input: "606128f24bf29139b2cf74ef",
  },
  query: `
mutation ($input: ID!) {
  disableSubClient(id: $input) {
    success code message 
    subClient {
      id status
    }
  }
}`,
};

GraphQL Query

Variables

Response

Activating a sub-client

JavaScript

const bodyJSON = {
  variables: {
    input: "606128f24bf29139b2cf74ef",
  },
  query: `
mutation ($input: ID!) {
  activateSubClient(id: $input) {
    success code message 
    subClient {
      id status
    }
  }
}`,
};

GrraphQL Query

Variables

Response

Updating sub-clients

At this point, you can only update the externalId , address and postalAddress properties because each sub-client has a set of linked domestic and international Virtual Account Numbers to send and receive funds.

Please note, that the updated address will be re-verified, so make sure to include all its components, even if some fields, like the country, remain unchanged.

Updating sub-client externalId

JavaScript

const bodyJSON = { 
  variables: {
    id: "660fef8e1f3b5452bd6945ec",
    input: {
      externalId: "my_system_id_29f-ae0978b00d09e",
    },
  }, 
  query: `
mutation ($id: ID!, $input: UpdateSubClientInput!) {
  updateSubClient(id: $id, input: $input) {
    success code message
    subClient {
      id status externalId
    }
  }
}`,
};

GraphQL Query

Variables

Response

Updating sub-client address

JavaScript

const bodyJSON = { 
  variables: {
    id: "660fef8e1f3b5452bd6945ec",
    input: {
     "street": "456 New St",
     "suburb": "Newtow",
     "state": "VIC",
     "postcode": "3220", 
     "country": "AU",
    },
  }, 
  query: `
mutation ($id: ID!, $input: UpdateSubClientInput!) {
  updateSubClient(id: $id, input: $input) {
    success code message
    subClient {
      id status externalId address {building street suburb state postcode country}
    }
  }
}`,
};

GraphQL Query

Variables

Response