> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://beta-docs.payabli.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server.

# Get virtual card details

GET https://api-sandbox.payabli.com/api/MoneyOut/vcard/{cardToken}

Retrieves vCard details for a single card in an entrypoint.

Reference: https://beta-docs.payabli.com/api-reference/moneyout/get-vcard

## Authentication

- `requestToken` header (required) — API Key authentication via header

## Servers

- `https://api-sandbox.payabli.com/api` (Sandbox, default)
- `https://api.payabli.com/api` (Production)

## Request

### Path parameters

- `cardToken` (string, required) — ID for a virtual card.

## Response

### 200

Success

- `amount` (double, optional) — The initial amount loaded on the card.
- `associatedCustomer` (string, optional) — Information about the associated customer, if applicable.
- `associatedVendor` (VCardGetResponseAssociatedVendor, optional) — Information about the associated vendor.
- `cardNumber` (string, optional) — The masked number of the card.
- `cardToken` (string, optional) — A unique token identifier for the card.
- `currentBalance` (double, optional) — The current balance available on the card.
- `currentNumberOfUses` (integer, optional) — The current number of times the card has been used.
- `cvc` (string, optional) — Masked Card Verification Code.
- `dateCreated` (string, optional) — The creation date of the record.
- `dateModified` (string, optional) — The last modified date of the record.
- `exactAmount` (boolean, optional) — Indicates if only the exact amount is allowed for transactions.
- `expenseLimit` (double, optional) — The set limit for expenses.
- `expenseLimitPeriod` (string, optional) — The period for the expense limit.
- `expirationDate` (string, optional) — The expiration date of the card.
- `externalPaypointID` (string, optional) — 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, optional) — Maximum number of uses allowed for the card.
- `mcc` (string, optional) — Merchant Category Code, if applicable.
- `misc1` (string, optional) — A miscellaneous field for additional information.
- `misc2` (string, optional) — Another miscellaneous field for extra information.
- `ParentOrgName` (string, optional) — Name of the parent organization.
- `PaypointDbaname` (string, optional) — The 'Doing Business As' name of the Paypoint.
- `PaypointEntryname` (string, optional) — Entry name for the Paypoint, if applicable.
- `PaypointLegalname` (string, optional) — The legal name of the Paypoint.
- `status` (string, optional) — The current status of the card.
- `tcc` (string, optional) — Transaction Category Code, if applicable.
- `vcardSent` (boolean, optional) — Indicates if the virtual card was sent.

## Errors

### 400 Bad Request Error

Bad request/ invalid data

- `any`

### 401 Unauthorized Error

Unauthorized request.

- `any`

### 500 Internal Server Error

Internal API Error

- `any`

### 503 Service Unavailable Error

Database connection error

- `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure.
- `responseData` (map from string to any, optional) — The object containing the response data.
- `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'.

## Types

### VCardGetResponseAssociatedVendor

Information about the associated vendor.

- `additionalData` (string, optional) — Field for additional data, if any.
- `Address1` (string, optional) — Primary address line of the vendor.
- `Address2` (string, optional) — Secondary address line of the vendor.
- `BillingData` (VCardGetResponseAssociatedVendorBillingData, optional) — Billing data for the vendor.
- `City` (string, optional) — City where the vendor is located.
- `Contacts` (Contacts, optional)
- `Country` (string, optional) — Country where the vendor is located.
- `CreatedDate` (datetime, optional) — Date when the vendor record was created.
- `customerVendorAccount` (string, optional) — Account number of paypoint in the vendor side.
- `customField1` (string, optional) — A custom field for additional data.
- `customField2` (string, optional) — Another custom field for extra data.
- `EIN` (string, optional) — Employer Identification Number of the vendor.
- `Email` (string, optional) — Contact email address of the vendor.
- `EnrollmentStatus` (string, optional) — Enrollment status of the vendor.
- `externalPaypointID` (string, optional) — 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.
- `InternalReferenceId` (integer, optional) — Internal reference ID used within the system.
- `LastUpdated` (datetime, optional) — Date when the vendor's information was last updated.
- `LocationCode` (string, optional) — Unique location code for the vendor.
- `Mcc` (string, optional) — Merchant Category Code for the vendor.
- `Name1` (string, optional) — The primary name associated with the vendor.
- `Name2` (string, optional) — Additional name information for the vendor.
- `ParentOrgName` (string, optional) — The name of the parent organization.
- `payeeName1` (string, optional) — Primary name of the payee.
- `payeeName2` (string, optional) — Secondary name of the payee.
- `paymentMethod` (VendorPaymentMethod, optional) — Object containing details about the payment method to use for the payout.
- `PaypointDbaname` (string, optional) — DBA name of the paypoint.
- `PaypointEntryname` (string, optional) — Entryname of the paypoint.
- `PaypointLegalname` (string, optional) — Legal name of the paypoint.
- `Phone` (string, optional) — Contact phone number of the vendor.
- `remitAddress1` (string, optional) — Remittance address. Used for mailing paper checks.
- `remitAddress2` (string, optional) — Remittance address additional line. Used for mailing paper checks.
- `remitCity` (string, optional) — Remittance address city. Used for mailing paper checks.
- `remitCountry` (string, optional) — Remittance address country. Used for mailing paper checks.
- `remitState` (string, optional) — Remittance address state. Used for mailing paper checks.
- `remitZip` (string, optional) — Remittance address ZIP code. Used for mailing paper checks.
- `State` (string, optional) — State where the vendor is located.
- `Summary` (VCardGetResponseAssociatedVendorSummary, optional) — Summary of vendor's billing and transaction status.
- `VendorId` (integer, optional) — Unique identifier for the vendor.
- `VendorNumber` (string, optional) — Unique code identifying the vendor.
- `VendorStatus` (integer, optional) — Status of the vendor.
- `Zip` (string, optional) — ZIP code for the vendor's location.

### VCardGetResponseAssociatedVendorBillingData

Billing data for the vendor.

- `accountNumber` (string, optional) — Masked account number for transactions.
- `bankAccountFunction` (integer, optional) — Function of the bank account.
- `bankAccountHolderName` (string, optional) — Name of the bank account holder.
- `bankAccountHolderType` (string, optional) — Type of bank account holder.
- `bankName` (string, optional) — Name of the bank used for transactions.
- `id` (string, optional) — Unique identifier for billing data.
- `routingAccount` (string, optional) — Routing number for the bank account.
- `typeAccount` (string, optional) — Type of the bank account.

### Contacts

- `contactEmail` (string, optional) — Contact email address.
- `contactName` (string, optional) — Contact name.
- `contactPhone` (string, optional) — Contact phone number.
- `contactTitle` (string, optional) — Contact title.

### VendorPaymentMethod

Object containing details about the payment method to use for the payout.

- `method` (enum, optional) — Payment method to use for payout. Leave empty for managed payables.
  - Allowed values: `managed`, `vcard`, `ach`, `check`

### VCardGetResponseAssociatedVendorSummary

Summary of vendor's billing and transaction status.

- `ActiveBills` (integer, optional) — Number of active bills.
- `ActiveBillsAmount` (double, optional) — Total amount of active bills.
- `ApprovedBills` (integer, optional) — Number of bills that have been approved.
- `ApprovedBillsAmount` (double, optional) — Total amount of approved bills.
- `DisapprovedBills` (integer, optional) — Number of bills that have been disapproved.
- `DisapprovedBillsAmount` (double, optional) — Total amount of rejected bills.
- `InTransitBills` (integer, optional) — Number of bills in transit.
- `InTransitBillsAmount` (double, optional) — Total amount of bills in transit.
- `OverdueBills` (integer, optional) — Number of bills that are overdue.
- `OverdueBillsAmount` (double, optional) — Total amount of overdue bills.
- `PaidBills` (integer, optional) — Number of bills that have been paid.
- `PaidBillsAmount` (double, optional) — Total amount of paid bills.
- `PendingBills` (integer, optional) — Number of bills pending approval or payment.
- `PendingBillsAmount` (double, optional) — Total amount of pending bills.
- `TotalBills` (integer, optional) — Total number of bills.
- `TotalBillsAmount` (double, optional) — Total amount of all bills.

## Examples

**Response**

```json
{
  "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
}
```

**SDK Code**

```python GetVCard
import requests

url = "https://api-sandbox.payabli.com/api/MoneyOut/vcard/20230403315245421165"

headers = {"requestToken": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript GetVCard
const url = 'https://api-sandbox.payabli.com/api/MoneyOut/vcard/20230403315245421165';
const options = {method: 'GET', headers: {requestToken: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go GetVCard
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/MoneyOut/vcard/20230403315245421165"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("requestToken", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby GetVCard
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/MoneyOut/vcard/20230403315245421165")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java GetVCard
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/MoneyOut/vcard/20230403315245421165")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php GetVCard
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/MoneyOut/vcard/20230403315245421165', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp GetVCard
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/MoneyOut/vcard/20230403315245421165");
var request = new RestRequest(Method.GET);
request.AddHeader("requestToken", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift GetVCard
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/MoneyOut/vcard/20230403315245421165")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```