Get Details for vCard

amount

number

The initial amount loaded on the card.

associatedCustomer

string

Information about the associated customer, if applicable.

associatedVendor

object

Information about the associated vendor.

associatedVendor.additionalData

string

Field for additional data, if any.

associatedVendor.Address1

string

Primary address line of the vendor.

associatedVendor.Address2

string

Secondary address line of the vendor.

associatedVendor.BillingData

object

Billing data for the vendor.

associatedVendor.City

string

City where the vendor is located.

associatedVendor.Contacts

object

associatedVendor.Country

string

Country where the vendor is located.

associatedVendor.CreatedDate

string

Date when the vendor record was created.

associatedVendor.customerVendorAccount

string

Account number of paypoint in the vendor side.

associatedVendor.customField1

string

A custom field for additional data.

associatedVendor.customField2

string

Another custom field for extra data.

associatedVendor.EIN

string

Employer Identification Number of the vendor.

associatedVendor.Email

string

Contact email address of the vendor.

associatedVendor.EnrollmentStatus

string

Enrollment status of the vendor.

associatedVendor.externalPaypointID

string | null

A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant's ID from your own systems.

associatedVendor.InternalReferenceId

integer

Internal reference ID used within the system.

associatedVendor.LastUpdated

string | null

Date when the vendor's information was last updated.

associatedVendor.LocationCode

string

Unique location code for the vendor.

associatedVendor.Mcc

string

Merchant Category Code for the vendor.

associatedVendor.Name1

string

The primary name associated with the vendor.

associatedVendor.Name2

string

Additional name information for the vendor.

associatedVendor.ParentOrgName

string | null

The name of the parent organization.

associatedVendor.payeeName1

string

Primary name of the payee.

associatedVendor.payeeName2

string

Secondary name of the payee.

associatedVendor.PaymentMethod

string

Preferred payment method of the vendor.

associatedVendor.PaypointDbaname

string | null

DBA name of the paypoint.

associatedVendor.PaypointEntryname

string

Entryname of the paypoint.

associatedVendor.PaypointLegalname

string | null

Legal name of the paypoint.

associatedVendor.Phone

string

Contact phone number of the vendor.

associatedVendor.remitAddress1

string | null

Remittance address. Used for mailing paper checks.

associatedVendor.remitAddress2

string | null

Remittance address additional line. Used for mailing paper checks.

associatedVendor.remitCity

string | null

Remittance address city. Used for mailing paper checks.

associatedVendor.remitCountry

string | null

Remittance address country. Used for mailing paper checks.

associatedVendor.remitState

string | null

Remittance address state. Used for mailing paper checks.

associatedVendor.remitZip

string | null

Remittance address ZIP code. Used for mailing paper checks.

associatedVendor.State

string

State where the vendor is located.

associatedVendor.Summary

object

Summary of vendor's billing and transaction status.

associatedVendor.VendorId

integer

Unique identifier for the vendor.

associatedVendor.VendorNumber

string

Unique code identifying the vendor.

associatedVendor.VendorStatus

integer

Status of the vendor.

associatedVendor.Zip

string

ZIP code for the vendor's location.

cardNumber

string

The masked number of the card.

cardToken

string

A unique token identifier for the card.

currentBalance

number

The current balance available on the card.

currentNumberOfUses

integer

The current number of times the card has been used.

cvc

string

Masked Card Verification Code.

dateCreated

string

The creation date of the record.

dateModified

string

The last modified date of the record.

exactAmount

boolean

Indicates if only the exact amount is allowed for transactions.

expenseLimit

number

The set limit for expenses.

expenseLimitPeriod

string

The period for the expense limit.

expirationDate

string

The expiration date of the card.

externalPaypointID

string | null

A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant's ID from your own systems.

maxNumberOfUses

integer

Maximum number of uses allowed for the card.

mcc

string

Merchant Category Code, if applicable.

misc1

string

A miscellaneous field for additional information.

misc2

string

Another miscellaneous field for extra information.

ParentOrgName

string

Name of the parent organization.

PaypointDbaname

string

The 'Doing Business As' name of the Paypoint.

PaypointEntryname

string

Entry name for the Paypoint, if applicable.

PaypointLegalname

string

The legal name of the Paypoint.

status

string

The current status of the card.

tcc

string

Transaction Category Code, if applicable.

vcardSent

boolean

Indicates if the virtual card was sent.

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

Authorizations

Path Parameters

Response