Retrieve Buyer by Custom field

Overview

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

Resource Access

GET https://<hostname>/buyer/v1/buyer/<custom field>

Parameters

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

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

Example Request

🚧
GET https://<hostname>/buyer/v1/buyer

Example Response


{
   "totalRecords": 15277,
   "totalType": "exact",
   "recordCount": 1,
   "records": [
       {
           "ach": {
               "bankAccountId": "2b6c605d8ef07178f8d1509f90431f08877d8066ae955f7cd9163c5c025d0285"
           },
           "achPaymentRoute": "MX Merchant",
           "acl": [
               "pps:cpx-acquiring",
               "buyer:030b8cd9-aa4d-5f0f-9d90-fb8ddeed8a5a",
               "institution:483299bf-836b-5612-8b8a-83c5ee82e703",
               "network:6508254b-8a13-5fb9-aecb-6a7cafc29e87"
           ],
           "address": {
               "country": "USA"
           },
           "associatedInstitutionId": "483299bf-836b-5612-8b8a-83c5ee82e703",
           "associatedInstitutionName": "Automation Institution Braves 53133",
           "bankAccounts": [
               {
                   "accountNumber": {
                       "hash": "vyzC1Agp5vp++uViNxEt+l5ZuxsUX90Kb9eRwj1nX8g=",
                       "mask": "6063"
                   },
                   "accountType": "checking",
                   "bankName": "WELLS FARGO BANK, NA",
                   "defaults0": "VCN",
                   "id": "2b6c605d8ef07178f8d1509f90431f08877d8066ae955f7cd9163c5c025d0285",
                   "routingNumber": {
                       "hash": "L45JEpx7mBOu8/OnLNpI1uWfJxwjky9bXicEnoFSnHE=",
                       "mask": "0248"
                   }
               }
           ],
           "bid": "10781-68372",
           "created": "2022-10-17T09:54:16.470Z",
           "creator": {
               "id": "2a3ecae6-aade-59c2-8332-3d713902c841",
               "username": "john.doe+uat"
           },
           "deleted": false,
           "dualPifApproval": {
               "enabled": false
           },
           "externalStatus": "Active",
           "id": "030b8cd9-aa4d-5f0f-9d90-fb8ddeed8a5a",
           "modified": "2022-10-17T09:54:18.873Z",
           "modifier": {
               "id": "2a3ecae6-aade-59c2-8332-3d713902c841",
               "username": "john.doe+uat"
           },
           "name": "2nd_Buyer_VCN Braves 57120",
           "paymentFileType": "de9cf257-fea1-5cc7-a779-b58743d77588",
           "pifApproval": false,
           "status": "Approved",
           "vcnHost": "braves",
           "vcnHostConfig": {
               "braves": {
                   "companyNumber": "11009",
                   "primaryAccountNumber": {
                       "hash": "+yPRz25Utk+MhI8OA1XaB1Of7liqafk/uBMAygafcls=",
                       "mask": "4155"
                   }
               }
           },
           "virtualCard": {
               "bankAccountId": "2b6c605d8ef07178f8d1509f90431f08877d8066ae955f7cd9163c5c025d0285",
               "billing": "GOOD_FUNDS",
               "debitMethod": "Debit by Batch"
           },
           "virtualCardRequested": true,
           "cardRules": [
               {
                   "host": "braves",
                   "isDefault": true,
                   "billLevel": "buyer",
                   "ruleType": "Standard",
                   "name": "multi9853009",
                   "expirationDays": "30",
                   "ruleValue": "0832179299944155",
                   "isExactAmount": "false",
                   "id": "b3e427d1-dc77-51a6-bb4f-8013e890c0e0"
               }
           ],
           "managedCheckEnabled": false,
           "managedCheckRequested" : false,
           "lodgePaymentCards": [],
           "totalSuppliers": 1,
           "activeSuppliers": 1
       }
       
   ]
}