Update Supplier

Overview

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

Resource Access

PUT https://<hostname>/payee/v1/payee

Arguments

name	Mandatory
name	Mandatory
address	Optional
mcc	Optional
status	Optional
externalStatus	Optional
payeeType	Optional
contacts	Optional
addedRelationshipBuyerIds	Optional
isSupplierEnablement	Optional
acceptsCheck	Optional
acceptsWire	Optional
merchantId	Optional (Mandatory, if Direct payment method is activated for Virtual Card)
acceptsCard	Optional
acceptsACH	Optional
requiresLodged	Optional
variance	Optional
paymentTypes	Optional
achRemittanceEmails	Optional
checkRemittanceEmails	Optional
expirePreAuths	Optional

Example Request

🚧
POST https://<hostname>/payee/v1/payee
Host: <hostname>
Authorization: Bearer <JWT token>
Content-Type: application/json


{
   "name": "John Smith",
   "address": {
       "street1": "123 Building",
       "street2": "123 Street",
       "city": "New York City",
       "state": "NY",
       "country": "USA",
       "postalCode": "10001"
   },
   "mcc": {
       "code": "1520",
       "description": "GENL CONTRACTORS-RESIDENTIAL,COMMERCIA"
   },
  
   "status": "Received",
   "externalStatus": "Active",
   "payeeType": "Supplier",
   "contacts": [
       {
           "primary": true,
           "name": "John Smith",
           "title": "CEO",
           "email": "[email protected]",
           "phone": "1234567654"
       }
   ],
    "addedRelationshipBuyerIds": [
        {
            "id": "04bf895f-e97f-51c5-84bd-7a67406a97a6",
            "sid": "SampleSID-123456902131031"
       }
   ],
    "isSupplierEnablement": false,
   "acceptsCheck": true,
   "merchantId": "418375002",
   "acceptsCard": true,
   "acceptsACH": true,
"acceptsWire": true,
   "requiresLodged": true,
   "variance": {
       "type": "%",
       "amount": "30"
   },
   "paymentTypes": [
       {
           "type": "Check Issuing",
           "enabled": true,
           "payableTo": "John Smith",
           "address": {
               "street1": "123 Street",
               "city": "New York City",
               "state": "NY",
               "country": "USA",
               "postalCode": "10001"
           }
       },
       {
           "type": "V Card",
           "id": "V Card",
           "enabled": true,
           "deliveryMethod": "Email", //fax
           "emails": "[email protected]",
            "fax": "1234567876",
           "proxyPayment": true,
           "requirePin": true,
           "noNotification": false
       },
       {
           "type": "Direct",
           "enabled": false
       },
       {
           "type": "ACH",
           "enabled": true,
           "routingNumber": "121000248",
           "bankAccountNumber": "567654567654567",
           "accountType": "Savings"
       },
       {
           "type": "ACH+",
           "enabled": false,
           "routingNumber": "121000248",
           "bankAccountNumber": "567654567654567",
           "accountType": "Savings",
           "feeType": "discountRate", //flatFee
           "discountRate": "10",
         //  "flatFee": 0,
           "netFees": false
           
       },{
    "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"
},
      
      
       {
           "type": "Dynamic Discounting",
           "enabled": false,
           "routingNumber": "121000248",
           "bankAccountNumber": "567654567654567",
           "accountType": "Savings",
           "discountRate": "0",
           "lowTermDays": 0,
           "highTermDays": 0,
           "netFees": false
       },
        {
           "type": "Dollar Splits",
           "enabled": true,
           "dollarSplits": [
               {
                   "id": "CHK",
                   "threshold": 0
               },
               {
                   "id": "VCN",
                   "threshold": 1000
               }
           ]
       },
       {
           "type": "Payment Thresholds",
           "enabled": false,
           "thresholds": [
               {
                   "id": "0004dd815e2-dc7a-42e0-95b0-a7eabe81f321",
                   "threshold": "0",
                   "paymentType": "V Card"
               },
               {
                   "id": "001bd8ecaa2-8a73-4014-9e48-53b595704836",
                   "paymentType": "ACH",
                   "threshold": "1000"
               }
           ]
       }
   ],
   "checkRemittanceEmails": {
       "emails": "[email protected],[email protected]",
       "enabled": true
   },
   "achRemittanceEmails": {
       "emails": "[email protected]",
       "enabled": true
   },
   "expirePreAuths": true


}

Example Response

👍
204 No content