POST/transactions/find-bank-details

Find Bank Details

Finds bank details using country name and bank branch code.

Headers

Field	Type	Required	Possible values	Description
`session-token`	string	Required	—	SessionToken obtained from the Create GMA Session endpoint. All secured endpoints require this header.

Request body

Field	Type	Required	Possible values	Description
`countryName`	string	Required	—	Country name to search banks in.
`bankBranchCode`	string	Required	—	Bank branch code or routing code.

Example request

{
  "countryName": "CANADA",
  "bankBranchCode": "000300001"
}

{
  "countryName": "CANADA",
  "bankBranchCode": "000300001"
}

Response

Field	Type	Possible values	Description
`ResponseCode`	integer	200 \| 201 \| 204 \| 301 \| 400 \| 401 \| 403 \| 404 \| 410 \| 422 \| 500 \| 503	API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
`ResponseMessage`	string	Success \| Created \| NoContent \| BadRequest \| Unauthorized \| Forbidden \| NotFound \| Gone \| UnprocessableContent \| ServerError \| ResourceMoved \| ServiceUnAvailable \| UnProcessableEntity	Human-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
`ResponseData`	object	Please refer to below example for response body	Bank details matching the provided country and branch code.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "BankDirectory": {
      "recordKey": "BD00000038IQ",
      "officeType": "DB",
      "parentOfficeKey": "BD00000037HJ",
      "headOfficeKey": "BD00000037HJ",
      "legalType": "B",
      "legalParentKey": "BD00000037HJ",
      "groupType": "Member",
      "groupParentKey": "BD00000037HJ",
      "institutionStatus": "BANK",
      "bankCode": "ROYCCAT2XXX",
      "bankBranchCode": "000300001",
      "bankName": "ROYAL BANK OF CANADA",
      "bankBranchName": "MAIN BR - MONTREAL",
      "streetAddress1": "GROUND FLOOR",
      "streetAddress2": "1 PLACE VILLE MARIE",
      "city": "MONTREAL",
      "countryProvinceState": "QUEBEC",
      "zipCode": "H3C 3B5",
      "countryName": "CANADA",
      "countryCode": "CA",
      "nationalIdType": "CPA",
      "fedwireRoutingCode": "",
      "fedachRoutingCode": "",
      "parentFedwireRoutingCode": ""
    },
    "OfficeType": {
      "officeTypeCode": "DB",
      "officeTypeDescription": "Domestic Branch or department"
    },
    "LegalType": {
      "legalTypeCode": "B",
      "legalTypeDescription": "Business Entity"
    },
    "InstitutionStatus": {
      "instStatusCode": "BANK",
      "instStatusDesc": "Universal Bank"
    }
  }
}

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "BankDirectory": {
      "recordKey": "BD00000038IQ",
      "officeType": "DB",
      "parentOfficeKey": "BD00000037HJ",
      "headOfficeKey": "BD00000037HJ",
      "legalType": "B",
      "legalParentKey": "BD00000037HJ",
      "groupType": "Member",
      "groupParentKey": "BD00000037HJ",
      "institutionStatus": "BANK",
      "bankCode": "ROYCCAT2XXX",
      "bankBranchCode": "000300001",
      "bankName": "ROYAL BANK OF CANADA",
      "bankBranchName": "MAIN BR - MONTREAL",
      "streetAddress1": "GROUND FLOOR",
      "streetAddress2": "1 PLACE VILLE MARIE",
      "city": "MONTREAL",
      "countryProvinceState": "QUEBEC",
      "zipCode": "H3C 3B5",
      "countryName": "CANADA",
      "countryCode": "CA",
      "nationalIdType": "CPA",
      "fedwireRoutingCode": "",
      "fedachRoutingCode": "",
      "parentFedwireRoutingCode": ""
    },
    "OfficeType": {
      "officeTypeCode": "DB",
      "officeTypeDescription": "Domestic Branch or department"
    },
    "LegalType": {
      "legalTypeCode": "B",
      "legalTypeDescription": "Business Entity"
    },
    "InstitutionStatus": {
      "instStatusCode": "BANK",
      "instStatusDesc": "Universal Bank"
    }
  }
}

Requires `session-token: {SessionToken}` from Create GMA Session. Use the same client IP as authentication.