Sends

Cancel a send

Cancels the send identified by id before it executes.

Only sends in SCHEDULED can be canceled with this operation. Canceling a scheduled send doesn't require Strong Customer Authentication.

post/sends/{id}/cancel

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/sends/{id}/cancel
  • Auth: HTTP bearer and API key in header api-key

Path parameters

idstring required
Example:123456789

The unique identifier of the send.

Request body

cancellationReasonstring

The reason the scheduled transaction was canceled.

Example request

{
  "cancellationReason": "Payment no longer required"
}

Response

Success

idstring required

The unique identifier of a send transaction.

profileIdstring required

The profile Id which a specific identity, instrument, or transaction type is linked to.

Profiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.

You can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

tagstring

The tag field is a custom field that can be used to search and filter.

descriptionstring

The description details that are passed to the beneficiary.

state'INVALID' | 'INITIALISED' | 'COMPLETED' | 'REJECTED' | 'FAILED' | 'PENDING' | 'PENDING_CHALLENGE' | 'APPROVED' | 'RETURNED' | 'SCHEDULED' | 'CANCELLED' required

The state of the send transaction, as follows:

  • INVALID: The send transaction has failed initial validation checks.
  • INITIALISED: The initial state of a send transaction when SCA is not required.
  • PENDING_CHALLENGE: The send transaction requires the completion of a transaction confirmation challenge before it can be submitted.
  • PENDING: The send transaction is temporarily on hold, for example during transaction monitoring, a monitoring retry, or SCA processing.
  • APPROVED: The send transaction that was submitted has been approved.
  • COMPLETED: The requested funds have been sent from the source instrument.
  • REJECTED: The send transaction that was submitted was rejected.
  • FAILED: There was an issue with the send transaction, and the transaction has failed.
  • SCHEDULED: The send transaction will be executed at the scheduled time.
  • CANCELLED: The scheduled send transaction has been canceled.
challengeExemptionReason'LOW_VALUE' | 'TRUSTED_BENEFICIARY'

The Reason the transaction was exempted from SCA verification

creationTimestampinteger required

The time when the transaction was created, expressed in Epoch timestamp using millisecond precision.

scheduledTimestampstring

The epoch timestamp at which the transaction is scheduled to be executed.

executionTimestampstring

The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.

cancellationReasonstring

The reason the scheduled transaction was canceled.

Example response

{
  "id": "123456789",
  "profileId": "10001",
  "tag": "customer-123",
  "source": {
    "id": "123456789",
    "type": "managed_accounts"
  },
  "sourceFee": {
    "currency": "GBP",
    "amount": 1250
  },
  "destination": {
    "id": "123456789",
    "type": "managed_accounts"
  },
  "destinationAmount": {
    "currency": "GBP",
    "amount": 1250
  },
  "destinationFee": {
    "currency": "GBP",
    "amount": 1250
  },
  "transactionAmount": {
    "currency": "GBP",
    "amount": 1250
  },
  "description": "Invoice 1042",
  "creationTimestamp": 1786118400000,
  "scheduledTimestamp": "1786118400000",
  "executionTimestamp": "1786118401250",
  "cancellationReason": "Payment no longer required"
}

Changes

No recorded changes to this operation across all 1 revision of this API.