Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Listing bank deposits

GET /api/public/v1/transactions/bank_deposits

Returns the fiat transfers received on the bank details of your accounts, newest first, with pagination. Filter by created_at_from and created_at_to. A transfer is matched to the account whose bank reference the sender quoted. simplifiedState follows the Bank deposit status flow; only completed deposits are credited to the balance.

Headers

Name
Value

Content-Type

application/vnd.api+json

Authorization

Bearer <api_key>

URL Parameters

Name
Type
Description

order

string

Order in which the list of transactions should be returned. Can be created_at.

order_type

string

Order type. Can be either asc or desc.

page

number

Page for which you want to return transactions.

per_page

number

Number of transactions per page to return.

created_at_from

string

Date and time filter. Supports timestamps in ISO 8601 format, e.g. 2024-06-18T15:49:02.031Z.

created_at_to

string

Date and time filter. Supports timestamps in ISO 8601 format, e.g. 2024-06-18T15:49:02.031Z.

cURL

curl -G "https://api.sandbox.txn.io/api/public/v1/transactions/bank_deposits" \
     -H 'Content-Type: application/vnd.api+json' \
     -H 'Authorization: Bearer <api_key>' \
     --data-urlencode 'created_at_from=2026-10-01T00:00:00Z' \
     --data-urlencode 'created_at_to=2026-11-01T00:00:00Z' \
     --data-urlencode 'per_page=100' \
     --data-urlencode 'page=1'

Response Body

Name
Type
Description

data[].id

string

Transaction ID.

data[].type

string

Entity type returned. Always transactions.

data[].attributes

object

Set of transaction attributes.

data[].attributes.createdAt

string

Timestamp when the deposit was created. Refer to the Date and time format page.

data[].attributes.simplifiedState

string

Deposit status. One of pending, on_hold, completed, cancelled. See Transaction statuses.

data[].attributes.transactionType

string

Transaction type. Always BankDepositTransaction.

data[].attributes.amount

string

Amount credited to the account.

data[].attributes.currency

string

Currency code of the transaction.

data[].attributes.balance

string

Account balance immediately after Txn processed this transaction. null when not applicable.

data[].attributes.reference

string

Bank deposit reference.

data[].attributes.accountId

string

ID of the account the deposit was credited to.

data[].relationships.transactionDetails

object

The bank deposit record. data.type is bankDepositTransactions and data.id is the transaction's own ID; the entity is returned in included[].

data[].relationships.account

object

Not expanded (meta.included is false). Use data[].attributes.accountId, or the accounts entity in included[].

data[].relationships.author

object

Not expanded (meta.included is false).

included[].type(bankDepositTransactions)

object

The transfer as received from the bank. Its id equals data[].id.

included[].type(bankDepositTransactions).attributes.amount

string

Amount credited, in currency. Same as data[].attributes.amount.

included[].type(bankDepositTransactions).attributes.currency

string

Currency of the transfer. Equals the account currency and data[].attributes.currency.

included[].type(bankDepositTransactions).attributes.reference

string

The payment reference the payer quoted, which is how the transfer was matched to your account: its bankReference. Same as data[].attributes.reference.

included[].type(bankDepositTransactions).attributes.payerName

string

Name of the payer, as reported by the bank. null when the bank does not provide it.

included[].type(bankDepositTransactions).attributes.payerIban

string

IBAN the transfer came from. null when the bank does not provide it.

included[].type(bankDepositTransactions).attributes.payerBic

string

BIC/SWIFT code of the payer's bank. null when the bank does not provide it.

included[].type(bankDepositTransactions).attributes.payerAddress

string

Address of the payer. null when the bank does not provide it.

included[].type(bankDepositTransactions).attributes.simplifiedState

string

Deposit status. Same value as data[].attributes.simplifiedState; see Bank deposit status flow.

included[].type(bankDepositTransactions).attributes.state

string

Internal Txn state. Ignore this field and use simplifiedState.

included[].type(bankDepositTransactions).attributes.createdAt

string

When Txn recorded the transfer.

included[].type(bankDepositTransactions).attributes.updatedAt

string

When the deposit last changed.

included[].type(bankDepositTransactions).relationships.account

object

The account credited. data.type is accounts; the entity is returned in included[].

included[].type(bankDepositTransactions).relationships.author

object

Not expanded (meta.included is false).

included[].type(accounts)

object

The account the deposit was credited to (included[].type(bankDepositTransactions).relationships.account). Same fields as Reading account; the ones most relevant here are listed below.

included[].type(accounts).attributes.currencyCode

string

Account currency. Equals data[].attributes.currency.

included[].type(accounts).attributes.label

string

Account label.

included[].type(accounts).attributes.master

boolean

true for the master account, false for a subaccount.

included[].type(accounts).attributes.bankReference

string

The bank deposit reference of the account.

included[].type(accounts).attributes.balance

string

Account balance at the time of the request.

included[].type(accounts).attributes.currencyType

string

Always fiat here.

included[].type(accounts).relationships

object

company, networks and txnBankCredentials: not expanded (meta.included is false).

meta.page

number

Current page number.

meta.per_page

number

Page size used for the response.

meta.total

number

Total number of deposits matching the query.

Response

Last updated