🇬🇧
Yativo Documentation
Spanish
English
English
  • Yativo
  • Introduction to Yativo
    • Financial Infrastructure
    • About Us
  • Dashboard
  • Business Plans
  • Getting Started with Yativo API
  • Yativo API Glossary
  • API reference
    • Misc.
      • Countries
      • States
      • City
  • Security and Authentication
    • Security
    • Authentication
    • Idempotency in API Requests
  • Environment
    • Environments
  • Notifications
    • Webhook
  • Compliance
    • Verification
      • KYC
      • KYB
      • KYC/KYB Update
      • KYC Status
      • Global Business Search
    • Supported Jurisdiction
    • Supported Countries, Currencies and Payment Method
  • User Management
    • Customer
      • Get Customers
      • Retrieve customer
      • Add Customer
  • Payments
    • Currencies
    • Crypto Wallets
      • Generate Wallet Address
      • Fetch Wallet Address
      • Crypto Deposit History
      • Single crypto deposit history
    • Payout
      • Payout
      • Get Payouts
      • Get Payout
      • Beneficiaries
        • Get Beneficiaries
        • Add Beneficiary Payment Details
        • Update Beneficiary
        • Archive Beneficiary
        • Add Beneficiary
    • Payin
    • Virtual Cards
      • Supported Currency, Country
      • Create card
      • Fetch card
      • Top up card
      • Get Transactions
      • Freeze and Unfreeze Card
    • Virtual Accounts
      • Create VIrtual Accounts
        • USD Virtual Account
        • Mexico Virtual Account
        • Brazil PIX QR
      • Virtual Account Management
      • Transaction History
  • Foreign Exchange
    • Exchange Rate
      • Request Quote
  • Transactions
    • Transaction Summary
    • Get Single Transaction
  • Crypto System
    • Yativo Crypto Platform API
Powered by GitBook
On this page
  1. Payments
  2. Virtual Cards

Fetch card

PreviousCreate cardNextTop up card

Last updated 2 months ago

POST {{baseUrl}}/customer/virtual/cards/get/{{card_id}}

Description

This endpoint retrieves the details of a specific virtual card using the card's unique identifier.

Headers

No specific headers are required for this endpoint, but typically, you might need to include authorization tokens or other headers as per your API's authentication requirements.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Response

The response will include the status of the request, relevant message, and details of the virtual card if the request is successful. If the request is invalid, an error message will be returned.

Fields in Response

  • status: Indicates the success status of the request (e.g., "success").

  • status_code: HTTP status code of the response (e.g., 200 for success).

  • message: A message describing the result of the request (e.g., "Request successful").

  • data: Contains the details of the virtual card if the request is successful.

    • id: Unique identifier of the virtual card.

    • balance: Current balance of the virtual card.

    • cardNumber: Full number of the virtual card.

    • last4: Last four digits of the card number.

    • cardName: Name on the virtual card.

    • cardType: Type of the card (e.g., "virtual").

    • cardBrand: Brand of the card (e.g., "visa").

    • cvv2: CVV2 code of the virtual card.

    • expiry: Expiry date and time of the card in ISO 8601 format.

    • valid: Validity of the card in MM/YYYY format.

    • billingAddress: Billing address associated with the virtual card.

      • city: City of the billing address.

      • state: State of the billing address.

      • street: Street address.

      • country: Country of the billing address.

      • zipCode: Postal code of the billing address.

      • countryCode: Country code of the billing address.

{
    "status": "success",
    "status_code": 200,
    "message": "Request successful",
    "data": {
        "id": "8d5b43bb-683b-45b3-9d1d-f64d5d75ee97",
        "balance": 300,
        "cardNumber": "4040381842044628",
        "last4": "4628",
        "cardName": "John Doe",
        "cardType": "virtual",
        "cardBrand": "visa",
        "cvv2": "849",
        "expiry": "2027-05-29T00:00:00",
        "valid": "05/2027",
        "billingAddress": {
            "city": "Miami",
            "state": "Florida",
            "street": "3401 N. Miami, Ave. Ste 230",
            "country": "United States",
            "zipCode": "33127",
            "countryCode": "US"
        }
    }
}
{
    "status": "success",
    "status_code": 200,
    "message": "Request successful",
    "data": {
        "error": "Invalid request"
    }
}

Get Card

get
Authorizations
Responses
200Success
get
GET /api/v1/virtual/get-card/c9aa5757-c22d-48ca-a08b-aebdee325fde HTTP/1.1
Host: smtp.yativo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success

No content

  • Description
  • Headers
  • GETGet Card
  • Response
  • Fields in Response