Skip to main content
GET
Get Transfer

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

transferId
string<uuid>
required

Transfer identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Transfer

transferId
string<uuid>
required

Transfer identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

organizationId
string<uuid>
required

Organization identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b"

organization
object
required

Organization

cooperativeId
string<uuid>
required

Cooperative identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3b"

cooperative
object
required

Cooperative

externalProvider
string
required

External provider name

Example:

"mock"

externalProviderId
string
required

External provider transfer identifier

Example:

"tr_a1b2c3d4"

amount
integer
required

Transfer amount in cents

Example:

50000

status
enum<string>
required

Transfer status

Available options:
CANCELED,
FAILED,
PAID,
PENDING,
PROCESSING
Example:

"PENDING"

createdAt
string<date-time>
required

Created at

Example:

"2026-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2026-01-01T00:00:00.000Z"

createdBy
string<uuid> | null

Created by

Example:

null

updatedBy
string<uuid> | null

Updated by

Example:

null

transferredAt
string<date-time> | null

Transferred at

Example:

"2026-01-01T00:00:00.000Z"