Create buyer

post

https://api.cpxenterprise.com/buyer/v1/buyer

This route will create a new buyer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Definition for a new buyer

name

string

required

(\S)

bid

string

required

(^(?!\s)([\x20-\x7E]){1,255}(?!\s)$)

associatedInstitutionId

string

required

(\S)

associatedInstitutionName

string

(\S)

ssnEinType

string

isAlternateMailingAddress

boolean

yearlyEstimatedSpend

string

checkIssuingEnabled

boolean

lodgePaymentEnabled

boolean

dualPifApproval

object

institutionId

string

(^$|\S)

A valid string

address

object

Address for the buyer

creditLimit

double

phone

string

(^$|^\d{10}$)

A valid Phone Number

contact

object

Contact for the buyer

contacts

array of objects

Contact information for the buyer

contacts

achEnabled

boolean

virtualCardEnabled

boolean

achRequested

boolean

virtualCardRequested

boolean

chkEnabled

boolean

dxcModelFromAccountNumber

string

status

string

enum

required

Allowed:

externalStatus

string

enum

required

Allowed:

bankAccounts

array of objects

bankAccounts

virtualCard

object

Virtual Card Information

owners

array of objects

owners

ach

object

ACH Information

achPaymentRoute

string

enum

Defaults to MX Merchant

Allowed:

lodgePaymentCards

array of objects

lodgePaymentCards

vcnHostConfig

object

failOverPayment

object

paymentFileType

string

achMerchantId

string

(^$|^\d{9,10}$)

nachaId

string

^$|^[^\W_]{1}(-[^\W_]{1}|[^\W_]{1}-|[^\W_]{2})[^\W_]{7}$

Responses

201

Success

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

defaultError