Create Supplier

Overview

You can create a Supplier with basic details such as name, title, email, etc .using the POST method and use them for various CPX solution offerings.

Resource Access

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

Arguments

Parameter	Mandatory / Optional
name	Mandatory
address	Optional
mcc	Optional
status	Mandatory
externalStatus	Mandatory
payeeType	Mandatory
contacts	Optional
addedRelationshipBuyerIds	Optional
isSupplierEnablement	Optional
acceptsCheck	Optional
merchantId	Optional (Mandatory, if Direct payment method is activated for Virtual Card)
acceptsCard	Optional
acceptsACH	Optional
requiresLodged	Optional
variance	Optional
paymentTypes	Mandatory (atleast one payment method should be provided if Status is Approved else only paymentTypes array can be passed as blank)
achRemittanceEmails	Optional
checkRemittanceEmails	Optional
expirePreAuths	Optional

Example Request


{
   "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": "Approved",
   "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": "SampleSID12345"
       }
   ],
   "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",
           "additionalPayableTo": "c/o Smith Enterprises",
           "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": "ACH",
           "enabled": true,
           "routingNumber": "121000248",
           "bankAccountNumber": "567654567654567",
           "accountType": "Savings"
       },
       {
           "type": "ACH+",
           "enabled": false,
           "routingNumber": "121000248",
           "bankAccountNumber": "567654567654567",
           "accountType": "Savings",
           "discountRate": "0",
           "flatFee": 0,
           "netFees": false
           
       },
      
       {
           "type": "Direct",
           "enabled": false
       },
       {
           "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": "ACH",
                   "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"
               },
{
    "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"
}


           ]
       }
   ],
   "expirePreAuths": true,
   "checkRemittanceEmails": {
       "emails": "[email protected],[email protected]",
       "enabled": true
   },
   "achRemittanceEmails": {
       "emails": "[email protected]",
       "enabled": true
   }


}

Example Response

👍
201 Created


"7e245b5d-0b7b-53d0-aaa5-a835bb1e7cfc"