Retrieve transactions
GET/v2/transactions
Retrieve transactions for an account, ordered by creationTime descending.
Note: Either
accountId
ormerchantRefNum
must be provided when calling this endpoint. If both are missing, HTTP 400 will be returned.
Note: As transfers are processed asynchronously, until the transfer is processed, calling this endpoint with
merchantRefNum
will return an empty result.
Request
Query Parameters
Filter by account ID
Filter transactions by merchant's reference number
Possible values: >= 1
and <= 50
Default value: 10
This is the requested number of records to return. Max = 50. Default = 10.
Default value: 0
This is the requested starting position of the response entries, where 0 is the first record. Default = 0.
Filter by creation time
Filter by creationType after
Filter by status
Filter by type
Filter by card ID
Responses
- 200
- 400
- 500
- 503
OK
- application/json
- Schema
- Example (from schema)
- GET_TRANSACTIONS
- GET_TRANSACTIONS_WITH_FX
Schema
Array [
Array [
- 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
]
- CARD
- BANK_TRANSFER
- RAPID_TRANSFER
- TRANSFER
- 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.
- 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
- CARD
- PREPAID_CARD
- SEPA_BANK_ACCOUNT
- US_BANK_ACCOUNT
- UK_BANK_ACCOUNT
- CCI_BANK_ACCOUNT
]
- 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.
transactions
object[]
Transaction id
Transaction slip Id.
Wallet customer id.
Account Id associated with this transaction.
Possible values: [DEPOSIT
, WITHDRAWAL
, PAYOUT
, 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.
Transaction amount in minor units.
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
fees
object[]
Customer fees attached to the transaction.
Default value: 0
Amount of the merchant payment, in mintor units. If currency
is not specified, then the main transaction currency is used.
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
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.
Represents RFC 3339, section 5.6 date-time.
Represents RFC 3339, section 5.6 date-time.
Possible values: [CREDIT
, DEBIT
]
Transaction direction.
Possible values: [CARD
, BANK_TRANSFER
, RAPID_TRANSFER
, TRANSFER
]
Type of instrument. Used as discriminator for different Payment types.
Possible values: [PENDING
, PROCESSING
, COMPLETED
, FAILED
, CANCELLED
, REFUNDED
, DECLINED
]
Represents the status of a transaction.
Possible values: <= 60 characters
Status reason for FAILED transactions. See TransactionStatusReason for available values.
Possible values: non-empty
and <= 40 characters
Customer identifier used in Partner system.
Balance of the account after the transaction in minor currency units.
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.
Converted amount (in minor units).
Currency conversion rate.
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
transferDetails
object
Represents the details of a transfer.
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.
Possible values: <= 200 characters
Human readable description for the transfer.
peerDetails
object
Represents the details of a peer.
Peer first name.
Peer last name.
instrumentDetails
object
Represents details about a customer's payment instrument.
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
any
any
any
any
any
meta
object
Contains paging information regarding the returned records, when response is paginated.
The input for paginated query contains two parameters:
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 returnednumberOfRecords
is 0.
The number of previous pages can be calculated by dividing offset
to limit
.
This is the number of records returned in the lookup. Always numberOfRecords
is smaller than or equal to limit
.
This is the requested number of records to be returned per page.
This is the requested starting position of the response, where 0 is the first record.
This is the page of records on which the lookup starts. The starting page is 1.
{
"transactions": [
{
"id": "544232",
"slipId": "5009964049",
"customerId": "5435323362",
"accountId": "212345",
"type": "DEPOSIT",
"amount": 1000,
"currencyCode": "EUR",
"fees": [
{
"amount": 1000,
"currency": "EUR",
"paymentReason": "OTHER_FEE"
}
],
"creationTime": "2021-07-15T17:54:12Z",
"lastChangeDate": "2021-07-15T17:54:12Z",
"direction": "CREDIT",
"paymentType": "CARD",
"status": "COMPLETED",
"statusReason": "string",
"merchantRefNum": "af5c8b52-0afd-4799-85ab-fe659a076932",
"balance": 0,
"recipientReference": "string",
"fxAmount": {
"amount": 0,
"rate": 0,
"currency": "EUR"
},
"transferDetails": {
"reason": "INITIAL_BALANCE_MIGRATION",
"description": "string"
},
"peerDetails": {
"firstName": "John",
"lastName": "Doe"
},
"instrumentDetails": {
"instrumentId": "123456789",
"instrumentType": "CARD"
}
}
],
"meta": {
"numberOfRecords": 1,
"limit": 10,
"offset": 0,
"page": 1
}
}
{
"transactions": [
{
"id": "5040057610",
"slipId": "5009964049",
"customerId": "5435323362",
"accountId": "5014567344",
"type": "TRANSFER_OUT",
"amount": 900,
"currencyCode": "GBP",
"fees": [
{
"amount": 100,
"paymentReason": "MERCHANT_FEE"
}
],
"creationTime": "2021-07-15T17:54:12Z",
"lastChangeDate": "2021-07-15T17:54:12Z",
"direction": "DEBIT",
"paymentType": "TRANSFER",
"status": "COMPLETED",
"merchantRefNum": "5040452805",
"peerDetails": {
"firstName": "John",
"lastName": "Doe"
}
},
{
"id": "5040057611",
"slipId": "5009964049",
"customerId": "5435323362",
"accountId": "5014567344",
"type": "MERCHANT_FEE",
"amount": 100,
"currencyCode": "GBP",
"creationTime": "2021-07-15T17:54:12Z",
"lastChangeDate": "2021-07-15T17:54:12Z",
"direction": "DEBIT",
"paymentType": "TRANSFER",
"status": "COMPLETED",
"merchantRefNum": "5040452805",
"peerDetails": {
"firstName": "John",
"lastName": "Doe"
}
},
{
"id": "5040057612",
"slipId": "5009964050",
"customerId": "5435323362",
"accountId": "5014567344",
"type": "WITHDRAWAL",
"amount": 1000,
"currencyCode": "GBP",
"creationTime": "2021-07-15T17:54:12Z",
"lastChangeDate": "2021-07-15T17:54:12Z",
"direction": "DEBIT",
"fees": [
{
"amount": 100,
"paymentReason": "MERCHANT_FEE"
}
],
"paymentType": "BANK_TRANSFER",
"status": "FAILED",
"statusReason": "INSUFFICIENT_FUNDS",
"merchantRefNum": "5040452805",
"peerDetails": {
"firstName": "John",
"lastName": "Doe"
},
"instrumentDetails": {
"instrumentId": "1100000000000009",
"instrumentType": "US_BANK_ACCOUNT",
"accountNumber": "*760",
"bankName": "Citizen Bank"
}
},
{
"id": "21dec943-9f06-40f5-8683-d9cd0ca0a396",
"slipId": "-1",
"customerId": "5435323363",
"accountId": "5014567345",
"type": "PREPAID_CARD_AUTHORIZATION",
"amount": 2282,
"currencyCode": "USD",
"creationTime": "2024-07-18T09:05:11Z",
"lastChangeDate": "2024-07-18T11:05:11Z",
"direction": "DEBIT",
"paymentType": "CARD",
"status": "FAILED",
"statusReason": "INSUFFICIENT_FUNDS",
"balance": 1000,
"transferDetails": {
"reason": "OTHER"
},
"instrumentDetails": {
"instrumentId": "a3cc641c-13da-4e15-8df5-ad2b3dea4195",
"instrumentType": "PREPAID_CARD",
"cardId": "a3cc641c-13da-4e15-8df5-ad2b3dea4195",
"obfuscatedCardNumber": "*1135",
"merchantDetails": {
"mcc": {
"id": "5411",
"name": "Grocery Stores, Supermarkets"
}
},
"paymentAmount": 2282,
"paymentAmountCurrencyCode": "USD"
}
},
{
"id": "5040057613",
"slipId": "5009964051",
"customerId": "5435323363",
"accountId": "5014567345",
"type": "DEPOSIT",
"amount": 4500,
"currencyCode": "BGN",
"creationTime": "2022-09-20T17:54:12Z",
"lastChangeDate": "2022-09-20T17:54:12Z",
"direction": "CREDIT",
"fees": [
{
"amount": 200,
"paymentReason": "MERCHANT_FEE"
}
],
"paymentType": "CARD",
"status": "COMPLETED",
"merchantRefNum": "5040452805",
"instrumentDetails": {
"instrumentId": "1100000000000010",
"instrumentType": "CARD",
"pan": "*3952",
"brand": "MASTERCARD",
"bankName": "DEUTSCHE BANK S.P.A.",
"description": "My MC card"
}
},
{
"id": "5040057713",
"slipId": "5009964051",
"customerId": "5435323363",
"accountId": "5014567345",
"type": "PREPAID_CARD",
"amount": 300,
"currencyCode": "USD",
"creationTime": "2022-09-20T17:54:12Z",
"lastChangeDate": "2022-09-20T17:54:12Z",
"direction": "DEBIT",
"paymentType": "CARD",
"status": "COMPLETED",
"merchantRefNum": "5040452805",
"instrumentDetails": {
"instrumentId": "a3cc641c-13da-4e15-8df5-ad2b3dea4195",
"instrumentType": "PREPAID_CARD",
"cardId": "a3cc641c-13da-4e15-8df5-ad2b3dea4195",
"obfuscatedCardNumber": "*002",
"authorizationId": "f8abf875-7f49-4c28-b3cd-363b475cb2cf",
"merchantDetails": {
"name": "4782 W CEDAR HILLS DR",
"mcc": {
"id": "5411",
"name": "Grocery Stores, Supermarkets"
}
},
"paymentAmount": 100,
"paymentAmountCurrencyCode": "USD"
}
},
{
"id": "5040057614",
"slipId": "5009964051",
"customerId": "5435323363",
"accountId": "5014567345",
"type": "WITHDRAWAL",
"amount": 9000,
"currencyCode": "GBP",
"creationTime": "2022-09-20T17:54:12Z",
"lastChangeDate": "2022-09-20T17:54:12Z",
"direction": "DEBIT",
"fees": [
{
"amount": 150,
"paymentReason": "MERCHANT_FEE"
}
],
"paymentType": "BANK_TRANSFER",
"status": "COMPLETED",
"merchantRefNum": "5040452805",
"instrumentDetails": {
"instrumentId": "1100000000000011",
"instrumentType": "UK_BANK_ACCOUNT",
"accountNumber": "*795",
"bankName": "National Westminster Bank PLC"
}
},
{
"id": "5040057615",
"slipId": "5009964051",
"customerId": "5435323363",
"accountId": "5014567345",
"type": "DEPOSIT",
"amount": 5000,
"currencyCode": "USD",
"creationTime": "2022-09-20T17:54:12Z",
"lastChangeDate": "2022-09-20T17:54:12Z",
"direction": "CREDIT",
"fees": [
{
"amount": 100,
"paymentReason": "MERCHANT_FEE"
}
],
"paymentType": "BANK_TRANSFER",
"status": "COMPLETED",
"merchantRefNum": "5040452805",
"instrumentDetails": {
"instrumentId": "1100000000000012",
"instrumentType": "US_BANK_ACCOUNT",
"accountNumber": "*760",
"bankName": "Citizen Bank"
}
},
{
"id": "5040057616",
"slipId": "5009964051",
"customerId": "5435323363",
"accountId": "5014567345",
"type": "WITHDRAWAL",
"amount": 7500,
"currencyCode": "EUR",
"creationTime": "2022-09-20T17:54:12Z",
"lastChangeDate": "2022-09-20T17:54:12Z",
"direction": "DEBIT",
"fees": [
{
"amount": 150,
"paymentReason": "MERCHANT_FEE"
}
],
"paymentType": "BANK_TRANSFER",
"status": "COMPLETED",
"merchantRefNum": "5040452805",
"instrumentDetails": {
"instrumentId": "1100000000000013",
"instrumentType": "SEPA_BANK_ACCOUNT",
"iban": "*34",
"bankName": "UniCredit Bulbank AD"
}
}
],
"meta": {
"numberOfRecords": 9,
"limit": 9,
"page": 1,
"offset": 0
}
}
{
"transactions": [
{
"id": "5040057610",
"slipId": "5009964049",
"customerId": "5435323362",
"accountId": "5014567344",
"type": "CURRENCY_EXCHANGE",
"amount": 900,
"currencyCode": "GBP",
"fees": [
{
"amount": 100,
"paymentReason": "FX_FEE"
}
],
"creationTime": "2021-07-15T17:54:12Z",
"lastChangeDate": "2021-07-15T17:54:12Z",
"direction": "DEBIT",
"paymentType": "TRANSFER",
"status": "COMPLETED",
"merchantRefNum": "5040452805",
"fxAmount": {
"amount": 1035,
"rate": 1.15,
"currency": "EUR"
}
},
{
"id": "5040057612",
"slipId": "5009964049",
"customerId": "5435323363",
"accountId": "5014567344",
"type": "CURRENCY_EXCHANGE",
"amount": 1035,
"currencyCode": "EUR",
"creationTime": "2021-07-15T17:54:12Z",
"lastChangeDate": "2021-07-15T17:54:12Z",
"direction": "CREDIT",
"paymentType": "TRANSFER",
"status": "COMPLETED",
"merchantRefNum": "5040452805",
"fxAmount": {
"amount": 900,
"rate": 1.15,
"currency": "GBP"
}
},
{
"id": "5040057611",
"slipId": "5009964049",
"customerId": "5435323362",
"accountId": "5014567344",
"type": "MERCHANT_FEE",
"amount": 100,
"currencyCode": "GBP",
"creationTime": "2021-07-15T17:54:12Z",
"lastChangeDate": "2021-07-15T17:54:12Z",
"direction": "DEBIT",
"paymentType": "TRANSFER",
"status": "COMPLETED",
"merchantRefNum": "5040452805"
},
{
"id": "5040057613",
"slipId": "5009964049",
"customerId": "6666666",
"accountId": "222222",
"type": "MERCHANT_FEE",
"amount": 100,
"currencyCode": "GBP",
"creationTime": "2021-07-15T17:54:12Z",
"lastChangeDate": "2021-07-15T17:54:12Z",
"direction": "CREDIT",
"paymentType": "TRANSFER",
"status": "COMPLETED",
"merchantRefNum": "5040452805"
}
],
"meta": {
"numberOfRecords": 4,
"limit": 4,
"page": 1,
"offset": 0
}
}
Bad request
- application/json
- Schema
- Example (from schema)
- MISSING_ACCOUNT_ID_AND_MERCHANT_REF
- INVALID_ACCOUNT_ID
- INCORRECT_OFFSET_AND_LIMIT
Schema
Array [
]
error
object
Represents details of an error.
The error code.
The description of the error.
Details for the errors of any parameter value.
fieldErrors
object[]
List of field errors associated with the main error.
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-ACCOUNT-ID-AND-MERCHANT-REF-NULL",
"message": "both accountId and merchantRefNum cannot be null!",
"details": [
"both accountId and merchantRefNum cannot be null! At least one of them should be provided."
]
}
}
{
"error": {
"code": "DW-CUSTOMER-ACCOUNT-ID-SHOULD-BE-VALID",
"message": "AccountId is not supported",
"details": [
"AccountId should be valid numeric value"
]
}
}
{
"error": {
"code": "DW-INCORRECT-OFFSET-AND-LIMIT",
"message": "Incorrect offset and limit",
"details": [
"The offset should be divisible by the limit and without a remainder"
]
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- INTERNAL_SERVER_ERROR
Schema
Array [
]
error
object
Represents details of an error.
The error code.
The description of the error.
Details for the errors of any parameter value.
fieldErrors
object[]
List of field errors associated with the main error.
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-INTERNAL-SERVER-ERROR",
"message": "Internal Server Error",
"details": [
"There was an error while processing the operation"
]
}
}
Service Unavailable. Please try again later.
- application/json
- Schema
- Example (from schema)
- SERVICE_UNAVAILABLE
Schema
Array [
]
error
object
Represents details of an error.
The error code.
The description of the error.
Details for the errors of any parameter value.
fieldErrors
object[]
List of field errors associated with the main error.
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-SERVICE-UNAVAILABLE",
"message": "Service Unavailable",
"details": [
"Service Unavailable"
]
}
}