Weavr
Powered by Redocly

Transfers

The Transfer transaction is used to transfer funds between managed accounts and managed cards belonging to same identity.

Create a transfer transaction

Transfers funds between managed accounts and managed cards belonging to the same corporate or consumer identity.

The Transfer 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)

The managed account or managed card from where the funds will be transferred.

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

The description details that are included in the transaction as reference.

required
object (InstrumentId)

The managed account or managed card to where the funds will be transferred.

required
object (CurrencyAmount)

The amount, in same currency as the source and destination instruments, to be transferred to the destination (exclusive of any fee amount that may be specified in the profile).

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/transfers
Request samples
application/json
{
  • "profileId": "string",
  • "tag": "string",
  • "source": {
    },
  • "description": "string",
  • "destination": {
    },
  • "destinationAmount": {
    },
  • "scheduledTimestamp": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "profileId": "string",
  • "tag": "string",
  • "source": {
    },
  • "destination": {
    },
  • "destinationAmount": {
    },
  • "description": "string",
  • "state": "INITIALISED",
  • "creationTimestamp": 0,
  • "scheduledTimestamp": "string",
  • "executionTimestamp": "string",
  • "cancellationReason": "string"
}

Get all transfer transactions

Retrieves all the transfer 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 transfer profile. Leave out to fetch all transfer transactions.

object (InstrumentId)

Filter by the source instrument id.

state
Array of strings (TransactionState) unique

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

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

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

createdTo
integer <int64>

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

executedFrom
integer <int64>

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

executedTo
integer <int64>

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

tag
string

Filter by the transfer 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/transfers
Request samples 
Response samples 
application/json
{
  • "transfer": [
    ],
  • "count": 0,
  • "responseCount": 0
}
Cancel transfer transactions
Cancels transfers 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/transfers/bulk/cancel
Request samples 
application/json
{
  • "cancellations": [
    ]
}
Response samples 
application/json
{
  • "cancellations": [
    ]
}
Get a transfer transaction
Retrieve the transfer 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 Transfer 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/transfers/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "profileId": "string",
  • "tag": "string",
  • "source": {
    },
  • "destination": {
    },
  • "destinationAmount": {
    },
  • "description": "string",
  • "state": "INITIALISED",
  • "creationTimestamp": 0,
  • "scheduledTimestamp": "string",
  • "executionTimestamp": "string",
  • "cancellationReason": "string"
}
➔ Next to Outgoing Wire Transfers