Retrieve Institution by Id

Overview

You can retrieve information for a specific institution by using the GET method, as described below.

Resource Access

GET https://<hostname>/institution/v1/institution/<id>

Parameters

The requested criteria can be a combination of one or more of the following fields:

Keys	Values
filter	%7B%7D
field	<field user wants to search>
size	10
sort	created%3Adesc

Example Request

🚧
GET https://<hostname>/institution/v1/institution/4064e191-f000-548d-82f4-5c835aad1bbe

Example Response


{
   "id": "4064e191-f000-548d-82f4-5c835aad1bbe",
   "acl": [
       "pps:cpx-acquiring",
       "institution:4064e191-f000-548d-82f4-5c835aad1bbe",
       "network:cebc25a1-186d-509f-bcde-63df16250fbc"
   ],
   "fid": "API1234Testin",
   "fees": {
       "bankAccountId": "dff99536070b262b6f8118e9e090107da562c28cfc6048c5edd8ca8fb2a47e89"
   },
   "name": "API Institution",
   "status": "Approved",
   "address": {
       "city": "NEW YORK CITY",
       "state": "NY",
       "country": "USA",
       "street1": "152, TESTWAY",
       "postalCode": "10001"
   },
     "created": "2023-12-18T06:25:30.070Z",
   "creator": {
       "id": "404b861c-74df-5e29-b70c-5e9c13c09984",
       "username": "john.smith"
   },
   "revenue": {
       "bankAccountId": "dff99536070b262b6f8118e9e090107da562c28cfc6048c5edd8ca8fb2a47e89"
   },
   "vcnHost": "falcons",
   "contacts": [
       {
           "id": "3202affb-852a-5141-b797-fcf027a67445",
           "name": "John smith",
           "email": "[email protected]",
           "phone": "9090909090",
           "title": "CEO",
           "primary": true
       }
   ],
   "modified": "2023-12-18T06:25:30.137Z",
   "modifier": {
       "id": "404b861c-74df-5e29-b70c-5e9c13c09984",
       "username": "john.smith"
   },
   "goodFunds": {
       "bankAccountId": "dff99536070b262b6f8118e9e090107da562c28cfc6048c5edd8ca8fb2a47e89"
   },
   "debitMethod": "Debit by Batch",
   "achDelayDays": 1,
   "bankAccounts": [
       {
           "id": "dff99536070b262b6f8118e9e090107da562c28cfc6048c5edd8ca8fb2a47e89",
           "defaults": [
               "GOODFUNDS",
               "FEES",
               "REVENUE"
           ],
           "accountType": "savings",
           "accountNumber": "****1234",
           "routingNumber": "****9593"
       }
   ],
   "staticReport": {
       "enabled": false,
       "externalLinks": [
           {
               "id": "b93ae5bc-c39b-5025-9f55-ef61bba7e44b",
               "label": "Labelforstatic"
           }
       ]
   },
   "vcnValidDays": 30,
   "checkSettings": {
       "apiKey": "****tch1",
       "clientId": "john.smith",
       "memoMapping": "reference1",
       "isManagedCheck": true,
       "memoMappingEnabled": true,
       "checkInsertsEnabled": true,
       "checkProcessorEnabled": true
   },
   "vcnHostConfig": {
       "falcons": {
           "vendor": "galileo",
           "location": "121367",
           "products": [
               {
                   "id": "004fcc0a-2a14-5478-92a2-b9aaa1340796",
                   "name": "Ambient Lodged Card - 2702",
                   "type": "LDG",
                   "value": "2702",
                   "default": true
               },
               {
                   "id": "5ffb18a7-d403-5fd0-b4f1-35a6db574138",
                   "name": "BigFly Multi Use AP - 6648",
                   "type": "VCN",
                   "value": "6648",
                   "default": true
               }
           ]
       }, 
        "vpa": {
            "pp": {
                "default": true
            },
            "rva": {
                "default": false
            },
            "clientId": "B2BWS_4_9_4477"
        }

   },
   "externalStatus": "Active",
   "paymentFileType": "d436715b-e8eb-5c72-ba55-96950eee3dfc",
   "paymentFileTypes": [
       {
           "id": "HARRIS_HLG",
           "name": "HARRIS_HLG"
       }
   ],
   "suppressSIPEmail": true,
   "associatedBrandId": "851ba931-f6aa-5f57-b009-4006ffe1cb7c",
   "suppressStatement": true,
   "associatedBrandName": "Z American Securities",
   "associatedNetworkId": "cebc25a1-186d-509f-bcde-63df16250fbc",
   "externalUnderwriting": true,
   "invoiceUploadEnabled": true,
   "associatedNetworkName": "API Testing network",
   "includeVcnInDisposition": true,
   "automaticVcnCardCreation": true,
   "schedulePaymentsForFuture": true,
   "automaticIdentityVerification": true,
   "buyerWalletEnabled" : true,
   "generateScheduledUserReportActive": true,
   "alertApi": {
       "password": "****"
   },
"cpa": {
        "id": "22d09e18-72ca-52a0-bc18-522d21c13269",
        "syncError": null
    },

   "flagsEnable": [
       "buyer_settings_v2",
       "institution_settings_v2",
       "dxc_realtime_auth",
       "dxc_realtime_auth",
       "pif_approval"
   ]
}