v1

latestOpenAPI 3.1.02026-07-26457177.8 KB

Transfers

List Transfers for a User

📘

You can place the bearer access_token for a specific user into the Authentication section of this documentation 👉.

Retrieve all Transfers for a User.

📘

This resource returns paginated results in descending order. For more details please see: Pagination

get/v1/transfers

statusstring

The status of the Transfer (pending, cancelled, processed, failed)

source_idstring

The ID of the source account

page_sizeinteger

The maximum number of items returned with each request. Defaults to 25 if not specified.

cursor_idstring

The pagination cursor ID. When specified, allows one to navigate between pages. If not specified the first page of results will be returned.

batch_idstring

The Batch Transfer ID (required if specifying batch_type)

batch_type'credit' | 'debit'

The Batch Transfer Type (required if specifying batch_id)

Successful response

countinteger

The number of transfers returned

next_cursor_idstring

The next cursor ID, for resuming a paginated query

has_next_pageboolean

Whether the paginated query has additional pages (value may be null if no there are no additional pages)