Create institution transaction

Posts transaction details to institution endpoint.

Endpoint

POST /institution/transaction

Query Parameters

• version (string, required) - API contract version. Use exactly 2024-10-01.
• diagnostics (boolean, optional) - Non-production docs only. Set true to include extra diagnostic metadata (for example observed_client_ip).

Header Parameters

• PW-subscription-key (string, required)
• PW-origin-country (string, required)
• PW-request-date (string, required)
• PW-ip-address (string, required)
• User-Agent (string, required)

Request Body

{
  "session_token": "ENCRYPTED_TOKEN_SAMPLE",
  "transaction_id": "TXN-123",
  "transaction_date": "2024-10-01T00:00:00.000Z",
  "amount": "50.00",
  "sender_currency": "USD",
  "sender_amount": "50.00",
  "description": "Test payout",
  "transaction_type": "inttransfer"
}

Full request body examples (by transaction_type)

Show full request payloads by transaction type

p2p

{
  "session_token_enc": "<encrypted_base64>",
  "transaction_id": "TXN-P2P-20260213-0001",
  "transaction_date": "2026-02-13T18:25:00.000Z",
  "amount": "25.00",
  "sender_currency": "TTD",
  "sender_amount": "25.00",
  "description": "P2P wallet transfer",
  "transaction_type": "p2p",
  "fees": [
    { "fee_type": "service_fee", "fee_amount": "0.00", "fee_currency": "USD" }
  ],
  "debit_party": [
    { "key": "msisdn", "value": "15550001011" }
  ],
  "credit_party": [
    { "key": "msisdn", "value": "15550001012" }
  ],
  "sender_kyc": {
    "full_name": "Casey Example",
    "country": "US"
  },
  "recipient_kyc": {
    "full_name": "Jordan Example",
    "country": "US"
  }
}

inttransfer

{
  "session_token_enc": "<encrypted_base64>",
  "transaction_id": "TXN-INT-20260213-0001",
  "transaction_date": "2026-02-13T18:30:00.000Z",
  "amount": "300.00",
  "sender_currency": "USD",
  "sender_amount": "300.00",
  "description": "Remittance transfer",
  "transaction_type": "inttransfer",
  "fees": [
    { "fee_type": "service_fee", "fee_amount": "3.50", "fee_currency": "USD" }
  ],
  "debit_party": [
    { "key": "msisdn", "value": "15550001011" }
  ],
  "credit_party": [
    { "key": "bank_account", "value": "0000001234" },
    { "key": "bank_code", "value": "DEMOUS33" }
  ],
  "sender_kyc": {
    "full_name": "Casey Example",
    "country": "US"
  },
  "recipient_kyc": {
    "full_name": "Riley Example",
    "country": "MX"
  },
  "transfer_information": {
    "purpose": "family_support",
    "source_of_funds": "salary"
  }
}

deposit

{
  "session_token_enc": "<encrypted_base64>",
  "transaction_id": "TXN-DEP-20260213-0001",
  "transaction_date": "2026-02-13T18:35:00.000Z",
  "amount": "100.00",
  "sender_currency": "TTD",
  "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"
  }
}

cashout

{
  "session_token_enc": "<encrypted_base64>",
  "transaction_id": "TXN-CASHOUT-20260213-0001",
  "transaction_date": "2026-02-13T18:40:00.000Z",
  "amount": "80.00",
  "sender_currency": "TTD",
  "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"
  }
}

Responses

200 - Wrapper-normalized response envelope (success cases).

Example: success

{
  "status": "success",
  "code": 200,
  "message": "Amount Debited",
  "request_id": "90919ed3-102c-46a4-b62e-5b9dcdff14e4",
  "timestamp": "2026-02-13T18:17:24.774Z",
  "institution_receipt_id": "PWPP-VZ835U"
}

400 - Wrapper-normalized response envelope (400)

Example: error

{
  "status": "error",
  "code": 400,
  "message": "session_token is required",
  "request_id": "d542bbc7-3f89-44cf-a297-0a4b82e3e19f",
  "timestamp": "2026-02-11T03:59:45.869Z",
  "observed_client_ip": {
    "request_ip": "172.64.80.1",
    "socket_remote_address": "172.64.80.1"
  }
}

Notes

This endpoint page is generated from openapi/pw-wrappers.2024-10-01.yaml.