RIripple
Internal transfers

Get a single internal transfer by operation ID

Returns the current state of an internal transfer. Clients poll this after a 202 from the create endpoint until the status is terminal (COMPLETED or FAILED) or PENDING_VERIFICATION. Reads are eventually consistent.

get/v1/domains/{domainId}/omnibus/{omnibusId}/internal-transfers/{operationId}

Request

Path parameters

domainIdstring uuid required
omnibusIdstring uuid required
operationIdstring uuid required

Operation ID returned by the create endpoint

Response

Current state of the internal transfer

operationIdstring uuid required

Operation ID for this internal transfer

transferIdstring uuid required

Transfer ID for this movement

status'PENDING' | 'COMPLETED' | 'FAILED' | 'PENDING_VERIFICATION' required
sourceTenantIdstring uuid required

Source tenant (debited)

destTenantIdstring uuid required

Destination tenant (credited)

amountstring required

Positive integer in the ticker's smallest unit

tickerIdstring uuid required
ledgerIdstring required

Changes

No recorded changes to this operation across all 3 revisions of this API.