PApaypal
Wallets

Get Wallet transaction by id

get/wallet-transactions/{wallet_transaction_id}

Request

Path parameters

wallet_transaction_idstring required

Wallet Transaction ID

Response

Wallet transaction by ID retrieved successfully

wallet_transaction_idstring

Unique identifier for the wallet transaction

wallet_idstring

Unique identifier for the wallet

payment_status'PENDING' | 'SETTLED' | 'FAILED'

The payment status of the wallet transaction. Possible values are pending, settled or failed.

source'MANUAL' | 'INTERVAL' | 'THRESHOLD'

The source field represents the origin or trigger of the wallet transaction. Possible values are manual, interval. threshold

transaction_status'PURCHASED' | 'GRANTED' | 'VOIDED' | 'INVOICED'

The transaction status of the wallet transaction. Possible values are purchased (with pending or settled status), granted (without invoice_id), voided or invoiced.

transaction_type'INBOUND' | 'OUTBOUND'

The type of transaction. Possible values are inbound (increasing the balance) or outbound (decreasing the balance).

creditsstring

The number of credits used in the wallet transaction.

settled_atstring date-time

Date and time in ISO 8601 format.

failed_atstring date-time

Date and time in ISO 8601 format.

created_atstring date-time

Date and time in ISO 8601 format.

Example response

{
  "wallet_transaction_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "wallet_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "payment_status": "SETTLED",
  "source": "MANUAL",
  "transaction_status": "PURCHASED",
  "transaction_type": "INBOUND",
  "amount": {
    "value": 120.35,
    "currency_code": "USD"
  },
  "credits": "100.0",
  "settled_at": "2023-10-01T12:00:00Z",
  "failed_at": "2023-10-01T12:00:00Z",
  "created_at": "2023-10-01T12:00:00Z",
  "metadata": [
    {
      "key": "reason",
      "value": "balance depleted"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.