Create Buyer

Overview

You can create a Buyer 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>/buyer/v1/buyer

Arguments

Field	Sub Field	Mandatory or Optional
name		Mandatory
address	street1 street2 city state country postalCode	Optional
creditLimit		Optional
yearlyEstimatedSpent		Optional
status		Mandatory
externalStatus		Mandatory
contacts	id primary name title email phone	Optional
associatedInstitutionId		Mandatory
bid		Mandatory
virtualCardRequested		Optional
achRequested		Optional
paymentFileType		Optional
achPaymentRoute		Optional
dualPifApproval	enabled	Optional
bankAccounts	accountNumber	Optional
	routingNumber
	defaults VCN ACH CHK MCK
	accountType	Optional
nachaId		Optional
achMerchantId		Optional
achConfig		Optional
	metadata description field Text addenda Mapping Field order text	Optional
vcnHost		Optional
vcnHostConfig		Mandatory if vcnhost is passed and if vcnrequested is true
	falcons paymentReferenceNumber location	Optional
	braves primaryAccountNumber companyNumber centralBillAccountNumber	Optional
	Vpa pp enabled rva enabled visaBuyerId templateId fundingInfo fundingAccount creditLimit expirationDate	Optional
mri		Optional, Can only be passed for MRI Network and Institutes.
	clientId	clientId
	database	Mandatory if MRI node is passed
	username	Mandatory if MRI node is passed
	password	Mandatory if MRI node is passed

Example Request

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


{
    "status": "Approved",
    "name": "test api doc buyer",
    "creditLimit": 1000,
    "yearlyEstimatedSpend": "100000",
    "externalStatus": "Active",
    "associatedInstitutionId": "0df2d073-64d5-58e2-96ee-4770201facb7",
    "vcnHost": "falcons",
    "bid": "1231232",
    "paymentFileType": "56c454fb-04a1-58c8-8daa-6b8181cc8e6f",
    "bankAccounts": [
        {
            "accountNumber": "23471698364816398",
            "routingNumber": "121000248",
            "defaults": [
                "VCN",
                "ACH"
            ],
            "accountType": "savings"
        }
    ],
    "virtualCardRequested": true,
    "achRequested": true,
    "contacts": [
        {
            "primary": true,
            "name": "tom",
            "title": "CFO",
            "email": "[email protected]",
            "phone": "1234124123"
        }
    ],
    "address": {
        "street1": "test addresss",
        "city": "test city",
        "state": "AL",
        "country": "USA",
        "postalCode": "10001"
    },
    "dualPifApproval": {
        "enabled": true
    },
    "achPaymentRoute": "MX Merchant",
    "contact": {
        "name": "robert",
        "title": "CTO",
        "email": "[email protected]"
    },
    "achMerchantId": "0987654321",
    "nachaId": "1234567890",
    "vcnHostConfig": {
        "falcon": {
            "paymentReferenceNumber": "906126293024",
            "location": "California"
        },
        "united": {
            "primaryAccountNumber": "1234567890789034",
            "companyNumber": "00003"
        },
        "braves": {
            "primaryAccountNumber": "0789990099944155",
            "companyNumber": "99999",
            "centralBillAccountNumber": "4567898765445678"
        },
        "vpa": {
            "pp": {
                "enabled": true
            },
            "visaBuyerId": "10079384"
        }
    },
    "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


"ccd125d1-b23b-5485-9721-d44ae26ddc93"

👍
HTTP Status: 201 Updated

Content-Type → application/json