Skip to content
/
Cancel an outgoing wire t...

Cancel an outgoing wire transfer transaction

Request

Cancel the outgoing wire transfer identified by the id path parameter.

Security
auth_token and api-key
Path
idstring^[0-9]+$required

The unique identifier of the Outgoing Wire Transfer transaction.

Bodyapplication/json
cancellationReasonstring, <= 50 characters(TransactionCancellationReason)^[ a-zA-Z0-9_-]+$

The reason the scheduled transaction was cancelled.

curl -i -X POST \
  'https://sandbox.weavr.io/multi/outgoing_wire_transfers/{id}/cancel' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -d '{
    "cancellationReason": "string"
  }'

Responses

Success

Headers
request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Bodyapplication/json
idstring^[0-9]+$required

The unique identifier of an Outgoing Wire Transfer transaction.

profileIdstring(ProfileId)^[0-9]+$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, <= 50 characters(Tag)^[a-zA-Z0-9_-]+$

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

sourceInstrumentobjectrequired

The source managed account from where the funds were taken.

transferAmountobject(CurrencyAmount)required

The amount, in same currency as source and destination, that was transferred from the source.

feeobject(CurrencyAmount)

The fee charged on this outgoing wire transfer. Omitted when no fee was charged.

purposestring, <= 255 characters

The purpose of the payment.

descriptionstring, <= 50 characters

Transaction description.

typestring(OutgoingWireTransferType)

The wire transfer rails used, from SEPA, Faster Payments, SWIFT or RIX.

Enum:"SEPA""FASTER_PAYMENTS""SWIFT""RIX"
destinationOutgoingWireTransferBeneficiary (object) or SEPABeneficiary (object) or SWIFTBeneficiary (object) or RIXBeneficiary (object) or FasterPaymentsBeneficiary (object) or BeneficiaryId (object) or ExternalAccountId (object)
One of:

Details of the beneficiary of the outgoing wire transfer. Deprecated: Use SEPABeneficiary for SEPA/IBAN transfers or FasterPaymentsBeneficiary for Faster Payments transfers instead.

statestring(OutgoingWireTransferState)required

The state of the Outgoing wire transfer transaction, as follows:

  • INVALID: The wire transfer has failed initial validation checks.
  • PENDING_CHALLENGE: The wire transfer requires the completion of a transaction confirmation challenge before it can be submitted.
  • SUBMITTED: The wire transfer has been submitted to the sending financial institution for processing.
  • REJECTED: The wire transfer that was submitted was rejected.
  • APPROVED: The wire transfer that was submitted has been approved and is being processed by the sending financial institution.
  • FAILED: There was an issue with the wire transfer, and the transaction has failed.
  • COMPLETED: The requested funds have been sent from the source instrument.
  • RETURNED: The wire transfer has been returned to the sender.
  • SCHEDULED: The wire transfer will be executed at the scheduled time.
  • CANCELLED: The scheduled wire transfer has been cancelled.
  • PENDING_CONFIRMATION: The wire transfer requires a manual confirmation by the user before proceeding.
Enum:"INVALID""PENDING_CHALLENGE""SUBMITTED""REJECTED""APPROVED""FAILED""COMPLETED""RETURNED""SCHEDULED""CANCELLED"
rejectedInfostring(OutgoingWireTransferRejectedInfo)

Additional info when the outgoing wire transfer has been rejected, as follows:

  • SYSTEM: The wire transfer was rejected by the system.
  • USER: The wire transfer was rejected by the user.
Enum:"SYSTEM""USER"
challengeExemptionReasonstring(ChallengeExemptionReason)

The Reason the transaction was exempted from SCA verification

Enum:"LOW_VALUE""TRUSTED_BENEFICIARY"
creationTimestampinteger, (int64)required

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

scheduledTimestampstring(ScheduledTimestamp)^[0-9]+$

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

executionTimestampstring(ExecutionTimestamp)^[0-9]+$

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

cancellationReasonstring, <= 50 characters(TransactionCancellationReason)^[ a-zA-Z0-9_-]+$

The reason the scheduled transaction was cancelled.

validationOutcomesArray of objects(OutgoingWireTransferValidationOutcome)
Response
{
  "id": "string",
  "profileId": "string",
  "tag": "string",
  "sourceInstrument": {
    "type": "managed_accounts",
    "id": "string"
  },
  "transferAmount": {
    "currency": "str",
    "amount": 0
  },
  "fee": {
    "currency": "str",
    "amount": 0
  },
  "purpose": "string",
  "description": "string",
  "type": "SEPA",
  "destination": {
    "name": "string",
    "type": "PERSONAL",
    "address": "string",
    "bankName": "string",
    "bankAddress": "string",
    "bankCountry": "st",
    "bankAccountDetails": { … },
    "nationality": "st",
    "dateOfBirth": "2019-08-24"
  },
  "state": "INVALID",
  "rejectedInfo": "SYSTEM",
  "challengeExemptionReason": "LOW_VALUE",
  "creationTimestamp": 0,
  "scheduledTimestamp": "string",
  "executionTimestamp": "string",
  "cancellationReason": "string",
  "validationOutcomes": [
    { … }
  ]
}