POST
/
v0
/
internal-transfer
Initiate Internal Transfer
curl --request POST \
  --url https://api.zebedee.io/v0/internal-transfer \
  --header 'Content-Type: application/json' \
  --header 'apikey: <apikey>' \
  --data '{
  "amount": "<string>",
  "receiverWalletId": "<string>"
}'
{
    "success": true,
    "data": {
        "id": "c8571a4c-3c34-47af-8ded-ebd476f519c1",
        "senderWalletId": "b81fa874-ac60-4a08-84f2-0af79684c506",
        "receiverWalletId": "b804ee02-ec0b-4fd4-b99f-1f2d3d0001a6",
        "userId": "2470d896-9dc8-4d49-b18c-a4e83263e76d",
        "sendTxId": "f532db20-2cfa-41b0-8c00-40cfbe124b54",
        "receiveTxId": "4b4640e0-d8a2-4f1e-8973-d98196f79a88",
        "status": "TRANSFER_STATUS_COMPLETED",
        "amount": "1000",
        "createdAt": "2023-02-16T02:28:32.754Z",
        "updatedAt": "2023-02-16T02:28:32.777Z"
    },
    "message": "Internal Transfer done."
}

Usage

The API Key used is the Project Wallet that is SPENDING the funds, so the apikey used in this request must be the SENDER Project Wallet. In the body payload, the API also expects a receiverWalletId. This Project Wallet ID has to match the RECEIVING Project Wallet ID, which can be found in the ZBD Developer Dashboard under Project Details. This API is primarily to be used for any programmatic movement of funds between any two of your Projects.

Configuration

Header Parameters

apikey
string
required
ZBD Project API Key
Content-Type
string
Content Type

Body

amount
string
required
The amount to be transferred -> in millisatoshis
receiverWalletId
string
required
The Wallet ID of the recipient Project
{
    "success": true,
    "data": {
        "id": "c8571a4c-3c34-47af-8ded-ebd476f519c1",
        "senderWalletId": "b81fa874-ac60-4a08-84f2-0af79684c506",
        "receiverWalletId": "b804ee02-ec0b-4fd4-b99f-1f2d3d0001a6",
        "userId": "2470d896-9dc8-4d49-b18c-a4e83263e76d",
        "sendTxId": "f532db20-2cfa-41b0-8c00-40cfbe124b54",
        "receiveTxId": "4b4640e0-d8a2-4f1e-8973-d98196f79a88",
        "status": "TRANSFER_STATUS_COMPLETED",
        "amount": "1000",
        "createdAt": "2023-02-16T02:28:32.754Z",
        "updatedAt": "2023-02-16T02:28:32.777Z"
    },
    "message": "Internal Transfer done."
}