Deposit

Deposit amount to a program membership balance card.

post

Authorizations

ApiKeyAuth

Path parameters

program_membership_idstringRequired

The ID of the program membership.

Body

application/x-www-form-urlencoded

deposit_amount_in_centsnumberRequired

The amount to be deposited into the membership balance card.

idempotency_keystringRequired

Idempotency key to prevent duplicate transactions.

balance_card_idstringRequired

The ID of the membership balance card to deposit into.

payment_providerstringOptional

The provider used to process balance payment.

Responses

200

Successful response

application/json

post

HTTPcURLJavaScriptPython

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

"deposit_amount_in_cents=1&idempotency_key='text'&balance_card_id='text'&payment_provider='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
  }
}