Weavr
Powered by Redocly

Sends

The Send transaction is used to send funds between managed accounts and managed cards belonging to different identities.

Create a send transaction

Sends funds between managed accounts and managed cards belonging to different corporate or consumer identities.

The Send Profile (configured in the Multi Portal) specified determines the behaviour and restrictions of the transaction (for example, fees).

Securityauth_token and api_key
Request
header Parameters
idempotency-ref
string

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

Request Body schema: application/json
required
profileId
required
string (ProfileId) ^[0-9]+$

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.

tag
string (Tag) <= 50 characters ^[a-zA-Z0-9_-]+$

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

required
object (InstrumentId)
required
InstrumentId (object) or BeneficiaryId (object)
required
object (CurrencyAmount)

The object representing a monetary amount in a particular currency.

description
string <= 255 characters ^[a-zA-Z0-9\\/\\-?:().$_,'+\\s#=!\"%&*<>;\\{@...

The description details that are passed to the beneficiary.

scheduledTimestamp
string (ScheduledTimestamp) ^[0-9]+$

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

Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

409

Conflict

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

post/sends
Request samples
application/json
{
  • "profileId": "string",
  • "tag": "string",
  • "source": {
    },
  • "destination": {
    },
  • "destinationAmount": {
    },
  • "description": "string",
  • "scheduledTimestamp": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "profileId": "string",
  • "tag": "string",
  • "source": {
    },
  • "sourceFee": {
    },
  • "destination": {
    },
  • "destinationAmount": {
    },
  • "destinationFee": {
    },
  • "transactionAmount": {
    },
  • "description": "string",
  • "state": "INVALID",
  • "challengeExemptionReason": "LOW_VALUE",
  • "creationTimestamp": 0,
  • "scheduledTimestamp": "string",
  • "executionTimestamp": "string",
  • "cancellationReason": "string"
}

Get all send transactions

Retrieves all the send transactions performed by the logged-in identity.

Securityauth_token and api_key
Request
query Parameters
offset
integer <int32> >= 0

The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

limit
integer <int32> [ 1 .. 100 ]

The limit of the results for paging, starting at the offset. Limit is always capped at 100.

profileId
string (ProfileId) ^[0-9]+$

Filter by the Send profile. Leave out to fetch all entries.

object (InstrumentId)

Filter by the source instrument id.

source.id
string (Id) ^[0-9]+$

Filter by the source instrument id. Must be specified when source.type is provided.

source.type
string (InstrumentType)

Filter by the source instrument type. Must be specified when source.id is provided.

Enum: "managed_cards" "managed_accounts"
state
Array of strings (SendState) unique

Filter by the Send transaction state. Leave out to fetch all states.

Items Enum: "INVALID" "INITIALISED" "COMPLETED" "REJECTED" "FAILED" "PENDING" "PENDING_CHALLENGE" "APPROVED" "RETURNED" "SCHEDULED" "CANCELLED"
createdFrom
integer <int64>

Filter for send transactions created after createdFrom timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

createdTo
integer <int64>

Filter for send transactions created before createdTo timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

executedFrom
integer <int64>

Filter for send transactions executed after executedFrom timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

executedTo
integer <int64>

Filter for send transactions executed before executedTo timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all Send transactions.

tag
string

Filter by the send tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all entries.

Responses
200

Success

400

Bad Request Error - Your request is invalid.

401

Unauthorized - Your credentials or access token are invalid.

403

Forbidden - Access to the requested resource or action is forbidden.

429

Too many requests.

500

Internal Server Error - There is a problem with the server. Please try again later.

503

Service Unavailable - We're temporarily offline for maintenance. Please try again later.

default

Error

get/sends
Request samples 
Response samples 
application/json
{
  • "send": [
    ],
  • "count": 0,
  • "responseCount": 0
}
Create a bulk of send transactionsDeprecated
Deprecated in favour of the Operations in Bulk.


Sends funds between multiple managed accounts and managed cards belonging to different corporate or consumer identities.


The Send Profile (configured in the Multi Portal) specified determines the behaviour and restrictions of the transaction (for example, fees).


Securityauth_token and api_key 
Request 
header Parameters
idempotency-ref
string
A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.


 
Request Body schema: application/json
required
required
Array of objects (SendCreateRequest) 
The object representing the sends' details.


 
Responses 
200
Success


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


409
Conflict


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/sends/bulk/create
Request samples 
application/json
{
  • "sends": [
    ]
}
Response samples 
application/json
{
  • "response": [
    ]
}
Cancel send transactions
Cancels send transactions that are scheduled to be executed in the future.


Securityauth_token and api_key 
Request 
Request Body schema: application/json
required
required
Array of objects (TransactionCancelRequest) 
Contains the details of the transactions to be cancelled.


 
Responses 
200
Success


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/sends/bulk/cancel
Request samples 
application/json
{
  • "cancellations": [
    ]
}
Response samples 
application/json
{
  • "cancellations": [
    ]
}
Get a send transaction
Retrieve the send transaction identified by the id path parameter.


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the Send transaction.


 
Responses 
200
Success


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


404
Not found - The requested resource couldn't be found.


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


get/sends/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "profileId": "string",
  • "tag": "string",
  • "source": {
    },
  • "sourceFee": {
    },
  • "destination": {
    },
  • "destinationAmount": {
    },
  • "destinationFee": {
    },
  • "transactionAmount": {
    },
  • "description": "string",
  • "state": "INVALID",
  • "challengeExemptionReason": "LOW_VALUE",
  • "creationTimestamp": 0,
  • "scheduledTimestamp": "string",
  • "executionTimestamp": "string",
  • "cancellationReason": "string"
}
Issue a one-time password that can be used to verify a sendDeprecated
Deprecated in favour of Challenges endpoints


Starts the verification process for a send in which a one-time password is sent to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/otp/{channel} endpoint.


You should only start this process if the send state is PENDING_CHALLENGE.


Note that on the Sandbox Environment, text messages are not sent and the one-time-password is always "123456".


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the send transaction.


 
channel
required
string (SCAOtpChannel) 
The unique identifier for the channel.


 Value: "SMS"  
Responses 
204
Success - No Content.


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


405
Method Not Allowed - The request was received but has been rejected for the requested resource.


409
Conflict


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/sends/{id}/challenges/otp/{channel}
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
Verify a send using a one-time passwordDeprecated
Deprecated in favour of Challenges endpoints


Completes the verification process for a Send.


If the outcome of the verification is successful, the send is executed.


If not verified challenge expires after 5 minutes and the number of incorrect OTP attempts is limited to reduce the risk of fraud.


Note that on the Sandbox Environment, text messages are not sent and the verificationCode is always "123456".


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the send transaction.


 
channel
required
string (SCAOtpChannel) 
The unique identifier for the channel.


 Value: "SMS"  
Request Body schema: application/json
required
verificationCode
required
string (Nonce) ^[0-9]{6}$
The code received by the user on the device.


 
Responses 
204
Success - No Content.


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


409
Conflict


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/sends/{id}/challenges/otp/{channel}/verify
Request samples 
application/json
{
  • "verificationCode": "string"
}
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
Issue a push notification that can be used to verify Send transactionDeprecated
Deprecated in favour of Challenges endpoints


Starts the verification process for a Send in which a push notification is sent to a device belonging to the logged-in user that was previously enrolled through the /authentication_factors/push/{channel} endpoint.


You should only start this process if the Send transaction state is PENDING_CHALLENGE.


Securityauth_token and api_key 
Request 
path Parameters
id
required
string^[0-9]+$
The unique identifier of the send transaction.


 
channel
required
string (SCAPushChannel) 
    

  • "AUTHY": The push notification is sent on the user's device using Twilio Authy
    • 

  • "BIOMETRIC": The push notification is sent to the user's device
    • 



 Enum: "AUTHY" "BIOMETRIC"  
Responses 
204
Success - No Content.


400
Bad Request Error - Your request is invalid.


401
Unauthorized - Your credentials or access token are invalid.


403
Forbidden - Access to the requested resource or action is forbidden.


405
Method Not Allowed - The request was received but has been rejected for the requested resource.


409
Conflict


429
Too many requests.


500
Internal Server Error - There is a problem with the server. Please try again later.


503
Service Unavailable - We're temporarily offline for maintenance. Please try again later.


default
Error


post/sends/{id}/challenges/push/{channel}
Request samples 
Response samples 
application/json
{
  • "message": "string",
  • "syntaxErrors": {
    }
}
➔ Next to Transfers