Retrieve single transaction
GET/v2/transactions/:transactionId
Retrieve details on a transaction with the specified id. List of transactions can be fetched by calling /v2/transactions
. To retrieve the details of a card authorization by id, the Retrieve Single Authorization
endpoint should be used - /v2/authorizations/{authorizationId}
.
Request
Path Parameters
Transaction id
Responses
- 200
- 400
- 401
- 404
- 500
- 503
OK
- application/json
- Schema
- Example (from schema)
- SINGLE_TRANSACTION
Schema
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
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
{
"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"
}
}
{
"id": "5040057612",
"slipId": "5009964050",
"customerId": "5435323362",
"accountId": "5014567344",
"type": "TRANSFER_OUT",
"amount": 1000,
"currencyCode": "GBP",
"creationTime": "2024-07-15T17:54:12Z",
"lastChangeDate": "2024-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"
}
}
Bad request
- application/json
- Schema
- Example (from schema)
- INVALID_TRANSACTION_ID
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-CUSTOMER-TRANSACTION-ID-SHOULD-BE-VALID",
"message": "TransactionId is not supported",
"details": [
"TransactionId should be valid numeric value"
]
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- INVALID_CREDENTIALS
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": "5279",
"message": "Invalid credentials",
"details": [
"The authentication credentials are invalid."
]
}
}
Not found
- application/json
- Schema
- Example (from schema)
- NOT_FOUND
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": "5269",
"message": "Entity not found",
"details": [
"The ID(s) specified in the URL do not correspond to the values in the system."
]
}
}
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"
]
}
}