Update Buyer

Overview

You can update a Buyer by modifying its existing information or adding information for an optional field by using the PUT method, as described below.

Resource Access

PUT https://<hostname>/buyer/v1/buyer/<buyerId>

Arguments

Field	Sub Field	Mandatory/Optional
name		Mandatory
address	street1 street2 city state country postalCode	Optional
creditLimit		Optional
yearlyEstimatedSpent		Optional
status		Optional
externalStatus		Optional
contacts	id primary name title email phone	Optional
associatedInstitutionName		Optional
associatedInstitutionId		Mandatory
bid		Mandatory
mri		Optional
	clientId	Optional
	database	Optional
	username	Optional
	password	Optional
virtualCardRequested		Optional
virtualCardEnabled		Optional
virtualCard		Optional
	bankAccountId	Optional
	billing	Optional
	debitMethod	Optional
	debitProcessor	Optional
	delayDays	Optional
	exposureTracking enabled days limit	Optional
achRequested		Optional
achEnabled		Optional
ach		Optional
	bankAccountId	Optional
	billing	Optional
	delayDays	Optional
	debitMethod	Optional
	debitProcessor	Optional
	exposureTracking enabled days limit	Optional
checkEnabled		Optional
checkIssuing		Optional
	bankAccountId	Optional
	debitMethod	Optional
	debitProcessor	Optional
	delayDays	Optional
	billing	Optional
	exposureTracking enabled days Limit	Optional
managedCheck	bankAccountId	Optional
	billing	Optional
	debitMethod	Optional
	debitProcessor	Optional
	delayDays	Optional
	exposureTracking enabled days limit	Optional
managedCheckRequested		Optional
managedCheckEnabled		Optional
checkIssuingRequested		Optional
checkIssuingEnabled		Optional
customRemittanceEnabled		Optional
checkInsertsEnabled		Optional
invoiceUploadEnabled		Optional
wireRequested		Optional
wireEnabled		Optional
wire		Optional
	walletId	Optional
	billing	Optional
	debitProcessor	Optional
	debitMethod	Optional
	exposureTracking enabled days limit lastUpdatedDate currentExposureAmount	Optional
pifApproval		Optional
pifApprovalConfig		Optional
	level	Optional
	DEFAULT/ACH/ CARD/ CHECK Approvers firstLevel Id firstName lastName Email Username role Id Name secondLevel Id firstName lastName Email Username role Id Name Threshold firstLevel secondLevel requireAllLevelApproval	Optional
	paymentMethodLevelApproval	Optional
paymentFileType		Optional
achPaymentRoute		Optional
schedulePaymentsForFuture		Optional
dualPifApproval	enabled	Optional
failOverPayment	enabled	Optional
	VCN	Optional
bankAccounts	accountNumber	Optional
	routingNumber	Optional
	defaults VCN ACH CHK MCK	Optional
	accountType
nachaId		Optional
achMerchantId		Optional
achConfig		Optional
	metadata description field Text addenda Mapping Field order text	Optional
buyerWalletEnabled		Optional
vcnHost		Optional
vcnHostConfig		Optional
	falcons paymentReferenceNumber location products VCN VWA LDG PPD	Optional
	united primaryAccountNumber companyNumber	Optional
	braves primaryAccountNumber companyNumber centralBillAccountNumber	Optional
	Vpa pp enabled rva enabled visaBuyerId templateId fundingInfo fundingAccount creditLimit expirationDate	Optional
cardRules		Optional
	host	Optional
	ruleType	Optional
	type	Optional
	name	Optional
	expirationDays	Optional
	ruleValue	Optional
	isExactAmount	Optional
	isDefault	Optional
	billLevel	Optional
	reOrderCount	Optional
	initialOrderCount	Optional
	minAvailableAccounts	Optional
lodgePaymentEnabled		Optional
lodgePaymentCards		Optional
	id	Optional
legalName		Optional
isAlternateMailingAddress		Optional
mailingAddress		Optional
	street1	Optional
	street2	Optional
	city	Optional
	state	Optional
	country	Optional
	postalCode	Optional
website		Optional
yearsInBusiness		Optional
annualSales		Optional
ownershipType		Optional
legalEntityType		Optional
ssnEinType		Optional
taxId		Optional
stateOfOrganization		Optional
sic		Optional
	code	Optional
	description	Optional
owners		Optional
	owner firstName lastName title ownershipPercentage isControlProng emailAddress phone isUSCitizen dateOfBirth address street1 street2 City State country postalCode ssn	Optional
plastiqPayEnabled		Optional
backupCardRetrialEnabled		Optional

Example Request

🚧
PUT https://<hostname>/buyer/v1/buyer/59bd5703-92fb-55f0-9d9c-6b56991dbda0
Host: <hostname>
Authorization: Bearer <JWT token>
Content-Type: application/json


{
    "name": "test api 2",
   "address": {
       "street1": "test addresss",
       "city": "test city",
       "state": "AL",
       "country": "USA",
       "postalCode": "10001"
   },
   "creditLimit": 1000,
   "yearlyEstimatedSpend": "100000",
   "status": "Approved",
   "externalStatus": "Active",
   "contacts": [
       {
           "primary": true,
           "name": "tom",
           "title": "CFO",
           "email": "[email protected]",
           "phone": "1234124123"
       }
   ],
   "associatedInstitutionName": "John Test API Institution Updated",
    "associatedInstitutionId": "0df2d073-64d5-58e2-96ee-4770201facb7",
    "bid": "SAMPLEID1234890213",
    "mri": {
     "clientId": "987654321abcdABCD1234567890xyz",
     "database": "aeiouxyzmno1234567890987654321",
     "username": "markZuckerberg1234",
     "password": "zuckerbery#mark0004"
       },
   "virtualCardEnabled": false,
   "virtualCardRequested": true,
   "virtualCard": {
       "billing": "GOOD_FUNDS",
       "bankAccountId": "13a539a1579e64b4bff891a5537ad576ba5752f498f64ba799c2093a00fbbeb7",
       "debitMethod": "Debit by Batch",
       "delayDays": 0,
       "debitProcessor" : "CPX", 
       "exposureTracking": {
           "enabled": true,
           "limit": 1000000,
           "days": 90
       }
   },
   "achEnabled": false,
   "achRequested": true,
 "wireEnabled": true,
   "wireRequested": true,
   "buyerWalletEnabled": true,
   "ach": {
       "billing": "GOOD_FUNDS",
       "delayDays": 0,
       "debitMethod": "Debit by Batch",
       "debitProcessor" : "CPX", 
       "bankAccountId": "13a539a1579e64b4bff891a5537ad576ba5752f498f64ba799c2093a00fbbeb7",
       "exposureTracking": {
           "enabled": true,
           "days": 80,
           "limit": 900000
       }
   },
   "checkEnabled": true,
"managedCheck": {
        "billing": "GOOD_FUNDS",
        "delayDays": 1,
        "debitMethod": "Debit for Each Transaction",
        "bankAccountId": "3889d0a592afb41fdb90d9eb3cdd75755fd386e47580c71200c06db291bb964f",
        "debitProcessor": "PASSPORT"
    },

   "checkIssuing": {
             "billing": "GOOD_FUNDS",
        "delayDays": 1,
        "debitMethod": "Debit for Each Transaction",
        "bankAccountId": "3889d0a592afb41fdb90d9eb3cdd75755fd386e47580c71200c06db291bb964f",
        "debitProcessor": "PASSPORT",
        "exposureTracking": {
            "days": 90,
            "limit": 100000000,
            "enabled": true,
            "lastUpdatedDate": "2025-04-14T10:02:39.656Z",
            "currentExposureAmount": 201
        }
         },
"wire": {
        "billing": "GOOD_FUNDS",
        "walletId": " SAMPLEID1234890213@cpxwallet",
        "debitMethod": "Debit for Each Transaction",
        "debitProcessor": "PASSPORT"
    },

   "managedCheckEnabled": true,
   "managedCheckRequested" : true, 
   "isEnhancedManagedCheck": true,
   "checkIssuingRequested" : true, 
   "checkIssuingEnabled": true,
   "customRemittanceEnabled": true,
   "checkInsertsEnabled": true,
   "invoiceUploadEnabled": false,
   "pifApproval": true,
      "pifApprovalConfig": {
       "ACH": {
           "approvers": {
               "firstLevel": [
                   "6dae158a-8685-5593-9a95-ea52fe2527f4"
               ],
               "secondLevel": [
                   "5d655f8d-1835-5e78-904a-08a29a8c086d"
               ]
           },
           "threshold": {
               "firstLevel": 0,
               "secondLevel": 100
           },
           "requireAllLevelApproval": true
       },
       "CHECK": {
           "approvers": {
               "firstLevel": [
                   "6dae158a-8685-5593-9a95-ea52fe2527f4"
               ],
               "secondLevel": [
                   "5d655f8d-1835-5e78-904a-08a29a8c086d"
               ]
           },
           "threshold": {
               "firstLevel": 100,
               "secondLevel": 500
           },
           "requireAllLevelApproval": true
       },
       "level": "payment",
       "paymentMethodLevelApproval": true
   }


   "paymentFileType": "6d8b6759-dc12-5d92-8a4d-8328a64cb14c",
   "achPaymentRoute": "MX Merchant",
   "schedulePaymentsForFuture": true,
   "dualPifApproval": {
       "enabled": true
   },
   "bankAccounts": [
       {
           "accountNumber": "23471698364816398",
           "routingNumber": "121000248",
           "accountType": "savings"
       },
       {
           "accountNumber": "13471698364816398",
           "routingNumber": "121000248",
           "defaults": [
               "VCN",
               "ACH",
               "CHK"
           ],
           "accountType": "savings"
       }
   ],
   "nachaId": "1234567890",
   "achMerchantId": "0987654321",
   "vcnHost": "falcons",
   "lodgePaymentEnabled": true,
   "vcnHostConfig": {
       "falcons": {
           "products": {
               "VCN": {
                   "id": "fcf95529-b30f-505d-97e8-6be3245135db"
               },
               "LDG": {
                   "id": "eac130c1-6f5a-50e5-b98d-37c2efa557ba"
               }
           }
       },
       "braves": {
           "companyNumber": "99999",
           "primaryAccountNumber": "0779990099944155", 
     "centralBillAccountNumber" : "4567898765445678"

       }, 
  "vpa": {
            "pp": {
                "enabled": true
            },
            "visaBuyerId": "10079384"
        }
   },
   "cardRules": [
       {
           "host": "braves",
           "isDefault": true,
           "billLevel": "buyer",
           "ruleType": "Standard",
           "name": "Standard Card Rule",
           "expirationDays": "150",
           "ruleValue": "1234123412341234",
           "isExactAmount": true
       },
       {
           "host": "braves",
           "isDefault": true,
           "billLevel": "buyer",
           "ruleType": "Lodged",
           "type": "Lodged / Legacy",
           "name": "Lodged/Legacy",
           "expirationDays": "200",
           "ruleValue": "1234123412341235"
       },
       {
           "host": "braves",
           "isDefault": false,
           "billLevel": "buyer",
           "ruleType": "Lodged",
           "type": "Lodged / P-Card",
           "name": "Lodged/P-Card",
           "expirationDays": "300",
           "ruleValue": "1234123412341236"
       }, 
{ 
           "host": "braves",
           "isDefault": true,
           "billLevel": "buyer",
           "ruleType": "Lodged",
           "type" : "Lodged / Exact Match",
            "expirationDays": "1825",
           "ruleValue": "1234123412341234",
           "isExactAmount": true
       },
{
      "host": "falcons",
      "name": "BigFly Multi Use AP - 6648",
      "ruleType": "SingleUse",
      "billLevel": "buyer",
      "isDefault": true,
      "ruleValue": "6648",
      "isExactAmount": true
    }

   ],
   "lodgePaymentCards": [
       {
           "id": "generate"
       }
   ],

       "failOverPayment": {
       "VCN": "CHK",
       "enabled": true
   },
   //underwriting
   "legalName": "UI Buyer",
   "isAlternateMailingAddress": true,
   "mailingAddress": {
       "city": "NYC",
       "state": "AL",
       "country": "USA",
       "street1": "New mailing address",
       "street2": "s number",
       "postalCode": "10001"
   },
   "website": "www.abhi.com",
   "yearsInBusiness": 10,
   "annualSales": 1000000,
   "ownershipType": "Private",
   "legalEntityType": "Individual or Sole Proprietor",
   "ssnEinType": "SSN",
   "taxId": "389839289",
   "stateOfOrganization": "AK",
   "sic": {
       "code": "2791",
       "description": "TYPESETTING,PLATE MAKING, AND RELATED"
   },
   "owners": [
       {
           "id": "13a47d92-9c3c-4dca-9d7c-3bbb997fab4f",
           "ssn": "839839890",
           "phone": "8989898989",
           "title": "Mr",
           "address": {
               "city": "SF",
               "state": "NY",
               "country": "USA",
               "street1": "house number",
               "street2": "1",
               "postalCode": "10003"
           },
           "lastName": "Gupta",
           "firstName": "John",
           "dateOfBirth": "1999-09-29T00:00:00.000Z",
           "isUSCitizen": true,
           "emailAddress": "[email protected]",
           "isControlProng": false,
           "ownershipPercentage": 100
       }
   ],
"plastiqPayEnabled" : true,
"achConfig": {
        "metadata": {
            "description": {
                "field": "buyer.name"
            },
            "addenda": {
                "mapping": [
                    {
                        "field": "buyer.name",
                        "order": 1
                    },
                    {
                        "field": "supplier.name",
                        "order": 2
                    },
                    {
                        "field": "reference4",
                        "order": 3
                    },
                    {
                        "field": "reference2",
                        "order": 4
                    }
                ]
            }
        }
    }

     
}

Example Response

👍
204 No Content