Retrieve Buyer by Id
Overview
You can retrieve information for a specific buyer by using the GET method, as described below.
Resource Access
GET https://<hostname>/buyer/v1/buyer/<buyerID>
Example Request
GET https://<hostname>/buyer/v1/buyer/59bd5703-92fb-55f0-9d9c-6b56991dbda0
Host: <hostname>
Authorization: Bearer <JWT token>
Content-Type: application/json
Example Response
{
"id": "81040e85-7a3b-5c06-945f-6984d384c8bd",
"ach": {
"billing": "GOOD_FUNDS",
"delayDays": 0,
"debitMethod": "Debit by Batch",
"bankAccountId": "e973977c49e16e3bfecaef43e4558682c0a0f5ef5049151f2a278d1839d7ebfd",
"exposureTracking": {
"days": 80,
"limit": 900000,
"enabled": true,
"lastUpdatedDate": "2024-01-12T04:00:33.317Z",
"currentExposureAmount": 0
}
},
"acl": [
"pps:cpx-acquiring",
"buyer:81040e85-7a3b-5c06-945f-6984d384c8bd",
"institution:0df2d073-64d5-58e2-96ee-4770201facb7",
"network:45cf4f64-e4f2-5a7e-9344-fbd400d77133"
],
"bid": "SAMPLEID1234890213",
"sic": {
"code": "2791",
"description": "TYPESETTING,PLATE MAKING, AND RELATED"
},
"name": "John Smith",
"taxId": "****9289",
"owners": [
{
"id": "13a47d92-9c3c-4dca-9d7c-3bbb997fab4f",
"ssn": "****9890",
"phone": "8989898989",
"title": "Mr",
"address": {
"city": "SF",
"state": "NY",
"country": "USA",
"street1": "house number",
"street2": "1",
"postalCode": "10003"
},
"lastName": "Hall",
"firstName": "Kris",
"dateOfBirth": "1999-09-29T00:00:00.000Z",
"isUSCitizen": true,
"emailAddress": "[email protected]",
"isControlProng": false,
"ownershipPercentage": 100
}
],
"status": "Approved",
"address": {
"city": "test city",
"state": "AL",
"country": "USA",
"street1": "111 Street",
"postalCode": "10003"
},
"created": "2024-01-10T05:47:00.571Z",
"creator": {
"id": "e24bda88-d9ed-5730-a311-05488b7d65ed",
"username": "john.doe+critical"
},
"deleted": false,
"nachaId": "1234567891",
"vcnHost": "braves",
"website": "www.johncompany.com",
"contacts": [
{
"id": "4eccefa5-074f-5cbb-b84d-fb59e6fbf6c3",
"name": "Smith",
"email": "[email protected]",
"phone": "1234124123",
"title": "CFO"
},
{
"id": "a89cd837-1ba8-5997-84a1-d9188d6a1304",
"name": "tom",
"email": "[email protected]",
"phone": "1234124123",
"title": "CFO",
"primary": true
}
],
"modified": "2024-01-12T10:00:11.543Z",
"modifier": {
"id": "50335456-0300-45cc-b01c-37c5f20f69b2",
"username": "system"
},
"passport": {
"account": {
"da": {
"id": 4012365
}
},
"addressId": 4017397,
"syncError": null,
"customerId": 4023894,
"bankAccounts": {
"2a602b9dcc411854b6f0117efe2325495fd4408fa128cd7696130afda1f57329": {
"id": 4011994
},
"e973977c49e16e3bfecaef43e4558682c0a0f5ef5049151f2a278d1839d7ebfd": {
"id": 4011927,
"addressId": 4017492
}
},
"externalAccount": {
"check": {
"id": 4011927,
"addressId": 4017492
}
}
},
"cardRules": [
{
"id": "9e83b2ce-c6c6-5836-bc23-77e1e2b9f558",
"host": "braves",
"name": "Standard Card Rule",
"ruleType": "Standard",
"billLevel": "buyer",
"isDefault": true,
"ruleValue": "1234123412341234",
"isExactAmount": true,
"expirationDays": "150"
},
{
"id": "edd2effc-3572-5ba6-b10c-9d37184e61d3",
"host": "braves",
"name": "Lodged/Legacy",
"type": "Lodged/Legacy",
"ruleType": "Lodged",
"billLevel": "buyer",
"isDefault": true,
"ruleValue": "1234123412341235",
"expirationDays": "200"
},
{
"id": "99cadbe0-066f-5c69-bbe6-dbfd0756ab6e",
"host": "braves",
"name": "Lodged/P-Card",
"type": "Lodged/P-Card",
"ruleType": "Lodged",
"billLevel": "buyer",
"isDefault": false,
"ruleValue": "1234123412341236",
"expirationDays": "300"
}
],
"legalName": "JohnSmith",
"achEnabled": true,
"ssnEinType": "SSN",
"annualSales": 1000000,
"creditLimit": 2000,
"lodgePCards": [
{
"id": "1266900d450e06e8a8c7a2e9215c9208e6313ec0caf16987a9",
"cvv": "147",
"type": "visa",
"source": "braves",
"disabled": true,
"supplier": {
"id": "9c282a62-c1c0-5e9e-a8e0-ee9baa228eb6",
"name": "CPX2188SettlementsTestSupplier",
"sid": "CPX2188SettlementsTestSupplierSID"
},
"template": {
"id": "b951bf7b-ac8a-5e19-b575-794b329f0998",
"host": "braves",
"name": "Lodged/P-Card",
"type": "Lodged/P-Card",
"ruleType": "Lodged",
"billLevel": "buyer",
"isDefault": false,
"ruleValue": "0955633999944155",
"expirationDays": "120"
},
"reference": "2023021704324503052176",
"cardNumber": "4485500007695146",
"creditLimit": 12.08,
"cardEntityId":"a41e0a51450e06e8a8c7a2e9215c9208e6313ec0caf16987a9",
"expirationDate": "2023-06-17T00:00:00.000Z",
"expirationString": "0623",
"createdNotificationSent": "2023-02-17T04:32:49.302Z",
"payments": 1
}
],
"wireEnabled": true,
"wireRequested": true,
"buyerWalletEnabled": true,
"pifApproval": true,
"pifApprovalConfig": {
"level": "pif",
"DEFAULT": {
"approvers": {
"firstLevel": [
{
"id": "6dae158a-8685-5593-9a95-ea52fe2527f4",
"username": "john.doe+001",
"role": {
"id": "106",
"name": "Institution Administrator"
},
"firstName": "Abhi",
"lastName": "Gupta001",
"email": "[email protected]"
}
],
"secondLevel": [
{
"id": "5d655f8d-1835-5e78-904a-08a29a8c086d",
"username": "john.doe+IA",
"role": {
"id": "106",
"name": "Institution Administrator"
},
"firstName": "john",
"lastName": "doe",
"email": "[email protected]"
}
]
},
"threshold": {
"firstLevel": 10,
"secondLevel": 100
},
"requireAllLevelApproval": true
},
"paymentMethodLevelApproval": false
},
"virtualCard": {
"billing": "GOOD_FUNDS",
"delayDays": 0,
"debitMethod": "Debit by Batch",
"bankAccountId": "e973977c49e16e3bfecaef43e4558682c0a0f5ef5049151f2a278d1839d7ebfd",
"exposureTracking": {
"days": 90,
"limit": 1000000,
"enabled": true,
"lastUpdatedDate": "2024-01-12T04:00:45.302Z",
"currentExposureAmount": 0
}
},
"achRequested": true,
"bankAccounts": [
{
"id": "2a602b9dcc411854b6f0117efe2325495fd4408fa128cd7696130afda1f57329",
"bankName": "WELLS FARGO BANK, NA",
"accountType": "savings",
"accountNumber": "****7777",
"routingNumber": "****0248"
},
{
"id": "e973977c49e16e3bfecaef43e4558682c0a0f5ef5049151f2a278d1839d7ebfd",
"bankName": "WELLS FARGO BANK, NA",
"defaults": [
"VCN",
"ACH"
],
"accountType": "savings",
"accountNumber": "****6398",
"routingNumber": "****0248"
}
],
"checkIssuing": {
"bankAccountId": "e973977c49e16e3bfecaef43e4558682c0a0f5ef5049151f2a278d1839d7ebfd"
},
"managedCheck": {
"billing": "GOOD_FUNDS",
"debitMethod": "Debit for Each Transaction",
"bankAccountId": "4c8568730e024b298bf9513e67d35eb298ccc31cb5f9c699d7e00a3dfdfec3ef"
},
"achMerchantId": "0987654322",
"checkAccounts": [
{
"id": "c23559925785ab610a41102fb33a61cd2bb3f55894eb01efc2cf199a399b79d9",
"address": {
"city": "NYC",
"state": "AL",
"street1": "Test address",
"postalCode": "10100"
},
"bankName": "WELLS FARGO BANK",
"accountId": "215676",
"syncError": "",
"accountType": "savings",
"accountNumber": "****2939",
"accountStatus": "VERIFICATION_STARTED",
"routingNumber": "****1561",
"checkNextNumber": 2000,
"checkStartNumber": 2000,
"isPassportAccount": true,
"signatureAttachmentId": "e8d1712b-3b11-513f-b875-46d2631edeaa"
},
{
"id": "e973977c49e16e3bfecaef43e4558682c0a0f5ef5049151f2a278d1839d7ebfd",
"address": {
"city": "NYC",
"state": "AL",
"street1": "Test address",
"postalCode": "10100"
},
"bankName": "WELLS FARGO BANK, NA",
"accountId": "215675",
"syncError": "",
"accountType": "savings",
"checkProofId": "20",
"accountNumber": "****6398",
"accountStatus": "CHECK_PROOF_APPROVED",
"routingNumber": "****0248",
"checkNextNumber": 832823982,
"checkStartNumber": 832823982,
"signatureAttachmentId": "45f75e21-81a7-5521-ae02-d9cf50127517"
}
],
"ownershipType": "Private",
"vcnHostConfig": {
"braves": {
"companyNumber": "11009",
"primaryAccountNumber": "****4155"
},
"falcons": {
"products": {
"LDG": {
"id": "eac130c1-6f5a-50e5-b98d-37c2efa557ba",
"name": "IQ Backoffice Lodged Card - 4310",
"value": "4310"
},
"VCN": {
"id": "fcf95529-b30f-505d-97e8-6be3245135db",
"name": "PPS Multi Use - 6035",
"value": "6035"
}
},
"paymentReferenceNumber": "906126425204"
},
"vpa": {
"pp": {
"enabled": true
},
"visaBuyerId": "10079384"
}
},
},
"externalStatus": "Inactive",
“checkIssuingRequested” : true,
"checkIssuingEnabled": true,
“managedCheckRequested” : true,
"managedCheckEnabled": true,
"mailingAddress": {
"city": "NYC",
"state": "NY",
"country": "USA",
"street1": "New mailing address",
"street2": "s number",
"postalCode": "10001"
},
"achPaymentRoute": "MX Merchant",
"dualPifApproval": {
"enabled": true
},
"failOverPayment": {
"VCN": "ACH",
"enabled": true
},
"achConfig": {
"metadata": {
"addenda": {
"text": "TestAddenda"
},
"description": {
"field": "buyer.name"
}
}
},
"legalEntityType": "Individual or Sole Proprietor",
"paymentFileType": "6d8b6759-dc12-5d92-8a4d-8328a64cb14c",
"yearsInBusiness": 10,
"lodgePaymentCards": [
{
"id": "a297299dc9fa4a083bf526a6f76f1824582edd9de567d33e45",
"cvv": "****",
"type": "visa",
"source": "falcons",
"reference": "906126425204",
"cardNumber": "****8239",
"cardEntityId": "73cf4c3c9fa4a083bf526a6f76f1824582edd9de567d33e459",
"expirationDate": "2028-01-11T23:59:59.999Z",
"expirationString": "0128",
"payments": 0
}
],
"virtualCardEnabled": true,
"checkInsertsEnabled": true,
"checkEnabled": true,
"lodgePaymentEnabled": true,
"stateOfOrganization": "AK",
"invoiceUploadEnabled": true,
"virtualCardRequested": true,
"yearlyEstimatedSpend": "200000",
"pifApprovalFirstLevel": true,
"isEnhancedManagedCheck": true,
"associatedInstitutionId": "0df2d073-64d5-58e2-96ee-4770201facb7",
"customRemittanceEnabled": true,
"associatedInstitutionName": "John Institution Single and lodge",
"isAlternateMailingAddress": true,
"schedulePaymentsForFuture": true,
"associatedInstitutionPifApproval": true,
"associatedInstitutionManagedCheck": true,
"associatedInstitutionSchedulePaymentsForFuture": true,
"associatedInstitutionCheckInserts": true,
"associatedInstitutionInvoiceUpload": true,
"associatedInstitutionVcnHost": "braves",
"suppressStatement": true,
"lodgePCards": [],
"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
},
"flagsEnable": [
"buyer_settings_v2",
"institution_settings_v2",
"dxc_realtime_auth",
"dxc_realtime_auth",
"pif_approval"
]
}
Updated 3 days ago