Skip to main content
PATCH
curl

Authorizations

x-api-key
string
header
required

Path Parameters

transaction_id
string<uuid>
required

Didit-stable transaction UUID that owns the transfer.

Body

application/json

Provide exactly one of: payment_txn_id (finish), action=cancel, or action=resend.

payment_txn_id
string

The on-chain transaction hash. Requires the transfer to be an outbound transfer in COMPLETED status.

action
enum<string>

"cancel" cancels a non-terminal transfer. "resend" re-runs routing for an outbound transfer stuck in COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE, or NOT_ENOUGH_COUNTERPARTY_DATA.

Available options:
cancel,
resend

Response

The updated transfer.

Full transfer object returned by the ownership-confirmation and finish/cancel endpoints. originator_data/beneficiary_data are omitted while PII is masked (see description).

uuid
string<uuid>
status
enum<string>
Available options:
AWAITING_COUNTERPARTY,
ON_HOLD,
COMPLETED,
FINISHED,
CANCELLED,
EXPIRED,
COUNTERPARTY_MISMATCHED_DATA,
COUNTERPARTY_VASP_NOT_FOUND,
COUNTERPARTY_VASP_NOT_REACHABLE,
UNCONFIRMED_OWNERSHIP,
COUNTERPARTY_VASP_GENERAL_DECLINE,
NOT_ENOUGH_COUNTERPARTY_DATA,
NOT_APPLICABLE
direction
enum<string>
Available options:
INBOUND,
OUTBOUND
rail
enum<string> | null
Available options:
INTERNAL,
TRP,
GTR,
EMAIL,
null
protocol
string | null
ivms_version
string
Example:

"ivms101.2023"

required
boolean
ownership_confirmed
boolean | null
deadline_at
string<date-time> | null
timeline
object[]
counterparty_vasp
object | null
originator_data
object
beneficiary_data
object
created_at
string<date-time>