Allocate funds

Move funds from one organisation's wallet to another — typically from the parent down to a sub-account. The source wallet is debited and the destination credited in the same operation.

Keep the returned requestId: it is the allocationId you need in order to cancel the allocation later.

Authorization

bearerAuth

AuthorizationBearer <token>

The access_token returned by POST /api/v1/get-token.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

fromOrganisationId*string

Organisation the funds are deducted from.

Formatuuid

toOrganisationId*string

Organisation the funds are credited to.

Formatuuid

amount*number

Amount to move between the two wallets.

Response Body

`application/json`

curl -X POST "https://example.com/api/sandbox/v1/allocations/new" \  -H "Content-Type: application/json" \  -d '{    "fromOrganisationId": "4d6e1ea9-5ab8-496a-978f-7e9b2bce80c4",    "toOrganisationId": "b2f0a5ff-e9d8-4347-b46d-6eee8d195617",    "amount": 20  }'

{  "status": 201,  "message": "Created Successfully",  "data": {    "status": "SUCCESS",    "requestId": "ade82d5a-4ab0-4d96-b855-b7f933336f97",    "amount": 20  }}

Allocate funds

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`