Retrieve list of Institution buyer relationships
Overview
This route will search for institution/buyer relationship based on the given search criteria.
Resource Access
GET https://<hostname>/institution/v1/institution/relationship
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 |
Example Request
GET https://<hostname>/institution/v1/institution/relationship?institutionId=0df2d073-64d5-58e2-96ee-4770201facb7&buyerId=1173d692-65e8-51cc-934f-9a710b3c5d94&from=0&size=2&fields=name
Example Response
{
"totalRecords": 49,
"totalType": "exact",
"recordCount": 1,
"records": [
{
"id": "f6591a6a-4b91-5f7d-8ad6-1423b86eea9d",
"ach": {
"billing": "",
"bankAccountId": ""
},
"acl": [
"pps:cpx-acquiring",
"buyer:f6591a6a-4b91-5f7d-8ad6-1423b86eea9d",
"institution:0df2d073-64d5-58e2-96ee-4770201facb7",
"network:45cf4f64-e4f2-5a7e-9344-fbd400d77133"
],
"bid": "234567890",
"name": "random",
"status": "Approved",
"address": {
"city": "test",
"state": "NY",
"country": "USA",
"street1": "testing",
"postalCode": "10001"
},
"created": "2023-12-06T12:06:49.584Z",
"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
},
"deleted": false,
"plastiq": {
"payerId": "9500b963-a80b-42e0-afb3-549e46bb273c",
"syncError": null
},
"vcnHost": "braves",
"website": "",
"modified": "2024-02-22T08:28:20.657Z",
"modifier": {
"id": "50335456-0300-45cc-b01c-37c5f20f69b2",
"username": "system"
},
"passport": {
"account": {
"da": {
"id": 4012022
}
},
"addressId": 4016959,
"syncError": null,
"customerId": 4023463,
"bankAccounts": {
"04e7d9ab36ce6ceeebf54a8afd6ddfa53a4d7f163cf27a62db028b3baede53cc": {
"id": 4011466,
"addressId": 4016960
},
"90c0c70aaf94ef551a57adc72c1985cdce0a5b91004c4c0e2039e444d9f829de": {
"id": 4011467
}
},
"externalAccount": {
"check": {
"id": 4011466,
"addressId": 4016960
}
}
},
"legalName": "",
"ssnEinType": "EIN",
"pifApproval": false,
"virtualCard": {
"billing": "",
"bankAccountId": ""
},
"bankAccounts": [
{
"id": "04e7d9ab36ce6ceeebf54a8afd6ddfa53a4d7f163cf27a62db028b3baede53cc",
"bankName": "BANK OF AMERICA N.A.",
"defaults": [
"CHK",
"MCK"
],
"accountType": "savings",
"accountNumber": {
"hash": "a9gMp3pqRGYafrJg0WUZrQ651SvyVytaUL3xcORSrkM=",
"mask": "8922"
},
"routingNumber": {
"hash": "3czWjzpIs2a+w9K9MWHWA0a3NbFEH6lOo/Fde1s4mtc=",
"mask": "9593"
}
},
{
"id": "90c0c70aaf94ef551a57adc72c1985cdce0a5b91004c4c0e2039e444d9f829de",
"bankName": "WELLS FARGO BANK",
"accountType": "savings",
"accountNumber": {
"hash": "EzcbIMSusOa16kB+b/tV2qbV8sDQvEEBh/SR8mh6cUA=",
"mask": "2580"
},
"routingNumber": {
"hash": "KITqWxyqekp6RFm3ewMaOB6HlN7kWLIhJyCJme4+mlI=",
"mask": "1561"
}
}
],
"checkIssuing": {
"bankAccountId": "04e7d9ab36ce6ceeebf54a8afd6ddfa53a4d7f163cf27a62db028b3baede53cc"
},
"managedCheck": {
"bankAccountId": "04e7d9ab36ce6ceeebf54a8afd6ddfa53a4d7f163cf27a62db028b3baede53cc"
},
"checkAccounts": [
{
"id": "04e7d9ab36ce6ceeebf54a8afd6ddfa53a4d7f163cf27a62db028b3baede53cc",
"address": {
"city": "testing",
"state": "NY",
"street1": "testing",
"postalCode": "10001"
},
"bankName": "BANK OF AMERICA N.A.",
"accountId": "201543",
"syncError": "",
"accountType": "savings",
"checkProofId": "20",
"accountNumber": {
"hash": "a9gMp3pqRGYafrJg0WUZrQ651SvyVytaUL3xcORSrkM=",
"mask": "8922"
},
"accountStatus": "CHECK_PROOF_APPROVED",
"routingNumber": {
"hash": "3czWjzpIs2a+w9K9MWHWA0a3NbFEH6lOo/Fde1s4mtc=",
"mask": "9593"
},
"checkNextNumber": 234567890,
"checkStartNumber": 234567890,
"signatureAttachmentId": "1362867b-f6a7-54b0-b3f0-4d20c24f46c1"
},
{
"id": "90c0c70aaf94ef551a57adc72c1985cdce0a5b91004c4c0e2039e444d9f829de",
"address": {
"city": "testing",
"state": "NY",
"street1": "testing",
"postalCode": "10001"
},
"bankName": "WELLS FARGO BANK",
"accountId": "201545",
"syncError": "Internal Server Error",
"accountType": "savings",
"accountNumber": {
"hash": "EzcbIMSusOa16kB+b/tV2qbV8sDQvEEBh/SR8mh6cUA=",
"mask": "2580"
},
"accountStatus": "VERIFICATION_STARTED",
"routingNumber": {
"hash": "KITqWxyqekp6RFm3ewMaOB6HlN7kWLIhJyCJme4+mlI=",
"mask": "1561"
},
"checkNextNumber": 2000,
"checkStartNumber": 2000,
"isPassportAccount": true,
"signatureAttachmentId": "6158b7f5-61a4-5c61-be8b-95a224b748fe"
}
],
"ownershipType": "",
"vcnHostConfig": {
"braves": {
"companyNumber": "99999"
},
"vpa": {
"pp": {
"default": true
},
"rva": {
"default": false
},
"clientId": "B2BWS_4_9_4477"
}
},
"externalStatus": "Active",
"checkIssuingEnabled": true,
"checkIssuingRequested" : true,
"managedCheckEnabled": true,
"managedCheckRequested" : true,
"achPaymentRoute": "MX Merchant",
"dualPifApproval": {
"enabled": false
},
"failOverPayment": {
"enabled": false
},
"legalEntityType": "",
"paymentFileType": "2722c59e-810b-5add-921e-f90bbe2ea97b",
"checkEnabled": true,
"stateOfOrganization": "",
"invoiceUploadEnabled": false,
"isEnhancedManagedCheck": true,
"associatedInstitutionId": "0df2d073-64d5-58e2-96ee-4770201facb7",
"associatedInstitutionName": "John Institution Single and lodge",
"isAlternateMailingAddress": false
}
]
}
HTTP Status: 200 OK
Updated 3 days ago