Skip to main content

Recipe 4: Deposit

Required​

Complete Recipe 0: Account preflight + encryption first.

Session Token Context​

For deposit, run account status/minting against the receiving PW user. The session_token_enc must map to the credit_party PW user.

Flow​

  1. Build quote request with session_token_enc
  2. Build transaction payload with transaction_type: "deposit"
  3. Poll status with encrypted transaction_id_enc

POST /institution/quote body​

{
  "session_token_enc": "<encrypted_base64>",
  "request_amount": "100.00",
  "request_currency": "USD",
  "institution_name": "DemoBank",
  "debit_party": [
    { "key": "external_source", "value": "card_ending_4242" }
  ],
  "credit_party": [
    { "key": "msisdn", "value": "15550001011" }
  ]
}

POST /institution/transaction body​

{
  "session_token_enc": "<encrypted_base64>",
  "transaction_id": "TXN-DEP-20260213-0001",
  "transaction_date": "2026-02-13T18:35:00.000Z",
  "amount": "100.00",
  "sender_currency": "USD",
  "sender_amount": "100.00",
  "description": "Wallet deposit",
  "transaction_type": "deposit",
  "fees": [
    { "fee_type": "service_fee", "fee_amount": "0.00", "fee_currency": "USD" }
  ],
  "debit_party": [
    { "key": "external_source", "value": "card_ending_4242" }
  ],
  "credit_party": [
    { "key": "msisdn", "value": "15550001011" }
  ],
  "sender_kyc": {
    "full_name": "Casey Example",
    "country": "US"
  },
  "recipient_kyc": {
    "full_name": "Casey Example",
    "country": "US"
  }
}

GET /institution/transaction request params​

{
  "version": "2024-10-01",
  "institution_name": "DemoBank",
  "transaction_id_enc": "<encrypted_base64>"
}