Card

A card: list a profile's cards, get one, update its status or permissions, or reset its PIN count.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

cards, err := client.Card(nil).List(map[string]any{"profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(cards)
card, err := client.Card(nil).Load(map[string]any{"id": "example_id", "profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(card)
created, err := client.Card(nil).Create(map[string]any{"card_token": "example", "profile_id": 1}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)

Lua

Construct client as shown in the Lua setup, then call the operations:

local cards, err = client:Card():list({ profile_id = 1 })
local card, err = client:Card():load({ id = "example_id", profile_id = 1 })
local created, err = client:Card():create({ card_token = "example", profile_id = 1 })

PHP

Construct client as shown in the PHP setup, then call the operations:

$cards = $client->Card()->list(["profile_id" => 1]);
$card = $client->Card()->load(["id" => "example_id", "profile_id" => 1]);
$created = $client->Card()->create(["card_token" => "example", "profile_id" => 1]);

Python

Construct client as shown in the Python setup, then call the operations:

cards = client.Card().list({"profile_id": 1})
card = client.Card().load({"id": "example_id", "profile_id": 1})
created = client.Card().create({ "card_token": "example", "profile_id": 1 })

Ruby

Construct client as shown in the Ruby setup, then call the operations:

cards = client.Card.list({ "profile_id" => 1 })
card = client.Card.load({ "id" => "example_id", "profile_id" => 1 })
created = client.Card.create({ "card_token" => "example", "profile_id" => 1 })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const cards = await client.Card().list({ profile_id: 1 })
const card = await client.Card().load({ id: "example_id", profile_id: 1 })
const created = await client.Card().create({ card_token: "example", profile_id: 1 })

Fields

create

POST /spend/profiles/{profileId}/cards/{cardToken}/reset-pin-count

Operation ID: cardPinCountReset.

Authentication: bearer token (UserToken).

Parameters

Responses

200: PIN count reset successfully

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

list

GET /spend/profiles/{profileId}/cards/{cardToken}/spending-permissions

Operation ID: cardPermissionsGet.

Authentication: bearer token (UserToken).

Parameters

Responses

200: Card permissions retrieved successfully

application/json

Example response:

{
  "permissions": [
    {
      "isEnabled": false,
      "isLocked": false,
      "type": "ECOM"
    },
    {
      "isEnabled": true,
      "isLocked": false,
      "type": "POS_CHIP"
    },
    {
      "isEnabled": false,
      "isLocked": false,
      "type": "ATM_WITHDRAWAL"
    },
    {
      "isEnabled": true,
      "isLocked": false,
      "type": "MOBILE_WALLETS"
    },
    {
      "isEnabled": false,
      "isLocked": true,
      "type": "POS_CONTACTLESS"
    },
    {
      "isEnabled": false,
      "isLocked": true,
      "type": "POS_MAGSTRIPE"
    }
  ]
}

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

GET /spend/profiles/{profileId}/cards

Operation ID: cardList.

Authentication: bearer token (UserToken).

Parameters

Responses

200: List of cards retrieved successfully

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

load

GET /spend/profiles/{profileId}/cards/{cardToken}

Operation ID: cardGet.

Authentication: bearer token (UserToken).

Parameters

Responses

200: Card details retrieved successfully

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

update

PATCH /spend/profiles/{profileId}/cards/{cardToken}/spending-permissions

Operation ID: cardPermissionsBulkUpdate.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Example request body:

{
  "permissions": [
    {
      "isEnabled": true,
      "type": "ECOM"
    },
    {
      "isEnabled": true,
      "type": "POS_CHIP"
    }
  ]
}

Responses

200: Permissions updated successfully

400: Bad request. The requested permission type is not recognized. No permissions are updated.

application/json

422: Unprocessable entity. The request is syntactically valid but cannot be fulfilled because a requested permission is not supported by this card type, or the permission is locked and cannot be changed. No permissions are updated.

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.

PUT /spend/profiles/{profileId}/cards/{cardToken}/status

Operation ID: cardStatusUpdate.

Authentication: bearer token (UserToken).

Parameters

Request body

application/json

Example request body:

{
  "status": "ACTIVE"
}

Responses

200: Card status updated successfully

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.