Balance cards

Get all balance cards belonging to the program membership

GET/partner-api/v2/program-memberships/{program_membership_id}/balance-cards

Path parameters

program_membership_id*string

The ID of the program membership.

Response

200

Successful response

Body

*/*

balance_cards*array of object

Request

JavaScriptCurlPython

const response = await fetch('/partner-api/v2/program-memberships/{program_membership_id}/balance-cards', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Create a program membership balance card with an initial balance.

POST/partner-api/v2/program-memberships/{program_membership_id}/balance-cards

Path parameters

program_membership_id*string

The ID of the program membership.

Body

multipart/form-data

nicknamestring

The nickname of the balance card.

Response

200

Successful response

Body

*/*

transaction*object

Request

JavaScriptCurlPython

const response = await fetch('/partner-api/v2/program-memberships/{program_membership_id}/balance-cards', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

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

Get a balance card by ID

GET/partner-api/v2/program-memberships/{program_membership_id}/balance-cards/{balance_card_id}

Path parameters

balance_card_id*string

The ID of the balance card.

program_membership_id*string

The ID of the program membership.

Response

200

Successful response

Body

*/*

balance_card*object

Request

JavaScriptCurlPython

const response = await fetch('/partner-api/v2/program-memberships/{program_membership_id}/balance-cards/{balance_card_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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