Balance cards

Get all balance cards belonging to the program membership

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

program_membership_idstringRequired

The ID of the program membership.

Responses

200

Successful response

application/json

get

/v2/program-memberships/{program_membership_id}/balance-cards

HTTPcURLJavaScriptPython

GET /partner-api/v2/program-memberships/{program_membership_id}/balance-cards HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

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

Create a program membership balance card with an initial balance.

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

program_membership_idstringRequired

The ID of the program membership.

Body

application/x-www-form-urlencoded

nicknamestringOptional

The nickname of the balance card.

Responses

200

Successful response

application/json

post

/v2/program-memberships/{program_membership_id}/balance-cards

HTTPcURLJavaScriptPython

POST /partner-api/v2/program-memberships/{program_membership_id}/balance-cards HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 19

"nickname='text'"

200

Successful response

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

Get a balance card by ID

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

balance_card_idstringRequired

The ID of the balance card.

program_membership_idstringRequired

The ID of the program membership.

Responses

200

Successful response

application/json

get

/v2/program-memberships/{program_membership_id}/balance-cards/{balance_card_id}

HTTPcURLJavaScriptPython

GET /partner-api/v2/program-memberships/{program_membership_id}/balance-cards/{balance_card_id} HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

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