Retrieve Supplier by Id

Overview

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

Resource Access

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

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>/payee/v1/payee/4f33d04c-b26a-5042-83ab-9b1230ad01cd

Example Response



{
   "id": "0431f507-acfd-58b9-a09e-dedf263ca31f",
   "acl": [
       "pps:cpx-acquiring",
       "supplier:0431f507-acfd-58b9-a09e-dedf263ca31f",
       "buyer:04bf895f-e97f-51c5-84bd-7a67406a97a6",
       "institution:0df2d073-64d5-58e2-96ee-4770201facb7",
       "network:45cf4f64-e4f2-5a7e-9344-fbd400d77133"
   ],
   "mcc": {
       "code": "1521",
       "description": "GENL CONTRACTORS-RESIDENTIAL,COMMERCIA"
   },
   "name": "ABC",
   "sids": [
       {
           "id": "fb536355-2297-5ec2-8b5e-f2a7fdaaebe7",
           "name": "SampleSID-123456902131031"
       }
   ],
   "status": "Approved",
   "address": {
       "city": "City",
       "state": "NY",
       "country": "USA",
       "street1": "Building",
       "street2": "Street",
       "postalCode": "10001"
   },
   "created": "2024-03-19T09:02:23.127Z",
   "creator": {
       "id": "e24bda88-d9ed-5730-a311-05488b7d65ed",
       "username": "john.doe+critical"
   },
"cpa": {
        "id": "b77258eb-3f16-5d9a-8819-94c4957776b3",
        "syncError": null
    },

   "deleted": false,
   "contacts": [
       {
           "id": "00cb4243-44b3-5646-989a-2d509f8a4587",
           "name": "Johnny Smith",
           "email": "[email protected]",
           "phone": "9234567654",
           "title": "CEO",
           "primary": true
       }
   ],
   "modified": "2024-08-26T11:27:24.186Z",
   "modifier": {
       "id": "404b861c-74df-5e29-b70c-5e9c13c09984",
       "username": "john.doe"
   },
   "variance": {
       "type": "%",
       "amount": "30"
   },
   "payeeType": "Supplier",
   "acceptsACH": true,
   "merchantId": "418375002",
   "acceptsCard": true,
"acceptsWire" : true,
   "acceptsCheck": true,
   "paymentTypes": [
       {
           "id": "ACH",
           "type": "ACH",
           "enabled": true,
           "accountType": "Savings",
           "routingNumber": "****0248",
           "bankAccountNumber": "****4567"
       },
       {
           "id": "ACH+",
           "type": "ACH+",
           "enabled": false,
           "feeType": "discountRate",
           "netFees": false,
           "accountType": "Savings",
           "discountRate": "10",
           "routingNumber": "****0248",
           "bankAccountNumber": "****4567"
       },
       {
           "id": "Check Issuing",
           "type": "Check Issuing",
           "address": {
               "city": "New York City",
               "state": "NY",
               "country": "USA",
               "street1": "123 Street",
               "postalCode": "10001"
           },
           "enabled": true,
           "payableTo": "John Smith"
       },{
    "id": "Wire",
    "type": "Wire",
    "phone": "3333333333",
    "address": {
        "city": "Amvala City",
        "state": "AL",
        "country": "USA",
        "street1": "Colony taran",
        "street2": "Airforce",
        "postalCode": "35013"
    },
    "enabled": true,
    "accountType": "Savings",
    "routingNumber": "121000248",
    "bankAccountNumber": "987654321495"
},
       {
           "id": "Direct",
           "type": "Direct",
           "enabled": false
       },
       {
           "id": "Dollar Splits",
           "type": "Dollar Splits",
           "enabled": true,
           "dollarSplits": [
               {
                   "id": "CHK",
                   "threshold": 0
               },
               {
                   "id": "VCN",
                   "threshold": 1000
               }
           ]
       },
       {
           "id": "Dynamic Discounting",
           "type": "Dynamic Discounting",
           "enabled": false,
           "netFees": false,
           "accountType": "Savings",
           "lowTermDays": 0,
           "discountRate": "0",
           "highTermDays": 0,
           "routingNumber": "****0248",
           "bankAccountNumber": "****4567"
       },
       {
           "id": "Payment Thresholds",
           "type": "Payment Thresholds",
           "enabled": false,
           "thresholds": [
               {
                   "id": "0004dd815e2-dc7a-42e0-95b0-a7eabe81f321",
                   "threshold": "0",
                   "paymentType": "V Card"
               },
               {
                   "id": "001bd8ecaa2-8a73-4014-9e48-53b595704836",
                   "threshold": "1000",
                   "paymentType": "ACH"
               }
           ]
       },
       {
           "id": "Prepaid Debit",
           "type": "Prepaid Debit",
           "enabled": false
       },
       {
           "id": "V Card",
           "fax": "1234567876",
           "type": "V Card",
           "emails": "[email protected]",
           "enabled": true,
           "requirePin": true,
           "proxyPayment": true,
           "deliveryMethod": "Email",
           "noNotification": false
       },
       {
           "id": "Virtual Wallet",
           "type": "Virtual Wallet",
           "enabled": false
       }
   ],
   "allowPinReset": true,
   "expirePreAuths": true,
   "externalStatus": "Active",
   "requiresLodged": false,
   "achRemittanceEmails": {
       "emails": "[email protected]",
       "enabled": true
   },
   "isSupplierEnablement": true,
   "checkRemittanceEmails": {
       "emails": "[email protected],[email protected]",
       "enabled": true
   },
   "hasPin": false
}