REST

GET/api/v1/transfers?startDate={startDate}&endDate={endDate}&pageSize={pageSize}

Get Transfers Paginated

Retrieve a paginated list of transfers filtered by date range. Maximum date range is 30 days.

Auth:Bearer <api_key>

Tags:Banking

Request

cURL

curl -G https://publicapi.sandbox.hercle.financial/api/v1/transfers?startDate={startDate}&endDate={endDate}&pageSize={pageSize} \
  -H "Authorization: Bearer eyJhb..." \

Query Parameters

Name	Type	Required	Description
startDate	string	Yes	Start date for filtering historical transfers (ISO 8601 format). Maximum range: 30 days from end date. Example: `2025-11-01T00:00:00Z`
endDate	string	Yes	End date for filtering historical transfers (ISO 8601 format). Maximum range: 30 days from start date. Example: `2025-11-30T23:59:59Z`
pageSize	number	Yes	Number of items per page (min: 5, max: 50) Example: `5`
paginationToken	string	No	Token for fetching the next page of results Example: `{"Id":{"S":"id-001"}}`
transferClientId	string	No	Client identifier for the transfer Example: `client-12345`
asset	string	No	Asset code for filtering transfers Example: `EUR`
creditorAddress	string	No	Creditor address for filtering transfers Example: `IT222233223`
debtorAddress	string	No	Debtor address for filtering transfers Example: `DE1122334455`
creditorAsset	string	No	Creditor asset code for filtering transfers Example: `USD`
debtorAsset	string	No	Debtor asset code for filtering transfers Example: `USD`
creditorNetwork	string	No	Creditor network name for filtering transfers Example: `Sepa`
debtorNetwork	string	No	Debtor network name for filtering transfers Example: `Sepa`
status	number	No	Transfer status for filtering transfers Example: `1`
refId	string	No	Reference ID for filtering transfers Example: `ref-654`

Headers

Name	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication

Response

Success Response Schema

Field	Type	Description
`payload`	array	List of transfers
`paginationToken`	string	Token for fetching next page

Transfer Object

Individual transfer details

Field	Type	Description
`id`	string	Unique identifier for the transfer
`userId`	string	User identifier who initiated the transfer
`clientId`	string	Client identifier for the transfer
`description`	string \| null	Description or note for the transfer
`debtor`	object	Debtor account information
`creditor`	object	Creditor account information
`exchangeInfo`	object \| null	Exchange rate information (null if no conversion)
`status`	string	Current transfer status Allowed values: `CREATED` `CONFIRMING` `CONFIRMED`
`refId`	string \| null	Reference ID for the transfer
`payload`	string \| null	Additional transfer data
`isInstant`	boolean	Whether this is an instant transfer
`timestamp`	string	ISO 8601 timestamp of transfer

Debtor Object

Debtor account information

Field	Type	Description
`internalAddressId`	string	Internal address ID of debtor
`asset`	string	Asset code being debited
`address`	string	Debtor address
`addressParams`	object	Additional address parameters
`network`	string	Network name
`amount`	number	Amount being debited
`fee`	number \| null	Fee charged

Creditor Object

Creditor account information

Field	Type	Description
`payeeAddressId`	string	Payee address ID of creditor
`asset`	string	Asset code being credited
`address`	string	Creditor address
`addressParams`	object	Additional address parameters
`network`	string	Network name
`amount`	number	Amount being credited

Exchange Info Object

Exchange rate information (null if no conversion)

Field	Type	Description
`rate`	number \| null	Exchange rate if currency conversion occurred

Responses

200 application/json

{
  "payload": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "987e6543-e21b-12d3-a456-426614174999",
      "clientId": "qwertyuiop-1234-5678-9012-abcdefabcdef",
      "description": "Monthly subscription payment",
      "debtor": {
        "internalAddressId": "internal-123",
        "asset": "EUR",
        "address": "AL663452362473727",
        "addressParams": {},
        "network": "Sepa",
        "amount": 10,
        "fee": 5
      },
      "creditor": {
        "payeeAddressId": "payee-321",
        "asset": "EUR",
        "address": "IT222233223",
        "addressParams": {
          "bic": "Test"
        },
        "network": "Sepa",
        "amount": 10
      },
      "exchangeInfo": null,
      "status": "CONFIRMING",
      "refId": "ref-654",
      "payload": "{\"custom\":\"data\"}",
      "isInstant": false,
      "timestamp": "2023-01-15T10:00:00Z"
    }
  ],
  "paginationToken": ""
}

API Tester

Test this endpoint directly against the sandbox environment

API Key

Get your API key from Hercle Sandbox

Query Parameters

startDate

Required

Start date for filtering historical transfers (ISO 8601 format). Maximum range: 30 days from end date.

endDate

Required

End date for filtering historical transfers (ISO 8601 format). Maximum range: 30 days from start date.

pageSize

Required

Number of items per page (min: 5, max: 50)

paginationToken

Token for fetching the next page of results

transferClientId

Client identifier for the transfer

asset

Asset code for filtering transfers

creditorAddress

Creditor address for filtering transfers

debtorAddress

Debtor address for filtering transfers

creditorAsset

Creditor asset code for filtering transfers

debtorAsset

Debtor asset code for filtering transfers

creditorNetwork

Creditor network name for filtering transfers

debtorNetwork

Debtor network name for filtering transfers

status

Transfer status for filtering transfers

refId

Reference ID for filtering transfers

Request URL

https://publicapi.sandbox.hercle.financial/api/v1/transfers