Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2498321298.8 KB
Transactions

Get internal transfer

Retrieve a specific internal transfer.

get/financial-data/v2beta/internal-transfers/{id}

Path parameters

idstring required
Example:e37235aa-adab-11ec-8029-96ac651c9332

Internal transfer ID.

Response

Internal transfer.

idstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

status'CONFIRMED' | 'PENDING' required

CONFIRMED means both legs of the transfer have been observed. PENDING means only one leg has been observed so far — its counterpart's account id is known but the counterpart's transaction id is empty until the counterpart leg ingests.

debitTransactionIdstring

Unique resource identifier.

creditTransactionIdstring

Unique resource identifier.

debitAccountIdstring required

Unique resource identifier.

creditAccountIdstring required

Unique resource identifier.

createdstring date-time required

Time at which the resource was created.

updatedstring date-time required

Time at which the resource was last updated.

versioninteger required

Resource version. Starts at value 1 when the resource is created and increases by one for each successive update.

etagstring required

ETag based on the resource version. This can be passed along in If-Match HTTP header when updating a resource to perform a conditional update.

Example response

{
  "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
  "debitTransactionId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "creditTransactionId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "debitAccountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "creditAccountId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "created": "2022-05-04T18:31:12.889104898Z",
  "updated": "2022-05-04T18:47:32.213842599Z",
  "version": 1,
  "etag": "version:3"
}