Get Details for vCard - Payabli Docs

Intro

API Basics

Pay In Endpoints

MoneyIn
Subscription
TokenStorage
Invoice
LineItem
PaymentLink
PaymentMethodDomain
HostedPaymentPages
Cloud
Wallet: Apple Pay

Pay Out Endpoints

Pay Ops Endpoints

Templates
Boarding
Chargebacks and ACH Returns
Entities
Notification
Query
Statistic
Export
Import

Object Models

Object Model References

GET

MoneyOut

vcard

{cardToken}

curl --request GET \
  --url https://api-sandbox.payabli.com/api/MoneyOut/vcard/{cardToken} \
  --header 'requestToken: <api-key>'

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

This endpoint is only available in some accounts. Contact the Payabli team to learn more.

Authorizations

requestToken

string

header

required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

cardToken

string

required

ID for a virtual card.

Example:

"20230403315245421165"

Response

200

application/json

Success

vcardSent

boolean

Indicates if the virtual card was sent.

Example:

false

cardToken

string

A unique token identifier for the card.

Example:

"20231206142225226104"

cardNumber

string

The masked number of the card.

Example:

"553232XXXXXX3179"

cvc

string

Masked Card Verification Code.

Example:

"XXX"

expirationDate

string

The expiration date of the card.

Example:

"2025-05-01"

status

string

The current status of the card.

Example:

"Active"

amount

number

The initial amount loaded on the card.

Example:

120

currentBalance

number

The current balance available on the card.

Example:

120

expenseLimit

number

The set limit for expenses.

Example:

20

expenseLimitPeriod

string

The period for the expense limit.

Example:

"daily"

maxNumberOfUses

integer

Maximum number of uses allowed for the card.

Example:

1

currentNumberOfUses

integer

The current number of times the card has been used.

Example:

0

exactAmount

boolean

Indicates if only the exact amount is allowed for transactions.

Example:

true

mcc

string

Merchant Category Code, if applicable.

Example:

null

tcc

string

Transaction Category Code, if applicable.

Example:

""

misc1

string

A miscellaneous field for additional information.

Example:

null

misc2

string

Another miscellaneous field for extra information.

Example:

null

dateCreated

string

The creation date of the record.

Example:

"2023-12-06T20:25:31.077"

dateModified

string

The last modified date of the record.

Example:

"2023-12-06T00:00:00"

associatedVendor

object

Information about the associated vendor.

associatedVendor.VendorNumber

string

Unique code identifying the vendor.

Example:

"VENDOR123456"

associatedVendor.Name1

string

The primary name associated with the vendor.

Example:

"Smith Industries"

associatedVendor.Name2

string

Additional name information for the vendor.

Example:

"John Smith"

associatedVendor.EIN

string

Employer Identification Number of the vendor.

Example:

"12-3456789"

associatedVendor.Phone

string

Contact phone number of the vendor.

Example:

"555-123-4567"

associatedVendor.Email

string

Contact email address of the vendor.

Example:

"contact@smithindustries.com"

associatedVendor.Address1

string

Primary address line of the vendor.

Example:

"1234 Main Street"

associatedVendor.Address2

string

Secondary address line of the vendor.

Example:

"Suite 200"

associatedVendor.City

string

City where the vendor is located.

Example:

"New York"

associatedVendor.State

string

State where the vendor is located.

Example:

"NY"

associatedVendor.Zip

string

ZIP code for the vendor's location.

Example:

"10001"

associatedVendor.Country

string

Country where the vendor is located.

Example:

"USA"

associatedVendor.Mcc

string

Merchant Category Code for the vendor.

Example:

"5411"

associatedVendor.LocationCode

string

Unique location code for the vendor.

Example:

"LOC1234"

associatedVendor.Contacts

object

associatedVendor.BillingData

object

Billing data for the vendor.

associatedVendor.PaymentMethod

string

Preferred payment method of the vendor.

Example:

"card"

associatedVendor.VendorStatus

integer

Status of the vendor.

Example:

1

associatedVendor.VendorId

integer

Unique identifier for the vendor.

Example:

339

associatedVendor.EnrollmentStatus

string

Enrollment status of the vendor.

Example:

null

associatedVendor.Summary

object

Summary of vendor's billing and transaction status.

associatedVendor.PaypointLegalname

string | null

Legal name of the paypoint.

Example:

"Sunshine Services, LLC"

associatedVendor.PaypointDbaname

string | null

DBA name of the paypoint.

Example:

"Sunshine Gutters"

associatedVendor.PaypointEntryname

string

Entryname of the paypoint.

Example:

"47902bca9"

associatedVendor.ParentOrgName

string | null

The name of the parent organization.

Example:

"PropertyManager Pro"

associatedVendor.CreatedDate

string

Date when the vendor record was created.

Example:

"2022-07-01 15:00:01"

associatedVendor.LastUpdated

string | null

Date when the vendor's information was last updated.

Example:

"2022-07-01 15:00:01"

associatedVendor.remitAddress1

string | null

Remittance address. Used for mailing paper checks.

Example:

"123 Walnut Street"

associatedVendor.remitAddress2

string | null

Remittance address additional line. Used for mailing paper checks.

Example:

"Suite 900"

associatedVendor.remitCity

string | null

Remittance address city. Used for mailing paper checks.

Example:

"Miami"

associatedVendor.remitState

string | null

Remittance address state. Used for mailing paper checks.

Example:

"FL"

associatedVendor.remitZip

string | null

Remittance address ZIP code. Used for mailing paper checks.

Example:

"31113"

associatedVendor.remitCountry

string | null

Remittance address country. Used for mailing paper checks.

Example:

"US"

associatedVendor.payeeName1

string

Primary name of the payee.

Example:

null

associatedVendor.payeeName2

string

Secondary name of the payee.

Example:

null

associatedVendor.customField1

string

A custom field for additional data.

Example:

null

associatedVendor.customField2

string

Another custom field for extra data.

Example:

null

associatedVendor.customerVendorAccount

string

Account number of paypoint in the vendor side.

Example:

null

associatedVendor.InternalReferenceId

integer

Internal reference ID used within the system.

Example:

27

associatedVendor.additionalData

string

Field for additional data, if any.

Example:

null

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.

Example:

"Paypoint-100"

associatedCustomer

string

Information about the associated customer, if applicable.

Example:

null

ParentOrgName

string

Name of the parent organization.

Example:

"HOA Manager Pro"

PaypointDbaname

string

The 'Doing Business As' name of the Paypoint.

Example:

"Athlete Factory LLC"

PaypointLegalname

string

The legal name of the Paypoint.

Example:

"Athlete Factory LLC"

PaypointEntryname

string

Entry name for the Paypoint, if applicable.

Example:

null

externalPaypointID

string | null

Example:

"Paypoint-100"

Was this page helpful?

Get Payout Details Add Bill

curl --request GET \
  --url https://api-sandbox.payabli.com/api/MoneyOut/vcard/{cardToken} \
  --header 'requestToken: <api-key>'

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