Skip to main content

Recipe 5: Cashout

Required​

Complete Recipe 0: Account preflight + encryption first.

Session Token Context​

For cashout, run account status/minting against the PW wallet user sending funds out. The session_token_enc must map to the debit_party PW user.

Flow​

  1. Quote the payout amount with session_token_enc
  2. Execute transaction with transaction_type: "cashout"
  3. Poll transaction state with transaction_id_enc

POST /institution/quote body​

{
  "session_token_enc": "<encrypted_base64>",
  "request_amount": "80.00",
  "request_currency": "USD",
  "institution_name": "DemoBank",
  "debit_party": [
    { "key": "msisdn", "value": "15550001011" }
  ],
  "credit_party": [
    { "key": "bank_account", "value": "0000001234" }
  ]
}

POST /institution/transaction body​

{
  "session_token_enc": "<encrypted_base64>",
  "transaction_id": "TXN-CASHOUT-20260213-0001",
  "transaction_date": "2026-02-13T18:40:00.000Z",
  "amount": "80.00",
  "sender_currency": "USD",
  "sender_amount": "80.00",
  "description": "Wallet cashout",
  "transaction_type": "cashout",
  "fees": [
    { "fee_type": "service_fee", "fee_amount": "1.00", "fee_currency": "USD" }
  ],
  "debit_party": [
    { "key": "msisdn", "value": "15550001011" }
  ],
  "credit_party": [
    { "key": "bank_account", "value": "0000001234" }
  ],
  "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>"
}