Get Card Details

GET 
https://api.immersve.com/api/cards/:cardId

Returns the non-sensitive details of a card by a given ID.

Request

Path Parameters

cardId stringrequired

Primary identifier of the card to fetch

Responses

200

application/json

Schema

Schema

idstringrequired
Card primary identifier
Example: 91ad6fea3b52ca58d60d7fd310f789ec
accountIdstringrequired
User account ID linked to card
Example: 057aa15913a57f50577234c8426534c0
typestringrequired
Type of the card
Possible values: [virtual]
createdAtstringrequired
Timestamp of card creation
Example: 2022-11-16T03:13:18.142Z
modifiedAtstringrequired
Timestamp of card modification
Example: 2022-11-16T03:13:18.142Z
expiresAtstringrequired
Timestamp of card expiration
Example: 2029-02-28T23:59:59.999Z
isBlockedbooleanrequired
Whether the card is blocked
statusstringrequired
Status of the card
Possible values: [active, cancelled, created, shipped]
fundingSourceIdsarrayrequired
List of Funding Source IDs linked to the card
cardProgramIdstringrequired
ID of card program linked to the card
Example: 91ad6fea3b52ca58d60d7fd310f789ec
regionCodestringrequired
An Alpha2 (ISO-3166-1) country code representing the country where the card is issued.
Example: NZ
expirystring
Expiry date of the card in the format YYYYMM
Example: 202409
panFirst6string
First 6 digits of the card's PAN (Primary Account Number)
Example: 123456
panLast4string
Last 4 digits of the card's PAN (Primary Account Number)
Example: 1920
immersveExpirationstring
Deprecated field, use expiresAt
Example: 2022-11-16T03:18:23.431Z
unfreezeAllowedboolean
Indicates whether the card can be unfrozen with the unfreeze endpoint
Example: true

Example (auto)

{
  "id": "91ad6fea3b52ca58d60d7fd310f789ec",
  "accountId": "057aa15913a57f50577234c8426534c0",
  "type": "virtual",
  "createdAt": "2022-11-16T03:13:18.142Z",
  "modifiedAt": "2022-11-16T03:13:18.142Z",
  "expiresAt": "2029-02-28T23:59:59.999Z",
  "isBlocked": true,
  "status": "active",
  "fundingSourceIds": [
    null
  ],
  "cardProgramId": "91ad6fea3b52ca58d60d7fd310f789ec",
  "regionCode": "NZ",
  "expiry": "202409",
  "panFirst6": "123456",
  "panLast4": "1920",
  "immersveExpiration": "2022-11-16T03:18:23.431Z",
  "unfreezeAllowed": true
}

400

Request fields are invalid

application/json

Schema

Schema

statusCodeintegerrequired
Example: 400
statusNamestringrequired
Example: Bad Request
errorCodestringrequired
Example: INVALID_REQUEST_INPUT
errors object[]
Array [
messagestring
Example: Invalid type
pathstring
The location of the invalid path param, query param or payload attribute.
Example: items[1].attributes.invalidField
]

Example (auto)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

403

No Authorization to access resource.

application/json

Schema

Schema

statusCodeintegerrequired
Example: 403
statusNamestringrequired
Example: Forbidden
errorCodestringrequired
Example: FORBIDDEN
reasonstring
Example: Unauthorized

Example (auto)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Authorization: http

name: Access Tokentype: httpscheme: bearerbearerFormat: JWT

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.immersve.com/api/cards/:cardId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.immersve.com

Auth

Security Scheme

Access TokenAccess Token and Target AccountApi Key and Api SecretApi Key and Api Secret and Target Account

Bearer Token

Parameters

cardId — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!