Transfers funds from managed accounts to an external bank account.
The Outgoing Wire Transfer Profile (configured in the Multi Portal) specified determines the behaviour and restrictions of the transaction (for example, fees).
Note that even if the transaction is created successfully, you still need to check its state in order to determine if it is pending completion of an authentication challenge by the user.
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.
The tag field is a custom field that can be used to search and filter.
The amount, in same currency as source and destination, that was transferred from the source.
The purpose of the payment. Mandatory for wire transfers executed over SWIFT.
These details are passed to the beneficiary as the reference . This field is mandatory for wire transfers executed over SEPAand SWIFT. The allowed length is dependent on the payment type:
SEPA <= 35 characters. An extended character set is accepted to cater for all European languages. If SEPA does not support a particular character, it is automatically converted to an acceptable alternative, in line with SEPA scheme guidance.
SWIFT <= 35 characters
Faster Payments <= 18 characters
Details of the beneficiary of the outgoing wire transfer. Deprecated: Use SEPABeneficiary for SEPA/IBAN transfers or FasterPaymentsBeneficiary for Faster Payments transfers instead.
- Weavr Sandbox Environmenthttps://sandbox.weavr.io/multi/outgoing_wire_transfers
- Mock serverhttps://api.weavr.io/_mock/products/multi/openapi/outgoing_wire_transfers
curl -i -X POST \
https://sandbox.weavr.io/multi/outgoing_wire_transfers \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'api-key: YOUR_API_KEY_HERE' \
-H 'idempotency-ref: string' \
-d '{
"profileId": "string",
"tag": "string",
"sourceInstrument": {
"type": "managed_accounts",
"id": "string"
},
"transferAmount": {
"currency": "str",
"amount": 0
},
"purpose": "string",
"description": "string",
"destinationBeneficiary": {
"name": "string",
"type": "PERSONAL",
"address": "string",
"bankName": "string",
"bankAddress": "string",
"bankCountry": "st",
"bankAccountDetails": {
"iban": "stringstringstr",
"bankIdentifierCode": "stringst"
},
"nationality": "st",
"dateOfBirth": "2019-08-24"
},
"scheduledTimestamp": "string"
}'Success
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.
The tag field is a custom field that can be used to search and filter.
The amount, in same currency as source and destination, that was transferred from the source.
The fee charged on this outgoing wire transfer. Omitted when no fee was charged.
The wire transfer rails used, from SEPA, Faster Payments, SWIFT or RIX.
Details of the beneficiary of the outgoing wire transfer. Deprecated: Use SEPABeneficiary for SEPA/IBAN transfers or FasterPaymentsBeneficiary for Faster Payments transfers instead.
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.
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.
The Reason the transaction was exempted from SCA verification
The time when the transaction was created, expressed in Epoch timestamp using millisecond precision.
The epoch timestamp at which the transaction is scheduled to be executed.
The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.
The reason the scheduled transaction was cancelled.
{ "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": [ { … } ] }