Operations

Create a user

Submit the details for the creation of a batch of Authorised Users

The bulkId returned in the response can subsequently be used to launch the creation of the bulk process through bulkIdExecute process. A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any other Authorised User of the same identity of the user that submits the details.

The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation.

The submission of data for a bulk process does not expire but it can be cancelled through bulkIdCancel

The system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations

Each create Authorised User operation in this bulk process is processed via userCreate

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

Array ([ 1 .. 10000 ] items)

pathParams	object
	object

Responses

201

Success - returning bulk process

post/bulks/users

Request samples

application/json

[{"pathParams": { },
"requestBody": {"name": "string",
"surname": "string",
"email": "user@example.com",
"mobile": {"countryCode": "string",
"number": "string"
},
"dateOfBirth": {"year": 1900,
"month": 1,
"day": 1
},
"tag": "string"
}
}
]

Response samples

201

application/json

{"bulkId": "string",
"operationCount": 0,
"path": "string"
}

Send a user invite

Submit the details for the creation of a batch of Authorised User invites

The bulkId returned in the response can subsequently be used to launch the creation of the bulk process through bulkIdExecute. A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any other Authorised User of the same identity of the user that submits the details.

The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation.

The submission of data for a bulk process does not expire but it can be cancelled through bulkIdCancel

The system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations

Each create authorised user operation in this bulk process is processed via userInviteSend.

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

Array ([ 1 .. 10000 ] items)

object

Responses

201

Success - returning bulk process

post/bulks/users/_user_id_/invite

Request samples

application/json

[{"pathParams": {"_user_id_": "string"
}
}
]

Response samples

201

application/json

{"bulkId": "string",
"operationCount": 0,
"path": "string"
}

Update spend rules for a managed card

Submit the details to update the spend rules of Managed Cards

The bulkId returned in the response can subsequently be used to launch the updating of Managed Card spend rules process through . A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any other Authorised User of the same identity of the user that submits the details.

The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation.

The submission of data for a bulk process does not expire but it can be cancelled through

The system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations

Each spend rules update operation in this bulk process is processed via Update a Managed Card

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

Array ([ 1 .. 10000 ] items)

	object
	object (UpdateCardLevelSpendRules)

Responses

201

Success - returning bulk process

patch/bulks/managed_cards/_id_/spend_rules

Request samples

application/json

[{"pathParams": {"_id_": "string"
},
"requestBody": {"allowedMerchantCategories": ["string"
],
"blockedMerchantCategories": ["string"
],
"allowedMerchantIds": ["string"
],
"blockedMerchantIds": ["string"
],
"allowedMerchantCountries": ["st"
],
"blockedMerchantCountries": ["st"
],
"allowContactless": true,
"allowAtm": true,
"allowECommerce": true,
"allowCashback": true,
"allowCreditAuthorisations": true,
"spendLimit": [{"value": {"currency": "str",
"amount": 0
},
"interval": "DAILY"
}
],
"minTransactionAmount": 0,
"maxTransactionAmount": 0,
"updateSpendLimitMethod": "OVERWRITE"
}
}
]

Response samples

201

application/json

{"bulkId": "string",
"operationCount": 0,
"path": "string"
}

Create a send transaction

Submit the details for the creation of a batch of Sends.

The bulkId returned in the response can subsequently be used to launch the creation of the bulk process through bulkIdExecute process. A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any other Authorised User of the same identity of the user that submits the details.

The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation.

The submission of data for a bulk process does not expire but it can be cancelled through bulkIdCancel.

The system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations.

Each create Outgoing Wire Transfer operation in this bulk process is processed via sendCreate.

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

Array ([ 1 .. 10000 ] items)

pathParams	object
	object (SendCreateRequest)

Responses

201

Success - returning bulk process

post/bulks/sends

Request samples

application/json

[{"pathParams": { },
"requestBody": {"profileId": "string",
"tag": "string",
"source": {"id": "string",
"type": "managed_cards"
},
"destination": {"id": "string",
"type": "managed_cards"
},
"destinationAmount": {"currency": "str",
"amount": 0
},
"description": "string",
"scheduledTimestamp": "string"
}
}
]

Response samples

201

application/json

{"bulkId": "string",
"operationCount": 0,
"path": "string"
}

Create an outgoing wire transfer

Submit the details for the creation of a batch of Outgoing Wire Transfers.

The bulkId returned in the response can subsequently be used to launch the creation of the bulk process through bulkIdExecute process. A submitted bulk process can be managed (executed, accessed, paused, resumed and cancelled) by any other Authorised User of the same identity of the user that submits the details.

The status of the bulk process after execution of this operation is set to ‘SUBMITTED’. The execution of the bulk process is launched through the Execute bulk process operation.

The submission of data for a bulk process does not expire but it can be cancelled through bulkIdCancel.

The system is configured to accept bulk requests to process up to a maximum of 10,000 bulk operations.

Each create Outgoing Wire Transfer operation in this bulk process is processed via outgoingWireTransferCreate.

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

Array ([ 1 .. 10000 ] items)

pathParams	object
	object (OutgoingWireTransferCreateRequest)

Responses

201

Success - returning bulk process

post/bulks/outgoing_wire_transfers

Request samples

application/json

[{"pathParams": { },
"requestBody": {"profileId": "string",
"tag": "string",
"sourceInstrument": {"type": "managed_accounts",
"id": "string"
},
"transferAmount": {"currency": "str",
"amount": 0
},
"description": "string",
"destinationBeneficiary": {"name": "string",
"address": "string",
"bankName": "string",
"bankAddress": "string",
"bankCountry": "st",
"bankAccountDetails": {"iban": "stringstringstr",
"bankIdentifierCode": "stringst"
}
},
"scheduledTimestamp": "string"
}
}
]

Response samples

201

application/json

{"bulkId": "string",
"operationCount": 0,
"path": "string"
}