Offering Manager API

Transaction

POST /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts/{custody_account_id}/transactions

Transaction. The idem_key attribute needs to be unique to guard against double submissions.

Path parameters

  • user_id string Required

    User id

  • custody_account_holder_id string Required

    Custody account holder id

  • custody_account_id string Required

    Custody account id

Body Required

Withdrawal transaction information

  • transaction object
    Hide transaction attributes Show transaction attributes object
    • amount number Required
    • destination_address string Required
    • idem_key string Required
    • reference string

Responses

  • 201

    Returns new transaction record.

    Hide response attributes Show response attributes object
    • id string
    • amount number
    • from_address string
    • destination_address string
    • reference string
    • asset_code string
    • asset_issuer string
    • tx_hash string
    • confirmed_at string(datetime)
    • failed_at string(datetime)
    • created_at string(datetime)
    • status string
    • cursor integer
  • 401

    Authorization information is missing or invalid.

  • 422

    Request body has errors or invalid.

POST /users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts/{custody_account_id}/transactions 
curl \
 -X POST https://client-subdomain.bitbond.net/api/v1/users/{user_id}/custody_account_holders/{custody_account_holder_id}/custody_accounts/{custody_account_id}/transactions \
 -H "Content-Type: application/json" \
 -d '{"transaction":{"amount":42.0,"destination_address":"string","idem_key":"string","reference":"string"}}'
Request example 
{
  "transaction": {
    "amount": 42.0,
    "destination_address": "string",
    "idem_key": "string",
    "reference": "string"
  }
}
Request examples 
{
  "transaction": {
    "amount": 42.0,
    "destination_address": "string",
    "idem_key": "string",
    "reference": "string"
  }
}
Response examples (201) 
{
  "id": "string",
  "amount": 42.0,
  "from_address": "string",
  "destination_address": "string",
  "reference": "string",
  "asset_code": "string",
  "asset_issuer": "string",
  "tx_hash": "string",
  "confirmed_at": "string",
  "failed_at": "string",
  "created_at": "string",
  "status": "string",
  "cursor": 42
}
Response examples (201) 
{
  "id": "string",
  "amount": 42.0,
  "from_address": "string",
  "destination_address": "string",
  "reference": "string",
  "asset_code": "string",
  "asset_issuer": "string",
  "tx_hash": "string",
  "confirmed_at": "string",
  "failed_at": "string",
  "created_at": "string",
  "status": "string",
  "cursor": 42
}