Skip to content
Transfers/
Transfer transaction

Transfer transaction
Webhook

Request

Notification that a Transfer transaction has been processed.

Headers
call-refstring

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

published-timestampinteger, (int64)required

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

signaturestringrequireddeprecated

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

signature-v2stringrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref + payload + published-timestamp using your API key.

Bodyapplication/jsonrequired
eventTypestring(TransferEventTransferEventType)required
Enum:"PENDING""COMPLETED""FAILED""SCHEDULED""CANCELLED"
transferobject(LegacyTransfer)required
publishedTimestampstring^[0-9]+$required

Epoch timestamp using millisecond precision.

Payload
{
  "eventType": "PENDING",
  "transfer": {
    "id": { … },
    "profileId": "string",
    "tag": "string",
    "source": { … },
    "destination": { … },
    "destinationAmount": { … },
    "state": "INITIALISED",
    "creationTimestamp": "string",
    "conflict": "UNDEFINED",
    "scheduledTimestamp": "string",
    "cancellationReason": "string",
    "executionTimestamp": "string"
  },
  "publishedTimestamp": "string"
}

Responses

Success - No Content