Get card information

GET /api/Card

Use this call to receive card information. You can add query parameters to narrow down the search results.

Query parameters

ParameterDescription
dateAddedFrom
DateTime
Date cards were added from (for the beginning of a date range query).
dateAddedTo
DateTime
Date cards were added until (for the end of a date range query).
sourceSenderId
string
Merchant ID.
firstName
string
Cardholder first name.
lastName
string
Cardholder last name.
isActive
boolean
True if the card is active, otherwise false.
cardCompany
string
Card network.
- Visa
- Mastercard
- ET
- PULSE
- STAR
- NYCE
- Accel
- RPPS
- MoneySend

Sample request GET /api/Card

curl --location --request 
GET 'https://pushtopaystaging.crbnj.net/api/card/'
--header 'Accept: application/json'
--header 'Authorization: <Bearer Token>' https://pushtopaystaging.crbnj.net/api/Card'

Response attributes

AttributeDescription
requestId
GUID
Unique customer generated identifier.
cardToken
string
Token for the signed-up debit card.
firstName
string
First name.
lastName
string
Last name.
ownerExternalId
string
4 digit code merchant assigns.
address1
string
Address line 1.
address2
string
Address line 2.
city
string
City.
state
string
2-letter State.
zipCode
string
Zip code.
isAuthorizationSucceeded
*boolean**
True if the card was authorized, otherwise false.
countryCode
string
2-letter country code.
phoneNumber
string
Phone number. No dashes required.
email
string
Email address.
expirationYear
string
2-digits only. Must be a future year.
expirationMonth
string
2-digits for the expiration month.
last4Digits
string
Last 4-digits of the card number.
cardCompany
string
Card network.
- Visa
- Mastercard
- ET
- PULSE
- STAR
- NYCE
- Accel
- RPPS
- MoneySend
isActive
boolean
True if the card is active, otherwise false.
deactivatedAt
string
Date and time the card was deactivated.
addedOn
string
Date and time the card was added.
authorizationJson
string
The JSON authorization response received for this card.
isFastFundsSupported
boolean
Fast funds are immediate payments.
True if fast funds is supported, otherwise false.
rail
string
The processor used to perform the transaction
- RS2
- McSend
- TabaPay
pushEnabled
boolean
True if push transactions are enabled for this card, otherwise false.
pullEnabled
boolean
True if pull transactions are enabled for this card, otherwise false.
issuerCountryCode
string
2 or 3 digit Country-code for the card issuer. Can include all characters.
binNumber
string
The first set of numbers on a credit card that identifies the card issuer.

Sample response GET /api/Card

{
  "results": [
    {
      "requestId": "24jla71k-fjl1-08m8-bks7-naxk8773bxr4",
      "cardToken": "6LZY7L7225xkG073M61S0LDKXRU1QBQXYS1j2ba",
      "firstName": "Corey",
      "lastName": "Hendley",
      "ownerExternalId": "1466",
      "address1": "912 Joshua Estates",
      "address2": "null",
      "city": "Patrick Springs",
      "zipCode": "24133",
      "isAuthorizationSucceeded": true,
      "state": "VA",
      "countryCode": "US",
      "phoneNumber": "2145723854",
      "email": "[email protected]",
      "expirationYear": "28",
      "expirationMonth": "05",
      "last4Digits": "2761",
      "cardCompany": "Visa",
      "isActive": true,
      "deactivatedAt": "2022-07-11T11:00:36.290Z",
      "addedOn": "2022-07-11T11:00:36.290Z",
      "authorizationJson": "string",
      "isFastFundsSupported": true,
      "rail": "RS2",
      "pushEnabled": true,
      "pullEnabled": true,
      "issuerCountryCode": "string",
      "binNumber": "string"
    }
}