Create a new asset disbursement

POST 
/asset-disbursements

Create a new asset disbursement with Lightning Network payment

Request

application/json

Body

required

accountIduuidrequired

ID of the account making the disbursement

assetIduuidrequired

ID of the asset to disburse

assetTransferMethodIduuidrequired

ID of the transfer method to use

networkFeestringrequired
Network fee for the disbursement
Example: 0.0001
treatAsGrossAmountbooleanrequired

Whether to treat the amount as gross

unitCountstringrequired
Number of units to disburse
Example: 1.0

Responses

201

Asset disbursement created successfully

application/json

Schema

Schema

iduuid
accountIduuid

ID of the account making the disbursement

assetIduuid

ID of the asset being disbursed

userIduuid

ID of the user making the disbursement

assetTransferMethodIduuid

ID of the transfer method used for disbursement

networkFeestring
Network fee for the disbursement
Example: 0.0001
treatAsGrossAmountboolean

Whether to treat the amount as gross (before fees)

unitCountstring
Number of units to disburse
Example: 1.0
createdAtdate-time
updatedAtdate-time

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "assetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "assetTransferMethodId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "networkFee": "0.0001",
  "treatAsGrossAmount": true,
  "unitCount": "1.0",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z"
}

400

Bad Request - Invalid input data

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (from schema)

{
  "message": "Invalid input data",
  "description": "The request data did not pass validation",
  "code": "INVALID_INPUT"
}

401

Unauthorized - Invalid or missing authentication token

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (from schema)

{
  "message": "Unauthorized",
  "description": "Invalid, expired or missing bearer token",
  "code": "UNAUTHORIZED"
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (from schema)

{
  "message": "Forbidden",
  "description": "You don't have permission to access this resource",
  "code": "FORBIDDEN"
}

404

Not Found - Resource not found

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (from schema)

{
  "message": "Resource not found",
  "description": "The requested resource could not be found",
  "code": "NOT_FOUND"
}

409

Conflict - Resource already exists or state conflict

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (from schema)

{
  "message": "Resource conflict",
  "description": "The resource already exists or is in an invalid state",
  "code": "CONFLICT"
}

422

Unprocessable Entity - Validation error

application/json

Schema

Schema

messagestringrequired

Error message

descriptionstring

Detailed error description

codestring

Error code

Example (from schema)

{
  "message": "Validation error",
  "description": "The request data failed validation rules",
  "code": "VALIDATION_ERROR"
}