Balance cards

Get all balance cards belonging to the program membership

get

Authorizations

Path parameters

program_membership_idanyrequired

The ID of the program membership.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v2/program-memberships/{program_membership_id}/balance-cards' \
  --header 'X-API-Key: YOUR_API_KEY'

200

200

{
  "balance_cards": [
    {
      "id": "text",
      "nickname": "text",
      "balance_in_cents": 1,
      "program_membership_id": "text",
      "created_at": 1,
      "updated_at": 1
    }
  ]
}

Successful response

Create a program membership balance card with an initial balance.

post

Authorizations

Path parameters

program_membership_idanyrequired

The ID of the program membership.

Body

nicknamestringoptional

The nickname of the balance card.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v2/program-memberships/{program_membership_id}/balance-cards' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'nickname=text'

200

200

{
  "transaction": {
    "transaction_id": "text",
    "idempotency_key": "text",
    "balance_card_id": "text",
    "transaction_type": "text",
    "deposit_amount_in_cents": 1,
    "available_balance_in_cents": 1
  }
}

Successful response

Get a balance card by ID

get

Authorizations

Path parameters

balance_card_idanyrequired

The ID of the balance card.

program_membership_idanyrequired

The ID of the program membership.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v2/program-memberships/{program_membership_id}/balance-cards/{balance_card_id}' \
  --header 'X-API-Key: YOUR_API_KEY'

200

200

{
  "balance_card": {
    "id": "text",
    "nickname": "text",
    "balance_in_cents": 1,
    "program_membership_id": "text",
    "created_at": 1,
    "updated_at": 1
  }
}

Successful response