Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

WalletTransactions

The get wallet transactions response contains list of wallet transactions for the specified wallet id.

wallet_transactionsobject<WalletTransaction>[]Optional

The list of wallet transactions for the specified wallet id

WalletTransaction properties

12 properties

wallet_transaction_idstringOptional

Unique identifier for the wallet transaction

wallet_idstring<WalletId>Optional

Unique identifier for the wallet

payment_statusenum<WalletTransactionPaymentStatus>Optional

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

Value in"PENDING" | "SETTLED" | "FAILED"

sourceenum<WalletTransactionSource>Optional

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

Value in"MANUAL" | "INTERVAL" | "THRESHOLD"

transaction_statusenum<WalletTransactionTransactionStatus>Optional

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

Value in"PURCHASED" | "GRANTED" | "VOIDED" | "INVOICED"

transaction_typeenum<WalletTransactionType>Optional

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

Value in"INBOUND" | "OUTBOUND"

amountobject<Amount>Optional

Transaction amount involved in the specific wallet transaction.

Amount properties

2 properties

valuenumberRequired

The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).

Default0FormatdecimalRange0 <= value <= ∞

currency_codestring<Currency>Required

Currency code in ISO 4217 format.

Match^[A-Z]{3}$Length3 <= length <= 3

creditsstringOptional

The number of credits used in the wallet transaction.

Match^[0-9]+.?[0-9]*$

settled_atstring<DateTimeWithZone>Optional

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

Formatdate-time

failed_atstring<DateTimeWithZone>Optional

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

Formatdate-time

created_atstring<DateTimeWithZone>Optional

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

Formatdate-time

metadataobject<StringMap>[]Optional

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

StringMap properties

2 properties

keystringOptional

Name of the key

valuestringOptional

Value associated with the key

metaobject<PaginationMetadata>Optional

PaginationMetadata properties

5 properties

total_countintegerOptional

total_pagesintegerOptional

current_pageintegerOptional

next_pageintegerOptional

Next page.

prev_pageintegerOptional

Previous page.

Back to top

WalletTransactions

The get wallet transactions response contains list of wallet transactions for the specified wallet id.

wallet_transactionsobject<WalletTransaction>[]Optional

The list of wallet transactions for the specified wallet id

WalletTransaction properties

12 properties

wallet_transaction_idstringOptional

Unique identifier for the wallet transaction

wallet_idstring<WalletId>Optional

Unique identifier for the wallet

payment_statusenum<WalletTransactionPaymentStatus>Optional

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

Value in"PENDING" | "SETTLED" | "FAILED"

sourceenum<WalletTransactionSource>Optional

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

Value in"MANUAL" | "INTERVAL" | "THRESHOLD"

transaction_statusenum<WalletTransactionTransactionStatus>Optional

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

Value in"PURCHASED" | "GRANTED" | "VOIDED" | "INVOICED"

transaction_typeenum<WalletTransactionType>Optional

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

Value in"INBOUND" | "OUTBOUND"

amountobject<Amount>Optional

Transaction amount involved in the specific wallet transaction.

Amount properties

2 properties

valuenumberRequired

The amount value in the corresponding currency unit (e.g., two decimals for USD, no decimals for JPY).

Default0FormatdecimalRange0 <= value <= ∞

currency_codestring<Currency>Required

Currency code in ISO 4217 format.

Match^[A-Z]{3}$Length3 <= length <= 3

creditsstringOptional

The number of credits used in the wallet transaction.

Match^[0-9]+.?[0-9]*$

settled_atstring<DateTimeWithZone>Optional

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

Formatdate-time

failed_atstring<DateTimeWithZone>Optional

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

Formatdate-time

created_atstring<DateTimeWithZone>Optional

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

Formatdate-time

metadataobject<StringMap>[]Optional

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

StringMap properties

2 properties

keystringOptional

Name of the key

valuestringOptional

Value associated with the key

metaobject<PaginationMetadata>Optional

PaginationMetadata properties

5 properties

total_countintegerOptional

total_pagesintegerOptional

current_pageintegerOptional

next_pageintegerOptional

Next page.

prev_pageintegerOptional

Previous page.

WalletTransactions

WalletTransaction properties

Amount properties

StringMap properties

PaginationMetadata properties

Back to top

On this page

On this page

WalletTransactions

WalletTransaction properties

Amount properties

StringMap properties

PaginationMetadata properties

Back to top

On this page

WalletTransactions

WalletTransaction properties

Amount properties

StringMap properties

PaginationMetadata properties

Back to top

On this page

On this page

If you accept cookies, we'll use them to improve and customise your experience and enable our partners to show you personalised PayPal ads when you visit other sites. Manage cookies and learn more

WalletTransactions

WalletTransaction properties

Amount properties

StringMap properties

PaginationMetadata properties

Back to top

On this page