Create virtual card vendor

post https://extapiai2-1602d:8443/api/v1/gateway/ext/vc/company/{company}/vendor

Use to create a new virtual card Vendor for a company.

Path Params

company

string

required

The required virtual card company id

Body Params

addressLine1

string

required

length between 1 and 40

Vendor Address Line1

addressLine2

string

length between 1 and 40

Vendor Address Line2

city

string

required

length between 1 and 40

Vendor City

companyContactEmail

string

required

length between 1 and 50

Company Contact Email

companyContactName

string

required

length between 1 and 40

Company Contact Name

companyContactPhone

string

required

length between 1 and 20

Company Contact Phone

contactEmail

string

required

length between 1 and 50

Vendor Email

contactFirstname

string

required

length between 1 and 20

Vendor First Name

contactLastname

string

required

length between 1 and 20

Vendor Last Name

contactPhone

string

required

length between 1 and 20

Vendor Contact Phone

defaultDaysValidFor

int32

Number of days the Vendor has to authorize a virtual card payment before the virtual card number is rendered invalid. Possible values: 1-90

defaultNumberOfUses

int32

Number of times the Vendor may use the virtual card number before it is rendered invalid. Possible values: 1=Single Use; 0=Unlimited Use; ##=Specific number of times (1-99). Must be '1' when invoiceAmountOnly = true.

invoiceAmountOnly

boolean

required

Flag indicating if Vendor can authorize for only the amount of the virtual card payment.

legalName

string

required

length between 1 and 40

Vendor Legal Name

postalCode

string

required

length between 1 and 10

Vendor Zip Code

shortName

string

length between 1 and 40

Vendor Short Name

stateOrProvince

string

required

length between 1 and 20

Vendor State

tolerancePercent

int32

required

Indicates the tolerance percentage (less than/greater than) of the payment amount the Vendor may authorize for. Possible values: 1-99%

vendorId

string

required

length between 1 and 25

Vendor's alternate unique key

Headers

x-css-tracking-token

string

Optional client tracking token used for tracing each call, a unique one will be generated if empty

Responses

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://extapiai2-1602d:8443/api/v1/gateway/ext/vc/company/company/vendor \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "invoiceAmountOnly": true
8
}
9
'

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

application/json

201Request was successful

400Request data is invalid

403User has no access to create a vendor

404Record not found

500Unexpected system error