Wallet transactions
Wallet transactions are the credits and debits recorded in a wallet. Use these endpoints to fetch the transaction history of your company wallets and of individual recipients' wallets (personal PAT accounts), and to get the details of a single transaction.
Company wallets are identified by WalletID. A personal account has at most one wallet per currency, so an individual recipient's wallet is identified by UserID and WalletCurrency.
The list endpoints are paginated with RecordsToSkip, a page number that starts at "1", and RecordsToTake, the page size. They return the total number of matching records in PaginationTotal.RecordsTotal. To get the details of a transaction in an individual recipient's wallet, pass the TransactionID from GetUserWalletTransactions to GetUserWalletTransactionDetails. GetCompanyWalletTransactionDetails takes a TransactionID returned by GetCompanyWalletTransactions.
A batch payment's Description appears on the wallet transactions the payment creates: the debit in your source wallet and the credit in the recipient's wallet. Start each Description with the payment's CustomerTransactionId, and you can match these transactions to your payments by that ID, as Track & reconcile payments explains.
- POST
/API/v4/Wallet/GetCompanyWalletTransactionsList company wallet transactions - POST
/API/v4/Wallet/GetCompanyWalletTransactionDetailsGet the details of a company wallet transaction - POST
/API/v4/Wallet/GetUserWalletTransactionsList an individual recipient's wallet transactions - POST
/API/v4/Wallet/GetUserWalletTransactionDetailsGet the details of an individual recipient's wallet transaction - POST
/API/v4/Wallet/GetUserWalletTransactionsByRemitterList an individual recipient's transactions from one company
#List company wallet transactions
/API/v4/Wallet/GetCompanyWalletTransactionsLists the transactions recorded in a company wallet, identified by its WalletID. Each record shows the transaction date, currency, program, description, type, amount, the wallet balance after the transaction, and the payment type.
Results are paginated. Set RecordsToSkip (the page number, "1" for the first page) and RecordsToTake (the page size) in Pagination, and read PaginationTotal.RecordsTotal for the total number of matching records.
To narrow the list, add the optional Filters object: a date range (StartUTC, EndUTC), a search term in SearchParam, and a TransactionType. If you send Filters, the date range and TransactionType are required. Without Filters, only the last 90 days are returned.
The debit for a batch payment has the payment's Description, and its Amount is the payment's amount plus its fee. If you start each Description with the payment's CustomerTransactionId, you can find one payment's debit by sending that ID in SearchParam, with "TransactionType": "Sent" and a date range around the day the payment was processed. SearchParam matches any part of the text, so check that the first word of Description is exactly the ID.
A credit that Xtrm makes to the wallet by hand, such as the money of a bank payment that the recipient's bank returned, is a separate Credit record whose Description is Xtrm's note. Nothing in it links it to the original payment. The Received filter doesn't return it; All and Funded do. See Returned bank payments.
GetCompanyWalletTransactionDetails returns the full breakdown of a transaction: pass it a TransactionID from this list, as a string.
Tip
RecordsToSkip is a page number, not a record offset. Send "1" for the first page and add 1 for each next page; "0" is rejected.
Body parameters
GetCompanyWalletTransactionsobjectRequiredRequest wrapper.
Child parameters1
RequestobjectRequiredRequest parameters.
Child parameters4
IssuerAccountNumberstringRequiredYour company's Xtrm account number, starting with
SPN, for the account associated with the API credentials you use. If you use pseudo credentials, this is theSPNof the company on whose behalf you make the call.WalletIDstringRequiredUnique internal identifier of the company wallet to retrieve transactions for, as a string, e.g.
"122181". Company wallet IDs are returned byGetCompanyWallets.PaginationobjectRequiredPagination settings for the result list.
Child parameters2
RecordsToSkipstringRequiredPage number to return, as an integer string:
"1"for the first page,"2"for the next, and so on. Despite its name, it isn't a record offset: Xtrm skips(RecordsToSkip - 1) × RecordsToTakerecords. Values below"1"are rejected with400.RecordsToTakestringRequiredPage size: the maximum number of transactions to return per page, as an integer string, e.g.
"25".
FiltersobjectOptionalOptional filters that narrow the result list. If you send
Filters,DateRange(withStartUTCandEndUTC) andTransactionTypeare required. WithoutFilters, only the transactions of the last 90 days are returned.Child parameters3
DateRangeobjectRequiredDate range to filter transactions by. Required when you send
Filters.Child parameters2
EndUTCstringRequiredEnd of the date range, as a date in
MM/DD/YYYYformat, e.g."06/30/2026". The range includes this whole day. Xtrm compares the dates with each record'sTransactionDate, which is in Xtrm's server time.StartUTCstringRequiredStart of the date range, as a date in
MM/DD/YYYYformat, e.g."06/01/2026". The range includes this day.
SearchParamstringOptionalText to find in each transaction's description or amount, up to 100 characters, e.g.
"TXN-2026-9912A". It matches any part of the text, so"TXN-2026-991"also returnsTXN-2026-9912A, and an_matches any single character. Send""to match every transaction.TransactionTypestringRequiredType of transaction to return:
All,Received,Sent,Transfer,Currency Exchange,PendingorFunded.Receivedselects credits, except credits that Xtrm makes to the wallet by hand, such as a returned bank payment:FundedandAllreturn those. Any other value, such asCreditsorDebits, is refused with400andInvalid transaction type. Please only use: …. Required when you sendFilters.Allowed values:
All,Received,Sent,Transfer,Currency Exchange,Pending,Funded.
Response fields
GetCompanyWalletTransactionsResponseobjectResponse wrapper.
Child parameters1
GetCompanyWalletTransactionsResultobjectResult of the call.
Child parameters3
Transactionsobject[]Transactions that match the request, one object per transaction.
Child parameters9
TransactionIDintegerUnique identifier that Xtrm generates for the transaction. To get its details, pass it as a string to
GetCompanyWalletTransactionDetails.TransactionDatestringTimestamp of when the transaction was processed, e.g.
"2026-06-05T16:15:06.283".CurrencystringThree-letter ISO 4217 currency code of the transaction.
ProgramNamestringName of the program associated with the transaction, if applicable. The company that runs the program sets the name.
DescriptionstringText describing the nature and purpose of the transaction. On the debit for a batch payment, and on the credit in a recipient company's wallet, it's the payment's
Descriptionfrom the batch, as Xtrm stored it (an&reads&).TypestringOperational type of the transaction, e.g.
CreditorDebit.AmountnumberMonetary value of the transaction. On the debit for a batch payment, the payment's amount plus its fee.
BalancenumberAvailable balance remaining in the wallet after the transaction.
PaymentTypestringClassification of the payment, e.g.
Personal (1 individuals)orCompany (1 companies)on the debit for a payment. Empty on other transactions.
OperationStatusobjectOutcome of the operation.
Child parameters2
Successbooleantrueif the operation succeeded,falseif it failed.Errorsstring[]Error messages when the call fails, as an array of strings. On success it's
nullor an empty array[](nullin the example), so decide withSuccess.
PaginationTotalobjectPagination details for this response.
Child parameters3
RecordsToSkipintegerThe
RecordsToSkipvalue from the request: the page number.RecordsToTakeintegerMaximum number of results requested per page.
RecordsTotalintegerTotal number of transaction records that match the search criteria.
Related: Get the details of a company wallet transaction · List company wallets
#Get the details of a company wallet transaction
/API/v4/Wallet/GetCompanyWalletTransactionDetailsReturns the detailed breakdown of one company wallet transaction, identified by a TransactionID returned by GetCompanyWalletTransactions.
Xtrm returns the details as Name/Value pairs in Field. In the example these include Beneficiary Transaction Id and Sub Transaction Id, the method, type, status, recipient (Transferred to), program, amount, fees, total payment and currency. Values are strings, e.g. "100.00".
On a debit for a payment, Beneficiary Transaction Id is the TransactionID of the matching credit in the recipient's wallet: for an individual recipient, the TransactionID that GetUserWalletTransactions lists for that credit. In the example, 888707 is the credit to Jane Doe's USD wallet for this USD 100.00 payment.
On the debit for a batch payment, Description and Comment both hold the payment's Description from the batch. In the example it starts with the payment's CustomerTransactionId, TXN-2026-9912A.
If the transaction was processed as a Pay Direct transaction, PayDirectTransactionDetails contains the direct payment information.
Body parameters
GetCompanyTransactionDetailsobjectRequiredRequest wrapper. Note that the key omits
Wallet, unlike the operation name.Child parameters1
RequestobjectRequiredRequest parameters.
Child parameters2
IssuerAccountNumberstringRequiredYour company's Xtrm account number, starting with
SPN, for the account associated with the API credentials you use. If you use pseudo credentials, this is theSPNof the company on whose behalf you make the call.TransactionIDstringRequiredUnique identifier that Xtrm generates for the transaction, as a string, e.g.
"888607". Get it fromGetCompanyWalletTransactions.
Response fields
GetCompanyTransactionDetailsResponseobjectResponse wrapper.
Child parameters1
GetCompanyTransactionDetailsResultobjectResult of the call.
Child parameters3
FieldarrayTransaction details, as an array of arrays of
Name/Valueobjects.Nameis the name of the detail field andValueis its value, as a string. In the example,Fieldcontains a single array of pairs, so read them fromField[0]. The example returns these names:Beneficiary Transaction Id,Sub Transaction Id,Method,Type,Status,Transferred to,Program,Description,Comment,Submission File,Partner,Sale Date,Budget Code,Amount,Fees,Total PaymentandCurrency.PayDirectTransactionDetailsarrayDirect payment information, if the transaction was processed as a Pay Direct transfer. Empty in the example.
OperationStatusobjectOutcome of the operation.
Child parameters2
Successbooleantrueif the operation succeeded,falseif it failed.Errorsstring[]Error messages when the call fails, as an array of strings. On success it's
nullor an empty array[](nullin the example), so decide withSuccess.
Related: List company wallet transactions
#List an individual recipient's wallet transactions
/API/v4/Wallet/GetUserWalletTransactionsLists the transactions in one wallet of an individual recipient (a personal PAT account). A personal account can have several wallets but only one wallet per currency, so you identify the wallet with UserID and WalletCurrency.
Each record shows the company and program associated with the transaction, the transaction date, description, amount, type and payment method.
Results are paginated. Set RecordsToSkip (the page number, "1" for the first page) and RecordsToTake (the page size) in Pagination, and read PaginationTotal.RecordsTotal for the total number of matching records. Without Filters, the call returns the wallet's whole transaction history, newest first. To limit the list to a period, add the optional Filters object: a date range (StartUTC, EndUTC), a search term in SearchParam, and a TransactionType (All for every type). If you send Filters, the date range and TransactionType are required.
A credit from a batch payment has the payment's full amount and its Description, which the recipient sees too. If you start each Description with the payment's CustomerTransactionId, that ID identifies the payment. SearchParam doesn't search descriptions in this call, so filter by date range and compare Description yourself. A transfer from the wallet to the recipient's bank account, card or check appears as a separate debit, with a description of its own.
To get the full details of a transaction, pass its TransactionID to GetUserWalletTransactionDetails.
Your company must be connected to the recipient's account. The call then returns every transaction in the wallet, from any company, not only your payments. To list only your own payments to the recipient, without a connection, use GetUserWalletTransactionsByRemitter.
Tip
RecordsToSkip is a page number, not a record offset. Send "1" for the first page and add 1 for each next page; "0" is rejected.
Body parameters
GetUserWalletTransactionsobjectRequiredRequest wrapper.
Child parameters1
RequestobjectRequiredRequest parameters.
Child parameters5
IssuerAccountNumberstringRequiredYour company's Xtrm account number, starting with
SPN, for the account associated with the API credentials you use. If you use pseudo credentials, this is theSPNof the company on whose behalf you make the call.UserIDstringRequiredXtrm account number of the personal account, starting with
PAT.WalletCurrencystringRequiredThree-letter ISO 4217 currency code that identifies the recipient's wallet to query, e.g.
"USD".PaginationobjectRequiredPagination settings for the result list.
Child parameters2
RecordsToSkipstringRequiredPage number to return, as an integer string:
"1"for the first page,"2"for the next, and so on. Despite its name, it isn't a record offset: Xtrm skips(RecordsToSkip - 1) × RecordsToTakerecords. Values below"1"are rejected with400.RecordsToTakestringRequiredPage size: the maximum number of transactions to return per page, as an integer string, e.g.
"25".
FiltersobjectOptionalOptional filters that narrow the result list. If you send
Filters,DateRange(withStartUTCandEndUTC) andTransactionTypeare required. WithoutFilters, the call returns the wallet's whole transaction history, newest first.Child parameters3
DateRangeobjectRequiredDate range to filter transactions by. Required when you send
Filters.Child parameters2
EndUTCstringRequiredEnd of the date range, as a date in
MM/DD/YYYYformat, e.g."06/30/2026". The range includes this whole day. Xtrm compares the dates with each record'sTransactionDate, which is in Xtrm's server time.StartUTCstringRequiredStart of the date range, as a date in
MM/DD/YYYYformat, e.g."06/01/2026". The range includes this day.
SearchParamstringOptionalUsed only with
TransactionTypeCurrency Exchange, where it matches the transaction amount, e.g."100". With any otherTransactionType, it has no effect. Send""when you don't need it.TransactionTypestringRequiredType of transaction to return:
All,Received,Sent,Transfer,Currency Exchange,PendingorFunded.Receivedselects credits. Any other value, such asCreditsorDebits, is refused with400andInvalid transaction type. Please only use: …. Required when you sendFilters.Allowed values:
All,Received,Sent,Transfer,Currency Exchange,Pending,Funded.
Response fields
GetUserWalletTransactionsResponseobjectResponse wrapper.
Child parameters1
GetUserWalletTransactionsResultobjectResult of the call.
Child parameters3
Transactionsobject[]Transactions that match the request, one object per transaction.
Child parameters8
TransactionIDintegerUnique identifier that Xtrm generates for the transaction. To get its details, pass it as a string to
GetUserWalletTransactionDetails.CompanyNamestringName of the company associated with the transaction, e.g. the company that paid or funded it.
ProgramNamestringName of the program associated with the transaction, if applicable. The company that runs the program sets the name.
TransactionDatestringTimestamp of when the transaction was processed, e.g.
"2026-06-05T16:15:06.283".DescriptionstringText describing the nature and purpose of the transaction. On the credit from a batch payment, it's the payment's
Descriptionfrom the batch, as Xtrm stored it.AmountnumberMonetary value of the transaction.
TypestringOperational type of the transaction, e.g.
CreditorDebit.PaymentMethodstringPayment method used for the transaction, e.g.
AnyPay. May be blank if not applicable.
OperationStatusobjectOutcome of the operation.
Child parameters2
Successbooleantrueif the operation succeeded,falseif it failed.Errorsstring[]Error messages when the call fails, as an array of strings. On success it's
nullor an empty array[](nullin the example), so decide withSuccess.
PaginationTotalobjectPagination details for this response.
Child parameters3
RecordsToSkipintegerThe
RecordsToSkipvalue from the request: the page number.RecordsToTakeintegerMaximum number of results requested per page.
RecordsTotalintegerTotal number of transaction records that match the search criteria.
Related: Get the details of an individual recipient's wallet transaction · List an individual recipient's transactions from one company · List an individual recipient's wallets · Get an individual recipient's wallet balance
#Get the details of an individual recipient's wallet transaction
/API/v4/Wallet/GetUserWalletTransactionDetailsReturns detailed information about one transaction of an individual recipient (a personal PAT account). Get the TransactionID by calling GetUserWalletTransactions first.
UserID is required: it restricts the call to transaction details for the given UserID and TransactionID. Your company must be connected to the recipient's account.
Xtrm returns the details as Name/Value pairs in Field. In the example these include the transaction type and status, sender (From), recipient (To), description, amount, fees, total, currency and transaction date. Values are strings; in the example, amounts include the currency code, e.g. "100.00 USD".
For the credit from a batch payment, Description reads Wallet, as in the example. The payment's own Description, with the CustomerTransactionId you put in it, is on the record that GetUserWalletTransactions lists.
Body parameters
GetUserTransactionDetailsobjectRequiredRequest wrapper. Note that the key omits
Wallet, unlike the operation name.Child parameters1
RequestobjectRequiredRequest parameters.
Child parameters3
IssuerAccountNumberstringRequiredYour company's Xtrm account number, starting with
SPN, for the account associated with the API credentials you use. If you use pseudo credentials, this is theSPNof the company on whose behalf you make the call.TransactionIDstringRequiredUnique identifier that Xtrm generates for the transaction, as a string, e.g.
"888707". Get it fromGetUserWalletTransactions.UserIDstringRequiredXtrm account number of the personal account, starting with
PAT.
Response fields
GetUserTransactionDetailsResponseobjectResponse wrapper.
Child parameters1
GetUserTransactionDetailsResultobjectResult of the call.
Child parameters2
FieldarrayTransaction details, as an array of arrays of
Name/Valueobjects.Nameis the name of the detail field andValueis its value, as a string. In the example,Fieldcontains a single array of pairs, so read them fromField[0]. The example returns these names:Transaction Type,Transaction Status,From,To,Description,Amount,Fees,Total,CurrencyandTransaction Date.OperationStatusobjectOutcome of the operation.
Child parameters2
Successbooleantrueif the operation succeeded,falseif it failed.Errorsstring[]Error messages when the call fails, as an array of strings. On success it's
nullor an empty array[](nullin the example), so decide withSuccess.
Related: List an individual recipient's wallet transactions · List an individual recipient's transactions from one company
#List an individual recipient's transactions from one company
/API/v4/Wallet/GetUserWalletTransactionsByRemitterLists the transactions of an individual recipient (a personal PAT account) that come from one paying company, identified by RemitterAccountNo. The records show the amounts that company paid the recipient, each with the payment's Description. Each record's TransactionID is the ID of the paying company's debit for that payment, as GetCompanyWalletTransactions lists it, not the ID of the credit in the recipient's wallet. With your own SPN in RemitterAccountNo, the call needs no connection to the recipient; to list another company's payments, your company must be connected to that company.
You identify the recipient's wallet with UserID and WalletCurrency. Results are paginated: set RecordsToSkip and RecordsToTake in Pagination, and read PaginationTotal.RecordsTotal for the total number of matching records.
Tip
RecordsToSkip is a page number, not a record offset. Send "1" for the first page and add 1 for each next page; "0" is rejected.
Body parameters
GetUserWalletTransactionsByRemitterobjectRequiredRequest wrapper.
Child parameters1
RequestobjectRequiredRequest parameters.
Child parameters5
IssuerAccountNumberstringRequiredYour company's Xtrm account number, starting with
SPN, for the account associated with the API credentials you use. If you use pseudo credentials, this is theSPNof the company on whose behalf you make the call.UserIDstringRequiredXtrm account number of the personal account, starting with
PAT.RemitterAccountNostringRequiredXtrm account number of the paying company, starting with
SPN.WalletCurrencystringRequiredThree-letter ISO 4217 currency code that identifies the recipient's wallet to query, e.g.
"USD".PaginationobjectRequiredPagination settings for the result list.
Child parameters2
RecordsToSkipstringRequiredPage number to return, as an integer string:
"1"for the first page,"2"for the next, and so on. Despite its name, it isn't a record offset: Xtrm skips(RecordsToSkip - 1) × RecordsToTakerecords. Values below"1"are rejected with400.RecordsToTakestringRequiredPage size: the maximum number of transactions to return per page, as an integer string, e.g.
"25".
Response fields
GetUserWalletTransactionsByRemitterResponseobjectResponse wrapper.
Child parameters1
GetUserWalletTransactionsByRemitterResultobjectResult of the call.
Child parameters3
Transactionsobject[]Transactions from the paying company, one object per transaction.
Child parameters9
TransactionIDintegerThe
TransactionIDof the payment's debit in the paying company's wallet, the same ID thatGetCompanyWalletTransactionslists for that debit. It isn't the ID of the credit thatGetUserWalletTransactionslists: in the example,888607is the debit for the USD 100.00 payment that Jane Doe's wallet lists as888707.CompanyNamestringName of the paying company that started the transaction.
ProgramNamestringName of the program associated with the transaction, if applicable. The company that runs the program sets the name.
TransactionDatestringTimestamp of when the transaction was processed, e.g.
"2026-06-05T16:15:06.283".DescriptionstringText describing the nature and purpose of the transaction. On the credit from a batch payment, it's the payment's
Descriptionfrom the batch, as Xtrm stored it, so aCustomerTransactionIdat its start identifies the payment.AmountnumberMonetary value of the transaction.
CurrencystringThree-letter ISO 4217 currency code of the transaction.
TypestringOperational type of the transaction, e.g.
CreditorDebit.PaymentMethodstringPayment method used for the transaction, e.g.
AnyPay.
OperationStatusobjectOutcome of the operation.
Child parameters2
Successbooleantrueif the operation succeeded,falseif it failed.Errorsstring[]Error messages when the call fails, as an array of strings. On success it's
nullor an empty array[](nullin the example), so decide withSuccess.
PaginationTotalobjectPagination details for this response.
Child parameters3
RecordsToSkipintegerThe
RecordsToSkipvalue from the request: the page number.RecordsToTakeintegerMaximum number of results requested per page.
RecordsTotalintegerTotal number of transaction records that match the search criteria.
Related: List an individual recipient's wallet transactions · Get the details of an individual recipient's wallet transaction · List an individual recipient's wallets