Skip to main content
GET
/
wallet-transactions
/
{wallet_transaction_id}
Get Wallet transaction by id
curl --request GET \
  --url https://api-m.paypal.com/v1/commerce/billing/wallet-transactions/{wallet_transaction_id} \
  --header 'Authorization: Bearer <token>'
{
  "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": "2022-04-29T08:59:51Z",
  "failed_at": "2022-04-29T08:59:51Z",
  "created_at": "2022-04-29T08:59:51Z",
  "metadata": [
    {
      "key": "reason",
      "value": "balance depleted"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use the /v1/oauth2/token endpoint to obtain an access token and pass it as a Bearer token in the Authorization header.

Path Parameters

​
wallet_transaction_id
string
required

Wallet Transaction ID

Response

Wallet transaction by ID retrieved successfully

​
wallet_transaction_id
string

Unique identifier for the wallet transaction

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

​
wallet_id
string

Unique identifier for the wallet

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

​
payment_status
enum<string>

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

Available options:
PENDING,
SETTLED,
FAILED
Example:

"SETTLED"

​
source
enum<string>

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

Available options:
MANUAL,
INTERVAL,
THRESHOLD
Example:

"MANUAL"

​
transaction_status
enum<string>

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

Available options:
PURCHASED,
GRANTED,
VOIDED,
INVOICED
Example:

"PURCHASED"

​
transaction_type
enum<string>

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

Available options:
INBOUND,
OUTBOUND
Example:

"INBOUND"

​
amount
object

Transaction amount involved in the specific wallet transaction.

​
credits
string

The number of credits used in the wallet transaction.

Example:

"100.0"

​
settled_at
string<date-time>

The date when wallet transaction is settled, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). Date and time in ISO 8601 format.

Example:

"2023-10-01T12:00:00Z"

​
failed_at
string<date-time>

The date when the wallet transaction failed, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). Date and time in ISO 8601 format.

Example:

"2023-10-01T12:00:00Z"

​
created_at
string<date-time>

The date of the wallet transaction creation, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). Date and time in ISO 8601 format.

Example:

"2023-10-01T12:00:00Z"

​
metadata
object[]

List of key-value pair contains the metadata about the wallet transaction.

⌘I