> This is Payabli documentation. For a complete page index, fetch https://docs.payabli.com/llms.txt — append .md to any page URL for lightweight markdown. For section-level indexes, query parameters, and other AI-optimized access methods, see https://docs.payabli.com/ai-agents.md

# 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://docs.payabli.com/developers/api-reference/cards/get-vcard

## Authentication

- `Authorization` header (bearer token, required)
- `requestToken` header (required) — Long-lived API token sent in the `requestToken` header. See [API token authentication](/developers/api-tokens).

## 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

- `vcardSent` (boolean, optional) — Indicates if the virtual card was sent.
- `cardToken` (string, optional) — A unique token identifier for the card.
- `cardNumber` (string, optional) — The masked number of the card.
- `cvc` (string, optional) — Masked Card Verification Code.
- `expirationDate` (string, optional) — The expiration date of the card.
- `status` (string, optional) — The current status of the card.
- `amount` (double, optional) — The initial amount loaded on the card.
- `currentBalance` (double, optional) — The current balance available on the card.
- `expenseLimit` (double, optional) — The set limit for expenses.
- `expenseLimitPeriod` (string, optional) — The period for the expense limit.
- `maxNumberOfUses` (integer, optional) — Maximum number of uses allowed for the card.
- `currentNumberOfUses` (integer, optional) — The current number of times the card has been used.
- `exactAmount` (boolean, optional) — Indicates if only the exact amount is allowed for transactions.
- `mcc` (string, optional) — Merchant Category Code, if applicable.
- `tcc` (string, optional) — Transaction Category Code, if applicable.
- `misc1` (string, optional) — A miscellaneous field for additional information.
- `misc2` (string, optional) — Another miscellaneous field for extra information.
- `dateCreated` (string, optional) — The creation date of the record.
- `dateModified` (string, optional) — The last modified date of the record.
- `associatedVendor` (object, optional) — Information about the associated vendor.
  - `VendorNumber` (string, optional) — Unique code identifying the vendor.
  - `Name1` (string, optional) — The primary name associated with the vendor.
  - `Name2` (string, optional) — Additional name information for the vendor.
  - `EIN` (string, optional) — Employer Identification Number of the vendor.
  - `Phone` (string, optional) — Contact phone number of the vendor.
  - `Email` (string, optional) — Contact email address of the vendor.
  - `RemitEmail` (string, optional) — Email address for remittance.
  - `Address1` (string, optional) — Primary address line of the vendor.
  - `Address2` (string, optional) — Secondary address line of the vendor.
  - `City` (string, optional) — City where the vendor is located.
  - `State` (string, optional) — State where the vendor is located.
  - `Zip` (string, optional) — ZIP code for the vendor's location.
  - `Country` (string, optional) — Country where the vendor is located.
  - `Mcc` (string, optional) — Merchant Category Code for the vendor.
  - `LocationCode` (string, optional) — A location code used to identify the vendor's location.
  - `Contacts` (list of object, optional) — Array of objects describing the vendor's contacts.
    - `ContactName` (string, optional) — Name of the contact.
    - `ContactEmail` (string, optional) — Email of the contact.
    - `ContactTitle` (string, optional) — Title of the contact.
    - `ContactPhone` (string, optional) — Phone number of the contact.
  - `BillingData` (object, optional) — Billing data for the vendor.
    - `id` (integer, optional) — Unique identifier for billing data.
    - `accountId` (string, optional) — Account identifier.
    - `nickname` (string, optional) — Nickname for the account.
    - `bankName` (string, optional) — Name of the bank used for transactions.
    - `routingAccount` (string, optional) — Routing number for the bank account.
    - `accountNumber` (string, optional) — Masked account number for transactions.
    - `typeAccount` (string, optional) — Type of the bank account.
    - `bankAccountHolderName` (string, optional) — Name of the bank account holder.
    - `bankAccountHolderType` (string, optional) — Type of bank account holder.
    - `bankAccountFunction` (integer, optional) — Function of the bank account.
    - `verified` (boolean, optional) — Indicates if the account is verified.
    - `status` (integer, optional) — Status of the billing data.
    - `services` (list of any, optional) — Services associated with the account.
    - `default` (boolean, optional) — Indicates if this is the default billing account.
  - `PaymentMethod` (string, optional) — Preferred payment method for vendor.
  - `VendorStatus` (integer, optional) — Status of the vendor.
  - `VendorId` (integer, optional) — Unique identifier for the vendor.
  - `EnrollmentStatus` (string, optional) — Enrollment status of the vendor.
  - `Summary` (object, optional) — Summary of vendor's billing and transaction status.
    - `ActiveBills` (integer, optional) — Number of active bills.
    - `PendingBills` (integer, optional) — Number of bills pending approval or payment.
    - `InTransitBills` (integer, optional) — Number of bills in transit.
    - `PaidBills` (integer, optional) — Number of bills that have been paid.
    - `OverdueBills` (integer, optional) — Number of bills that are overdue.
    - `ApprovedBills` (integer, optional) — Number of bills that have been approved.
    - `DisapprovedBills` (integer, optional) — Number of bills that have been disapproved.
    - `TotalBills` (integer, optional) — Total number of bills.
    - `ActiveBillsAmount` (double, optional) — Total amount of active bills.
    - `PendingBillsAmount` (double, optional) — Total amount of pending bills.
    - `InTransitBillsAmount` (double, optional) — Total amount of bills in transit.
    - `PaidBillsAmount` (double, optional) — Total amount of paid bills.
    - `OverdueBillsAmount` (double, optional) — Total amount of overdue bills.
    - `ApprovedBillsAmount` (double, optional) — Total amount of approved bills.
    - `DisapprovedBillsAmount` (double, optional) — Total amount of rejected bills.
    - `TotalBillsAmount` (double, optional) — Total amount of all bills.
  - `PaypointLegalname` (string, optional) — Legal name of the paypoint.
  - `PaypointDbaname` (string, optional) — DBA name of the paypoint.
  - `PaypointEntryname` (string, optional) — Entryname of the paypoint.
  - `ParentOrgName` (string, optional) — The name of the parent organization.
  - `ParentOrgId` (integer, optional) — ID of the parent organization.
  - `CreatedDate` (string, optional) — Date when the vendor record was created.
  - `LastUpdated` (string, optional) — Date when the vendor's information was last updated.
  - `remitAddress1` (string, optional) — Remittance street address. Used for mailing paper checks. Required if any remittance address field is provided. For a PO Box address, include only the PO Box in this field, for example `PO Box 29652`. Put the rest of the address, such as a department number, in `remitAddress2`.
  - `remitAddress2` (string, optional) — Remittance address additional line, such as a suite or unit number. Used for mailing paper checks. Always optional. For a PO Box address, this field holds the part of the address that follows the PO Box, for example `Dept# 880662`.
  - `remitCity` (string, optional) — Remittance address city. Used for mailing paper checks. Required if any remittance address field is provided.
  - `remitState` (string, optional) — Remittance address state or province. Used for mailing paper checks. Required if any remittance address field is provided. Must be a valid US state or Canadian province abbreviation.
  - `remitZip` (string, optional) — Remittance address ZIP or postal code. Used for mailing paper checks. Required if any remittance address field is provided. For US addresses, use five digits or ZIP+4 format.
  - `remitCountry` (string, optional) — Remittance address country. Used for mailing paper checks. Must be `US` or `CA`. Defaults to `US` if not provided.
  - `payeeName1` (string, optional) — Primary name of the payee.
  - `payeeName2` (string, optional) — Secondary name of the payee.
  - `customField1` (string, optional) — A custom field for additional data.
  - `customField2` (string, optional) — Another custom field for extra data.
  - `customerVendorAccount` (string, optional) — Account number of paypoint in the vendor side.
  - `InternalReferenceId` (integer, optional) — Internal reference ID used within the system.
  - `additionalData` (string, optional) — Field for additional data, if any.
  - `externalPaypointID` (string, optional) — A custom identifier for the paypoint, if applicable.
  - `StoredMethods` (string, optional) — Stored payment methods for the vendor.
- `associatedCustomer` (string, optional) — Information about the associated customer, if applicable.
- `ParentOrgName` (string, optional) — Name of the parent organization.
- `PaypointDbaname` (string, optional) — The 'Doing Business As' name of the Paypoint.
- `PaypointLegalname` (string, optional) — The legal name of the Paypoint.
- `PaypointEntryname` (string, optional) — Entry name for the Paypoint, if applicable.
- `externalPaypointID` (string, optional) — A custom identifier for the paypoint, if applicable.
- `paypointId` (integer, optional) — The unique identifier for the paypoint.

## Examples

**Response**

```json
{
  "vcardSent": false,
  "cardToken": "20231206142225226104",
  "cardNumber": "553232XXXXXX3179",
  "cvc": "XXX",
  "expirationDate": "2025-05-01",
  "status": null,
  "amount": 120,
  "currentBalance": 120,
  "expenseLimit": 20,
  "expenseLimitPeriod": null,
  "maxNumberOfUses": 1,
  "currentNumberOfUses": 0,
  "exactAmount": true,
  "mcc": null,
  "tcc": null,
  "misc1": null,
  "misc2": null,
  "dateCreated": "2023-12-06T20:25:31.077",
  "dateModified": "2023-12-06T00:00:00",
  "associatedVendor": {
    "VendorNumber": "VEN-123",
    "Name1": "Smith Industries",
    "Name2": "John Smith",
    "EIN": "12-3456789",
    "Phone": "555-123-4567",
    "Email": "contact@smithindustries.com",
    "RemitEmail": null,
    "Address1": "1234 Main Street",
    "Address2": "Suite 200",
    "City": "New York",
    "State": "NY",
    "Zip": "10001",
    "Country": "USA",
    "Mcc": "5411",
    "LocationCode": null,
    "Contacts": [
      {
        "ContactName": "Herman Martinez",
        "ContactEmail": "herman@hermanscoatings.com",
        "ContactTitle": "Owner",
        "ContactPhone": "3055550000"
      }
    ],
    "BillingData": {
      "id": 123,
      "accountId": null,
      "nickname": "Checking Account",
      "bankName": "Chase Bank",
      "routingAccount": "021000021",
      "accountNumber": "3XXXXXX8888",
      "typeAccount": "Checking",
      "bankAccountHolderName": "Gruzya Adventure Outfitters LLC",
      "bankAccountHolderType": "Business",
      "bankAccountFunction": 0,
      "verified": true,
      "status": 1,
      "services": [],
      "default": true
    },
    "PaymentMethod": "vcard",
    "VendorStatus": 1,
    "VendorId": 456,
    "EnrollmentStatus": null,
    "Summary": {
      "ActiveBills": 1,
      "PendingBills": 1,
      "InTransitBills": 0,
      "PaidBills": 0,
      "OverdueBills": 1,
      "ApprovedBills": 1,
      "DisapprovedBills": 1,
      "TotalBills": 1,
      "ActiveBillsAmount": 1.1,
      "PendingBillsAmount": 100,
      "InTransitBillsAmount": 0,
      "PaidBillsAmount": 0,
      "OverdueBillsAmount": 100,
      "ApprovedBillsAmount": 1.1,
      "DisapprovedBillsAmount": 1.1,
      "TotalBillsAmount": 100
    },
    "PaypointLegalname": "Athlete Factory LLC",
    "PaypointDbaname": "Athlete Factory LLC",
    "PaypointEntryname": "PaypointEntryname",
    "ParentOrgName": "HOA Manager Pro",
    "ParentOrgId": 1232,
    "CreatedDate": "2022-07-01T15:00:01Z",
    "LastUpdated": "2022-07-01T15:00:01Z",
    "remitAddress1": "123 Walnut Street",
    "remitAddress2": "Suite 900",
    "remitCity": "Miami",
    "remitState": "FL",
    "remitZip": "31113",
    "remitCountry": "US",
    "payeeName1": null,
    "payeeName2": null,
    "customField1": "customField1",
    "customField2": "customField2",
    "customerVendorAccount": null,
    "InternalReferenceId": 27,
    "additionalData": null,
    "externalPaypointID": null,
    "StoredMethods": null
  },
  "associatedCustomer": null,
  "ParentOrgName": "HOA Manager Pro",
  "PaypointDbaname": "Athlete Factory LLC",
  "PaypointLegalname": "Athlete Factory LLC",
  "PaypointEntryname": "47acde49",
  "externalPaypointID": null,
  "paypointId": 3040
}
```

**SDK Code**

```typescript
import { PayabliClient } from "@payabli/sdk-node";

async function main() {
    const client = new PayabliClient({
        clientId: "YOUR_CLIENT_ID",
        clientSecret: "YOUR_CLIENT_SECRET",
    });
    await client.moneyOut.vCardGet("20230403315245421165");
}
main();

```

```python
from payabli import payabli

client = payabli(
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)

client.money_out.v_card_get(
    card_token="20230403315245421165",
)

```

```java
package com.example.usage;

import io.github.payabli.api.PayabliApiClient;

public class Example {
    public static void main(String[] args) {
        PayabliApiClient client = PayabliApiClient.withCredentials("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET")
            .build()
        ;

        client.moneyOut().vCardGet("20230403315245421165");
    }
}
```

```ruby
require "payabli"

client = Payabli::Client.new(api_key: "YOUR_API_KEY_HERE")

client.money_out.v_card_get(card_token: "20230403315245421165")

```

```csharp
using PayabliApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new PayabliApiClient(
            clientId: "YOUR_CLIENT_ID",
            clientSecret: "YOUR_CLIENT_SECRET"
        );

        await client.MoneyOut.VCardGetAsync(
            "20230403315245421165"
        );
    }

}

```

```go
package example

import (
    context "context"

    client "github.com/payabli/sdk-go/client"
    option "github.com/payabli/sdk-go/option"
)

func do() {
    client := client.NewClient(
        option.WithClientCredentials(
            "YOUR_CLIENT_ID",
            "YOUR_CLIENT_SECRET",
        ),
    )
    client.MoneyOut.VCardGet(
        context.TODO(),
        "20230403315245421165",
    )
}

```

```php
<?php

namespace Example;

use Payabli\PayabliClient;

$client = new PayabliClient(
    clientId: 'YOUR_CLIENT_ID',
    clientSecret: 'YOUR_CLIENT_SECRET',
);
$client->moneyOut->vCardGet(
    '20230403315245421165',
);

```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

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()
```