Get virtual card details

curl https://api-sandbox.payabli.com/api/MoneyOut/vcard/20230403315245421165 \
     -H "requestToken: <apiKey>"

{
  "amount": 120,
  "associatedCustomer": "associatedCustomer",
  "associatedVendor": {
    "additionalData": "additionalData",
    "Address1": "1234 Main Street",
    "Address2": "Suite 200",
    "BillingData": {
      "accountNumber": "3XXXXXX8888",
      "bankAccountFunction": 0,
      "bankAccountHolderName": "bankAccountHolderName",
      "bankAccountHolderType": "bankAccountHolderType",
      "bankName": "Chase Bank",
      "id": "id",
      "routingAccount": "021000021",
      "typeAccount": "Checking"
    },
    "City": "New York",
    "Contacts": {
      "contactEmail": "example@email.com",
      "contactName": "Herman Martinez",
      "contactPhone": "3055550000",
      "contactTitle": "Owner"
    },
    "Country": "USA",
    "CreatedDate": "2022-07-01T15:00:01Z",
    "customerVendorAccount": "customerVendorAccount",
    "customField1": "customField1",
    "customField2": "customField2",
    "EIN": "12-3456789",
    "Email": "contact@smithindustries.com",
    "EnrollmentStatus": "EnrollmentStatus",
    "externalPaypointID": "Paypoint-100",
    "InternalReferenceId": 27,
    "LastUpdated": "2022-07-01T15:00:01Z",
    "LocationCode": "LOC1234",
    "Mcc": "5411",
    "Name1": "Smith Industries",
    "Name2": "John Smith",
    "ParentOrgName": "PropertyManager Pro",
    "payeeName1": "payeeName1",
    "payeeName2": "payeeName2",
    "paymentMethod": {
      "method": "vcard"
    },
    "PaypointDbaname": "Sunshine Gutters",
    "PaypointEntryname": "47902bca9",
    "PaypointLegalname": "Sunshine Services, LLC",
    "Phone": "555-123-4567",
    "remitAddress1": "123 Walnut Street",
    "remitAddress2": "Suite 900",
    "remitCity": "Miami",
    "remitCountry": "US",
    "remitState": "FL",
    "remitZip": "31113",
    "State": "NY",
    "Summary": {
      "ActiveBills": 1,
      "ActiveBillsAmount": 1.1,
      "ApprovedBills": 1,
      "ApprovedBillsAmount": 1.1,
      "DisapprovedBills": 1,
      "DisapprovedBillsAmount": 1.1,
      "InTransitBills": 0,
      "InTransitBillsAmount": 0,
      "OverdueBills": 1,
      "OverdueBillsAmount": 100,
      "PaidBills": 0,
      "PaidBillsAmount": 0,
      "PendingBills": 1,
      "PendingBillsAmount": 100,
      "TotalBills": 1,
      "TotalBillsAmount": 100
    },
    "VendorId": 339,
    "VendorNumber": "VENDOR123456",
    "VendorStatus": 1,
    "Zip": "10001"
  },
  "cardNumber": "553232XXXXXX3179",
  "cardToken": "20231206142225226104",
  "currentBalance": 120,
  "currentNumberOfUses": 0,
  "cvc": "XXX",
  "dateCreated": "2023-12-06T20:25:31.077",
  "dateModified": "2023-12-06T00:00:00",
  "exactAmount": true,
  "expenseLimit": 20,
  "expenseLimitPeriod": "daily",
  "expirationDate": "2025-05-01",
  "externalPaypointID": "Paypoint-100",
  "maxNumberOfUses": 1,
  "mcc": "mcc",
  "misc1": "misc1",
  "misc2": "misc2",
  "ParentOrgName": "HOA Manager Pro",
  "PaypointDbaname": "Athlete Factory LLC",
  "PaypointEntryname": "PaypointEntryname",
  "PaypointLegalname": "Athlete Factory LLC",
  "status": "Active",
  "tcc": "",
  "vcardSent": false
}

Retrieves vCard details for a single card in an entrypoint.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

cardTokenstringRequired

ID for a virtual card.

Response

Success

amountdouble

The initial amount loaded on the card.

associatedCustomerstring

Information about the associated customer, if applicable.

associatedVendorobject

Information about the associated vendor.

cardNumberstring

The masked number of the card.

cardTokenstring

A unique token identifier for the card.

currentBalancedouble

The current balance available on the card.

currentNumberOfUsesinteger

The current number of times the card has been used.

cvcstring

Masked Card Verification Code.

dateCreatedstring

The creation date of the record.

dateModifiedstring

The last modified date of the record.

exactAmountboolean

Indicates if only the exact amount is allowed for transactions.

expenseLimitdouble

The set limit for expenses.

expenseLimitPeriodstring

The period for the expense limit.

expirationDatestring

The expiration date of the card.

externalPaypointIDstring

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.

maxNumberOfUsesinteger

Maximum number of uses allowed for the card.

mccstring

Merchant Category Code, if applicable.

misc1string

A miscellaneous field for additional information.

misc2string

Another miscellaneous field for extra information.

ParentOrgNamestring

Name of the parent organization.

PaypointDbanamestring

The 'Doing Business As' name of the Paypoint.

PaypointEntrynamestring

Entry name for the Paypoint, if applicable.

PaypointLegalnamestring

The legal name of the Paypoint.

statusstring

The current status of the card.

tccstring

Transaction Category Code, if applicable.

vcardSentboolean

Indicates if the virtual card was sent.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error