Request virtual card payment information for a vendor

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

Provides details of all previously made virtual card payments for a specific vendor.

Responses

Response body

array of objects

object

virtualCardId

string

required

The unique id associated to the provider-generated virtual card number issued as a result of this payment request. This id can be used to subsequently update and/or cancel this payment request at a later time.

cardLast4

string

required

The last 4 digits of the virtual card

minAmount

number

required

Minimum amount the Vendor can authorize. This value must be greater than 0. This value must be provided when paymentType = min-max-range.

maxAmount

number

required

Maximum amount the Vendor can authorize. This value cannot exceed the Virtual card Credit Limit. This value must be provided when paymentType = min-max-range.

numberOfUses

int32

required

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' if paymentType = invoice-amount.

daysValidFor

int32

required

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

realCardAlias

string

required

The alias of the card selected for use when making a virtual card payment in which the provider subsequently generates a unique virtual card number.

paymentDate

date-time

required

The date the payment was created

status

string

required

The current status of the virtual card

vendorId

string

required

The alternate unique key for the company vendor

vendorLegalName

string

required

Vendor Legal Name

vendorShortname

string

required

Vendor Short Name

paymentLineItems

array of objects

required

One or more invoice details associated with the virtual card

paymentLineItems*

object

invoiceAmount

number

required

Invoice payment amount

invoiceDate

date-time

length between 10 and 10

Invoice date

invoiceDescription

string

required

length between 1 and 250

Invoice description/notation

invoiceLineItem

string

length between 1 and 4

Invoice line number

invoiceNumber

string

length between 1 and 50

Invoice number/identifier

notationFields

array of strings

Up to 12 user-defined notations associated to this payment.

notationFields

paymentNotes

string

length between 1 and 250

Payment notes for this invoice/line item

paymentReferenceId

string

length between 1 and 30

Payment reference number for this invoice/line item

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://extapiai2-1602d:8443/api/v1/gateway/ext/vc/company/vendors/vendor/payments \
3
     --header 'accept: application/json'

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

application/json

200Successful

204No records found

400Request data is invalid

403User has no access to the brand