TransactionList

List of transactions.

transactions

object[]

Array [

id stringrequired

Transaction id

slipId stringrequired

Transaction slip Id.

customerId stringrequired

Wallet customer id.

accountId stringrequired

Account Id associated with this transaction.

type TransactionType (string)

Possible values: [DEPOSIT, WITHDRAWAL, CHARGEBACK_REVERSAL, RETURNED_WITHDRAWAL, CHARGEBACK, MERCHANT_FEE, TRANSACTION_FEE, DAILY_TRANSACTIONS_FEE, TRANSFER_IN, TRANSFER_OUT, TRANSFER_RETURN, REFUND, CURRENCY_EXCHANGE, PAYSAFE_FEE, PREPAID_CARD, PREPAID_CARD_AUTHORIZATION, APPLICATION_FEE, SET_UP_FEE, MONTHLY_MAINTENANCE_FEE]

Represents the type of the transaction.

amount int64

Transaction amount in minor units.

currencyCode Currency (string)

Possible values: >= 3 characters and <= 3 characters

Currency alphabetic code as specified by ISO 4217

fees

object[]

Customer fees attached to the transaction.

Array [

amount int64required

Default value: 0

Amount of the merchant payment, in mintor units. If currency is not specified, then the main transaction currency is used.

currency Currency (string)

Possible values: >= 3 characters and <= 3 characters

Currency alphabetic code as specified by ISO 4217

paymentReason FeePaymentReason (string)required

Possible values: [MERCHANT_FEE, ATM_FEE, FX_FEE, PAYSAFE_FEE, OTHER_FEE, SENDER_FEE, RECIPIENT_FEE, DEPOSIT_FEE, WITHDRAWAL_FEE]

Default value: OTHER_FEE

Fee payment reason.

SENDER_FEE - Fee that will be applied to sender party of transfer collected into partner merchant wallet.
RECIPIENT_FEE - Fee that will be applied to recipient client of transfer collected into partner merchant wallet.
DEPOSIT_FEE - Fee charged for deposit transactions collected into partner merchant wallet.
WITHDRAWAL_FEE - Fee charged for withdrawal transactions collected into partner merchant wallet.
MERCHANT_FEE - Fee for the payment service collected into partner merchant wallet.
PAYSAFE_FEE - Fee collected by Paysafe for the provided payment service. Usually Paysafe Fee is not directly applied to customer transactions.
ATM_FEE - Fee for ATM service, when using prepaid cards.
FX_FEE - Fee applied, when payment requires currency exchange.
OTHER_FEE - It could be used for any additional, unspecified fees that may be applied to a transaction

]

creationTime date-time

Represents RFC 3339, section 5.6 date-time.

lastChangeDate date-time

Represents RFC 3339, section 5.6 date-time.

direction stringrequired

Possible values: [CREDIT, DEBIT]

Transaction direction.

paymentType PaymentType (string)

Possible values: [CARD, BANK_TRANSFER, RAPID_TRANSFER, TRANSFER]

Type of instrument. Used as discriminator for different Payment types.

CARD
BANK_TRANSFER
RAPID_TRANSFER
TRANSFER

status TransactionStatus (string)required

Possible values: [PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED, REFUNDED, DECLINED]

Represents the status of a transaction.

PENDING - Transaction is created and further action is required by the customer.
PROCESSING - Transaction is scheduled for processing by the payment provider.
COMPLETED - Transaction is completed. Note that some transactions might be completed from Embedded Wallet point of view, but not from customer point of view, since money movement might take some time outside of the Embedded Wallet network.
FAILED - Transaction is failed. Check STATUS_REASON property for details.
CANCELLED - Transaction have been cancelled
REFUNDED - Valid only for deposit transactions.
DECLINED - transaction is declined.

statusReason string

Possible values: <= 60 characters

Status reason for FAILED transactions. See TransactionStatusReason for available values.

merchantRefNum ExternalId (string)

Possible values: non-empty and <= 40 characters

Customer identifier used in Partner system.

balance int64

Balance of the account after the transaction in minor currency units.

recipientReference string

Additional reference information for the recipient passed by the sender of the transaction. This information is not valid or present for all transaction types.

fxAmount

object

(In Development)

Contains the amount in converted currency during currency conversion.

amount integer

Converted amount (in minor units).

rate number

Currency conversion rate.

currency Currency (string)

Possible values: >= 3 characters and <= 3 characters

Currency alphabetic code as specified by ISO 4217

transferDetails

object

Represents the details of a transfer.

reason TransferReason (string)required

Possible values: [INITIAL_BALANCE_MIGRATION, CRYPTO_BUY, CRYPTO_SELL, TRADING_PAIR, DEPOSIT, WITHDRAWAL, MERCHANT_FEE, REFUND, CANCELATION, BONUS, CURRENCY_EXCHANGE, PURCHASE, PAYOUT, PEER_TRANSFER, OTHER]

The actual purpose of the transfer.

INITIAL_BALANCE_MIGRATION - after customer onboarding, migrations of existing balances
CRYPTO_BUY - the customer is buying crypto or other assets
CRYPTO_SELL - the customer is selling crypto or other assets
TRADING_PAIR - the transfer represents a trading pair transaction between customers with wallets
DEPOSIT - crediting the customer's wallet via non-Paysafe deposit options
WITHDRAWAL - debiting the customer's wallet via non-Paysafe withdrawal options
MERCHANT_FEE - charging a merchant fee
REFUND - refunding the customer on a previous transaction
CANCELATION - cancelation of a previous transaction
BONUS - customer is granted a bonus
CURRENCY_EXCHANGE - converting one currency to another
PURCHASE - the customer is purchasing goods or services from a merchant
PAYOUT - the merchant is compensating a customer for goods or services
PEER_TRANSFER - money transfer between customers with wallets
OTHER - any reason not explicitly mentioned in the transfers

description string

Possible values: <= 200 characters

Human readable description for the transfer.

peerDetails

object

Represents the details of a peer.

firstName string

Peer first name.

lastName string

Peer last name.

instrumentDetails

object

Represents details about a customer's payment instrument.

instrumentId string

Instrument ID.

instrumentType

string

Possible values: [CARD, PREPAID_CARD, SEPA_BANK_ACCOUNT, US_BANK_ACCOUNT, UK_BANK_ACCOUNT, CCI_BANK_ACCOUNT]

Represents the type of an instrument.

Value	Description
CARD	Card
PREPAID_CARD	Prepaid Card
SEPA_BANK_ACCOUNT	SEPA Bank account
US_BANK_ACCOUNT	US Bank account
UK_BANK_ACCOUNT	UK Bank account
CCI_BANK_ACCOUNT	CCI Bank account

any

]

meta

object

Contains paging information regarding the returned records, when response is paginated.

The input for paginated query contains two parameters:

limit - This is the requested number of records to return. Defaults to 10 and maximum is 50.
offset - This is the requested starting position of the response, where 0 is the first record. Default = 0.

Note! The total number of records is not returned, to prevent queries spanning on all records. If numberOfRecords<limit, this means no further pages are available. On request of offset beyond the last record, the returned numberOfRecords is 0.

The number of previous pages can be calculated by dividing offset to limit.

numberOfRecords integer

This is the number of records returned in the lookup. Always numberOfRecords is smaller than or equal to limit.

limit integer

This is the requested number of records to be returned per page.

offset integer

This is the requested starting position of the response, where 0 is the first record.

page integer

This is the page of records on which the lookup starts. The starting page is 1.