Skip to main content
GET
Get all transfers

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Orum-Version
enum<string>
required

Version of Deliver and Verify APIs. Use v2022-09-21.

Available options:
v2022-09-21

Query Parameters

index
integer
default:0

Index for paginated results

Required range: x >= 0
size
integer
default:100

Max number of results to return

Required range: 0 <= x <= 500
transfer_reference_id
string

Filter results by transfer reference id Unique reference id for the transfer. Generated by you.

Minimum string length: 1
status
enum<string>

Filter results by transfer status Describes the current status of the transfer.

Available options:
completed,
created,
failed,
pending,
settled
transfer_group_id
string<uuid>

Filter results by transfer group id Orum generated unique id for the resource.

schedule_id
string<uuid>

Filter results by schedule id Orum generated unique id for the resource.

subledger_reference_id
string

Filter results by subledger reference id Unique reference id for the subledger resource. Generated by you.

Required string length: 1 - 255

Response

200 response.

transfers
TransferResponseBaseObject · object[]
required

List of transfers.