Retrieve list of Institution buyer relationships for Export
Overview
This route will search for institution/buyer relationship based on the given search criteria for export
Resource Access
GET https://<hostname>/institution/v1/institution/relationship/export
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 |
| institutionId | Institution for which relationships are to be searched |
| buyerId | Buyer for which relationships are to be searched |
| from | Defines the number of records to offset |
| search | Search query string value |
| scrollId | The id for the search context |
Example Request
GET https://<hostname>/institution/v1/institution/export?fields=name&fields=fid&fields=externalStatus&fields=status&fields=activeBuyers&fields=totalBuyers&fields=created&fields=id&filter=%7B%7D&from=0&networkId=0&page=1&search=all_falcons&size=10&sort=created%3Adesc
Example Response
{
"_scroll_id": "eyJhbGciOiJFUzI1NiJ9.eyJzY3JvbGxJZCI6IkZHbHVZMngxWkdWZlkyOXVkR1Y0ZEY5MWRXbGtEWEYxWlhKNVFXNWtSbVYwWTJnQkZqSjNURkpMY0VFeFUwSmxjRVoyUkZjNVMxcFBOR2NBQUFBQUFEWEh3eFptWjJnNVRTMTJUbFJvY1VSeFZuVm9kbGMwT0VwQiIsInRlbmFudElkIjoiNUQ0Q0QxRUEtNzI0Qi00NkFDLUE4NzgtMEIwNjhFMjM5RTAyIiwidmlydHVhbEVudiI6ImF3cy1udi1jcHhxYSIsInVzZXJJZCI6IjQwNGI4NjFjLTc0ZGYtNWUyOS1iNzBjLTVlOWMxM2MwOTk4NCJ9.hJ2PcJxJyNHqfYH9evIG20JD-8slNJwdggNwNSURIrw2nXoSbr4FQ7eujCvtPWwWceajgvCYqkg7nXbFTwaNsw",
"totalRecords": 13810,
"totalType": "exact",
"recordCount": 2,
"records": [
{
"id": "d13f6293-f65e-5629-91e3-27c8e6baeb6b",
"acl": [
"pps:cpx-acquiring",
"institution:d13f6293-f65e-5629-91e3-27c8e6baeb6b",
"network:ab6bc09e-5dde-5ec7-ba8f-2dbeea7c9d6a"
],
"fid": "sjkdksfksknknsrln",
"fees": {
"bankAccountId": "74f347bd980f3e9d52ca48bd3b9e0d46d0cbf381b6d7a9e3196d3303539153b2"
},
"name": "API insti all braves",
"status": "Approved",
"address": {
"city": "test city",
"state": "AL",
"country": "USA",
"street1": "test address",
"postalCode": "10001"
},
"created": "2024-06-24T09:46:26.441Z",
"creator": {
"id": "404b861c-74df-5e29-b70c-5e9c13c09984",
"username": "john.doe"
},
"cpa": {
"id": "8a304621-3b40-5809-9246-30873a9fb421",
"isActive": true,
"cardTypes": {
"5cf10e8c-c1e8-5f75-bdaf-fd23c173fc92": {
"id": "d8c8dc55-f4e6-5d47-95d6-00cd682fd6f5"
},
"c4ad8297-7d38-565e-888f-5da58f1010ce": {
"id": "a52d9fe1-bbd1-5946-a996-b9fd5c89edfc"
}
},
"syncError": null
},
"revenue": {
"bankAccountId": "74f347bd980f3e9d52ca48bd3b9e0d46d0cbf381b6d7a9e3196d3303539153b2"
},
"vcnHost": "braves",
"alertApi": {
"ach": {
"blocked": false,
"enabled": true,
"endpoint": "test.com",
"password": {
"hash": "05lVj9unoicV6Os/zJGCnzpnRF+LuLzPlFd+Kb6wkOU=",
"mask": "tch1"
},
"username": "john.doe"
},
"version": "2"
},
"contacts": [
{
"id": "fc824099-e9e7-59a2-9f0b-91c275f47610",
"name": "Abhi",
"email": "[email protected]",
"phone": "5678376748",
"title": "ceo",
"primary": true
}
],
"modified": "2024-06-24T10:13:46.059Z",
"modifier": {
"id": "404b861c-74df-5e29-b70c-5e9c13c09984",
"username": "john.doe"
},
"goodFunds": {
"bankAccountId": "74f347bd980f3e9d52ca48bd3b9e0d46d0cbf381b6d7a9e3196d3303539153b2"
},
"debitMethod": "Debit for Each Transaction",
"pifApproval": false,
"achDelayDays": 0,
"bankAccounts": [
{
"id": "74f347bd980f3e9d52ca48bd3b9e0d46d0cbf381b6d7a9e3196d3303539153b2",
"defaults": [
"GOODFUNDS",
"FEES",
"REVENUE"
],
"accountType": "checking",
"accountNumber": {
"hash": "0MBZhEtuWhi/Ih3r0A8RTDHGfuq6OtRDjt72qsaPNhs=",
"mask": "4999"
},
"routingNumber": {
"hash": "L45JEpx7mBOu8/OnLNpI1uWfJxwjky9bXicEnoFSnHE=",
"mask": "0248"
}
}
],
"staticReport": {
"enabled": true,
"externalLinks": [
{
"id": "3a8fa5fe-04fa-57df-bc91-c41096b7e654",
"label": "test",
"value": "www.google.com"
}
]
},
"vcnValidDays": 30,
"checkSettings": {
"apiKey": {
"hash": "05lVj9unoicV6Os/zJGCnzpnRF+LuLzPlFd+Kb6wkOU=",
"mask": "tch1"
},
"clientId": "john.doe",
"memoMapping": "reference1",
"managedCheckRequested" : true,
"managedCheckEnabled": true,
"memoMappingEnabled": true,
"checkInsertsEnabled": true,
"checkProcessorEnabled": false,
"expeditedShippingEnabled": true
},
"companyNumber": "99999",
"vcnHostConfig": {
"braves": {
"corpId": "NA",
"vendor": "hpdxc",
"billLevel": "buyer",
"clientOrg": "COMMERCIAL CARD NA",
"clientUserId": "U84NACPX",
"companyNumber": "99999"
},
"vpa": {
"pp": {
"default": true
},
"rva": {
"default": false
},
"clientId": "B2BWS_4_9_4477"
},
"falcons": {
"products": [
{
"type": "VCN",
"value": "6648",
"default": false,
"name": "BigFly Multi Use AP - 6648",
"isSingleUse": false,
"id": "1849dc89-4e92-53f1-92df-c20547fe3c94"
},
{
"type": "VCN",
"value": "2174",
"default": true,
"name": "ERP Single Auth VCN - 2174",
"isSingleUse": true,
"id": "7c64a04f-bd80-55ef-a1ee-bc59eeb9f34e"
},
{
"type": "LDG",
"value": "2702",
"default": true,
"name": "Ambient Lodged Card - 2702",
"isSingleUse": false,
"id": "0dcc95fe-856d-5fd5-ad10-128e57da0f4c"
},
{
"type": "LDG",
"value": "6320",
"name": "Aqua Science Virtual Lodged - 6320",
"isSingleUse": false,
"id": "ed89254e-f56c-5821-aab3-d5ac59875c25"
}
],
"location": "999999"
}
},
"externalStatus": "Active",
"paymentFileType": "1f94b478-8d14-54f2-bb07-a4662aad1d4f",
"suppressSIPEmail": true,
"associatedBrandId": "8bb86d07-84e7-5813-871a-d81554a9bf6b",
"plastiqPayEnabled": true,
"suppressStatement": true,
"associatedBrandName": "Z Postnet",
"associatedNetworkId": "ab6bc09e-5dde-5ec7-ba8f-2dbeea7c9d6a",
"externalUnderwriting": true,
"invoiceUploadEnabled": true,
"associatedNetworkName": "John Network",
"includeVcnInDisposition": true,
"schedulePaymentsForFuture": true,
"automaticIdentityVerification": true,
"generateScheduledUserReportActive": true,
"totalBuyers": 0,
"activeBuyers": 0
},
{
"id": "d396feac-0297-56df-88cf-84eb0df19088",
"acl": [
"pps:cpx-acquiring",
"institution:d396feac-0297-56df-88cf-84eb0df19088",
"network:a6bc62dd-3e38-5cf7-8d23-1cec5d199405"
],
"fid": "10781API53457",
"fees": {
"bankAccountId": "27160487a6ef38dbf4a8bf41b621c4b45f119a2fd38ca7eb99b92c2e9ec491a4"
},
"name": "Automation Institution Braves 42849",
"status": "Approved",
"address": {
"city": "tuscon",
"state": "AZ",
"country": "USA",
"street1": "A random Street",
"postalCode": "85207"
},
"created": "2024-06-21T10:06:20.691Z",
"creator": {
"id": "f9632bc5-379d-5c56-a392-d5ac5a23119c",
"username": "john.doe+admin"
},
"revenue": {
"bankAccountId": "27160487a6ef38dbf4a8bf41b621c4b45f119a2fd38ca7eb99b92c2e9ec491a4"
},
"vcnHost": "braves",
"modified": "2024-06-21T10:06:20.719Z",
"modifier": {
"id": "f9632bc5-379d-5c56-a392-d5ac5a23119c",
"username": "john.doe+admin"
},
"goodFunds": {
"bankAccountId": "27160487a6ef38dbf4a8bf41b621c4b45f119a2fd38ca7eb99b92c2e9ec491a4"
},
"debitMethod": "Manual",
"achDelayDays": 0,
"bankAccounts": [
{
"id": "27160487a6ef38dbf4a8bf41b621c4b45f119a2fd38ca7eb99b92c2e9ec491a4",
"defaults": [
"GOODFUNDS",
"FEES",
"REVENUE"
],
"accountType": "checking",
"accountNumber": {
"hash": "tzbQePpgI0H8bmwHHGheJn8iWpNPIGSY36ETp0UXQdY=",
"mask": "9232"
},
"routingNumber": {
"hash": "eg+BvXJDky5Jz2Jr8TnsL5ft/uxcDKJoZiKuPTbklhs=",
"mask": "0020"
}
}
],
"staticReport": {
"enabled": false
},
"vcnValidDays": 30,
"checkSettings": {
"memoMapping": "reference1",
"memoMappingEnabled": false,
"checkProcessorEnabled": false
},
"companyNumber": "50001",
"vcnHostConfig": {
"braves": {
"vendor": "hpdxc",
"billLevel": "buyer",
"clientOrg": "",
"clientUserId": "",
"companyNumber": "50001"
}
},
"externalStatus": "Active",
"suppressSIPEmail": false,
"associatedNetworkId": "a6bc62dd-3e38-5cf7-8d23-1cec5d199405",
"associatedNetworkName": "Automation Network 78271",
"automaticIdentityVerification": true,
"paymentFileType": "95a4997e-fa83-5aa6-937d-d7af5c4b3e96",
"totalBuyers": 1,
"activeBuyers": 1
}
]
}
Updated 3 days ago