Get Cards

Get Cards

curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/cards \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://qa-lynx.nayax.com/operational/v1/cards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://qa-lynx.nayax.com/operational/v1/cards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://qa-lynx.nayax.com/operational/v1/cards"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://qa-lynx.nayax.com/operational/v1/cards")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

[
  {
    "CardDetails": {
      "CardID": 123,
      "ActorID": 123,
      "CardUniqueIdentifier": "<string>",
      "CardDisplayNumber": "<string>",
      "CardTypeID": 123,
      "PhysicalTypeID": 123,
      "Notes": "<string>",
      "Status": 123,
      "ExternalApplicationUserID": "<string>",
      "CreatedBy": 123,
      "CreatedDT": "2023-11-07T05:31:56Z",
      "UpdatedBy": 123,
      "UpdatedDT": "2023-11-07T05:31:56Z"
    },
    "CardHolderDetails": {
      "CardHolderName": "<string>",
      "UserIdentity": "<string>",
      "CountryID": 123,
      "MobileNumber": "<string>",
      "Email": "<string>",
      "MemberTypeID": 123,
      "ImageUrl": "<string>"
    },
    "CardCreditAttributes": {
      "CurrencyID": 123,
      "Credit": 123,
      "RevalueCredit": 123,
      "CreditTypeMoneyBit": true,
      "CreditAccumulateBit": true,
      "CreditSingleUseBit": true,
      "RevalueCashBit": true,
      "RevalueCreditCardBit": true,
      "AmountMonthlyReload": 123,
      "TransactionsMonthlyReload": 123,
      "DiscountTypeBit": 123,
      "DiscountValue": 123
    },
    "CardCreditLimits": {
      "AmountDailyLimit": 123,
      "AmountWeeklyLimit": 123,
      "TransactionsDailyLimit": 123,
      "TransactionsWeeklyLimit": 123,
      "AmountMonthlyLimit": 123,
      "TransactionsMonthlyLimit": 123,
      "DiscountTransactionsTotalLimit": 123,
      "MaxRevalueAmountLimit": 123,
      "WeekDayLimitEnabledBit": true,
      "WeekDayAmountLimit": "<string>",
      "WeekDayTransactionLimit": "<string>"
    },
    "CardDateRules": {
      "ActivationDate": "2023-11-07T05:31:56Z",
      "ExpirationDate": "2023-11-07T05:31:56Z",
      "RevalueExpirationDate": "2023-11-07T05:31:56Z",
      "SetSingleUseDate": "2023-11-07T05:31:56Z",
      "RemoveSingleUseDate": "2023-11-07T05:31:56Z"
    },
    "CardCreditUsage": {
      "AmountDailyUsage": 123,
      "AmountWeeklyUsage": 123,
      "TransactionsDailyUsage": 123,
      "TransactionsWeeklyUsage": 123,
      "AmountMonthlyUsage": 123,
      "TransactionsMonthlyUsage": 123,
      "AmountTotalUsage": 123,
      "TransactionsTotalUsage": 123,
      "AmountCapture": 123,
      "TransactionsCapture": 123,
      "CaptureDate": "2023-11-07T05:31:56Z"
    },
    "CardRevalueRewardRules": [
      {
        "RuleID": 123,
        "RewardActorID": 123,
        "Status": true,
        "RevalueAmount": 123,
        "RewardValueTypeBit": true,
        "RewardValue": 123,
        "UpdatedDT": "2023-11-07T05:31:56Z",
        "UpdatedBy": 123
      }
    ],
    "GroupLocationLimits": [
      {
        "CardGroupEnabledBit": true,
        "GroupName": "<string>",
        "CardGroupId": 123,
        "GroupDailyLimit": 123,
        "UpdatedBy": 123,
        "LastUpdated": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

Get Cards

curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/cards \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://qa-lynx.nayax.com/operational/v1/cards', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://qa-lynx.nayax.com/operational/v1/cards",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://qa-lynx.nayax.com/operational/v1/cards"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://qa-lynx.nayax.com/operational/v1/cards")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

[
  {
    "CardDetails": {
      "CardID": 123,
      "ActorID": 123,
      "CardUniqueIdentifier": "<string>",
      "CardDisplayNumber": "<string>",
      "CardTypeID": 123,
      "PhysicalTypeID": 123,
      "Notes": "<string>",
      "Status": 123,
      "ExternalApplicationUserID": "<string>",
      "CreatedBy": 123,
      "CreatedDT": "2023-11-07T05:31:56Z",
      "UpdatedBy": 123,
      "UpdatedDT": "2023-11-07T05:31:56Z"
    },
    "CardHolderDetails": {
      "CardHolderName": "<string>",
      "UserIdentity": "<string>",
      "CountryID": 123,
      "MobileNumber": "<string>",
      "Email": "<string>",
      "MemberTypeID": 123,
      "ImageUrl": "<string>"
    },
    "CardCreditAttributes": {
      "CurrencyID": 123,
      "Credit": 123,
      "RevalueCredit": 123,
      "CreditTypeMoneyBit": true,
      "CreditAccumulateBit": true,
      "CreditSingleUseBit": true,
      "RevalueCashBit": true,
      "RevalueCreditCardBit": true,
      "AmountMonthlyReload": 123,
      "TransactionsMonthlyReload": 123,
      "DiscountTypeBit": 123,
      "DiscountValue": 123
    },
    "CardCreditLimits": {
      "AmountDailyLimit": 123,
      "AmountWeeklyLimit": 123,
      "TransactionsDailyLimit": 123,
      "TransactionsWeeklyLimit": 123,
      "AmountMonthlyLimit": 123,
      "TransactionsMonthlyLimit": 123,
      "DiscountTransactionsTotalLimit": 123,
      "MaxRevalueAmountLimit": 123,
      "WeekDayLimitEnabledBit": true,
      "WeekDayAmountLimit": "<string>",
      "WeekDayTransactionLimit": "<string>"
    },
    "CardDateRules": {
      "ActivationDate": "2023-11-07T05:31:56Z",
      "ExpirationDate": "2023-11-07T05:31:56Z",
      "RevalueExpirationDate": "2023-11-07T05:31:56Z",
      "SetSingleUseDate": "2023-11-07T05:31:56Z",
      "RemoveSingleUseDate": "2023-11-07T05:31:56Z"
    },
    "CardCreditUsage": {
      "AmountDailyUsage": 123,
      "AmountWeeklyUsage": 123,
      "TransactionsDailyUsage": 123,
      "TransactionsWeeklyUsage": 123,
      "AmountMonthlyUsage": 123,
      "TransactionsMonthlyUsage": 123,
      "AmountTotalUsage": 123,
      "TransactionsTotalUsage": 123,
      "AmountCapture": 123,
      "TransactionsCapture": 123,
      "CaptureDate": "2023-11-07T05:31:56Z"
    },
    "CardRevalueRewardRules": [
      {
        "RuleID": 123,
        "RewardActorID": 123,
        "Status": true,
        "RevalueAmount": 123,
        "RewardValueTypeBit": true,
        "RewardValue": 123,
        "UpdatedDT": "2023-11-07T05:31:56Z",
        "UpdatedBy": 123
      }
    ],
    "GroupLocationLimits": [
      {
        "CardGroupEnabledBit": true,
        "GroupName": "<string>",
        "CardGroupId": 123,
        "GroupDailyLimit": 123,
        "UpdatedBy": 123,
        "LastUpdated": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

Authorizations

Authorization

string

header

required

Enter your Bearer token. It's required to authenticate API requests.

Query Parameters

CardID

integer<int64>

The unique identifier of the card.

CardUniqueIdentifier

string

The unique identifier assigned to the card.

CardDisplayNumber

string

The display number of the card.

CardMobileNumber

string

The mobile number associated with the card.

ExternalApplicationUserID

string

The external application user ID associated with the card.

CardEmail

string

The email address associated with the card.

CardHolderName

string

The name of the cardholder.

Response

200 - application/json

Card details retrieved successfully.

CardDetails

object

Detailed information about the card.

Show child attributes

CardHolderDetails

object

Information about the cardholder.

Show child attributes

CardCreditAttributes

object

Credit attributes associated with the card.

Show child attributes

CardCreditLimits

object

Credit limits associated with the card.

Show child attributes

CardDateRules

object

Date-related rules applied to the card.

Show child attributes

CardCreditUsage

object

Information on the credit usage of the card.

Show child attributes

CardRevalueRewardRules

object[] | null

A list of revalue reward rules associated with the card.

Show child attributes

GroupLocationLimits

object[] | null

A list of location limits associated with the card's group.

Show child attributes

Lynx API Guides

API Reference

Authorizations

Query Parameters

Response