Institutions

CRUD queries for Institutions

Instructing Institution

Institution entity is a piece of information about the party who instructed you to make the withdrawal. This data is important for compliance within Australia. This is not the sender. If there is no other institution who has instructed this withdrawal, leave this blank and your own details will be used for compliance and auditing purposes.

Institution explanation

Creating institutions

• via Flash Connect (you can copy an ID of an existing Institution).

• via API by invoking createInstitution mutation.

• by providing instructingInstitution object into createWithdrawal mutation.

Please avoid creating multiple Institutions for the same organisation because they are used for compliance reporting and subject to review.

Before creating or updating an institution we will try to find an existing one by:

• By instructingInstitution.externalId

• By instructingInstitution.businessNumber AND instructingInstitution.address.country

• By instructingInstitution.legalName AND instructingInstitution.address.country

Creating institution example

JavaScript

const bodyJSON = {
  variables: {
    input: {
      legalName: "Intermediate Institution Ltd",
      website: "example.com",
      businessNumber: "A39477669937",
      address: {
        postcode: "2000",
        street: "203 Business Street",
        country: "AU",
        state: "NSW",
        suburb: "Sydney",
    },
  },
},
query: `
mutation ($input: InstitutionInput!) {
  createInstitution(input: $input) {
    success code message    
    institution {     
      id
    }  
  }
}`,
};

GraphQL Query

mutation($input: InstitutionInput!) {
  createInstitution(input: $input) {
    success
    code
    message
    institution {
      id
    }
  }
}

Variables

 "input": {
    "legalName": "Intermediate Institution Ltd",
    "website": "example.com",
    "businessNumber": "A39477669937",
    "address": {
      "postcode": "2000",
      "street": "203 Business Street",
      "country": "AU",
      "state": "NSW",
      "suburb": "Sydney"
    }
  }
}

Response

{
  "data": {
    "createInstitution": {
      "success": true,
      "code": "INSTITUTION_CREATED",
      "message": "Institution created",
      "institution": {
        "id": "65570da4f176682c5e412552",
        "website": "example.com"
      }
    }
  }
}

Updating institutions

You can update an existing institution by invoking the updateInstitution mutation with its id. The input always requires legalName and address; every other field is optional. Only the non-empty fields you send are applied — omitted or empty optional fields keep their current values (you can't blank out a field by sending an empty value), and the address you provide is merged over the stored one. If nothing actually changes, the update is a no-op and returns NO_CHANGES; the stored data and its compliance status are left untouched.

Before persisting a change, we check whether a different institution already exists with the same:

• externalId if present, or

• businessNumber AND address.country

• legalName AND address.country

If a match is found, the update is rejected with the INSTITUTION_ALREADY_EXISTS code.

Updating institution example

JavaScript

const bodyJSON = {
  variables: {
    id: "65570da4f176682c5e412552",
    input: {
      legalName: "Intermediate Institution Ltd",
      businessNumber: "A39477669937",
      address: {
        postcode: "2000",
        street: "203 Business Street",
        country: "AU",
        state: "NSW",
        suburb: "Sydney",
    },
  },
},
query: `
mutation ($id: ID, $input: InstitutionInput!) {
  updateInstitution(id: $id, input: $input) {
    success code message    
    institution {     
      id    
    }  
  }
}`,
};

GraphQL Query

mutation($id: ID, $input: InstitutionInput!) {
  updateInstitution(id: $id, input: $input) {
    success
    code
    message
    institution {
      id
    }
  }
}

Variables

{
  "id": "65570da4f176682c5e412552",
  "input": {
    "legalName": "Intermediate Institution Ltd",
    "businessNumber": "A39477669937",
    "address": {
      "postcode": "2000",
      "street": "203 Business Street",
      "country": "AU",
      "state": "NSW",
      "suburb": "Sydney"
    }
  }
}

Response

{
  "data": {
    "updateInstitution": {
      "success": true,
      "code": "UPDATED",
      "message": "Institution 65570da4f176682c5e412552 updated.",
      "institution": {
        "id": "65570da4f176682c5e412552"
      }
    }
  }
}