Get a single asset transfer method

GET 
/asset-transfer-method/:id

Retrieve details of a specific asset transfer method

Request

Path Parameters

id uuidrequired

ID of the asset transfer method to retrieve

Responses

200

Asset transfer method retrieved successfully

application/json

Schema

Schema

iduuid
accountIduuid

ID of the associated account

assetIduuid

ID of the asset being transferred

singleUseboolean
Whether this transfer method can be used multiple times
Default value: true
assetTransferTypestring
Type of the asset transfer (BITCOIN or BITCOIN_LIGHTNING)
Possible values: [BITCOIN, BITCOIN_LIGHTNING]
Default value: BITCOIN
transferDirectionstring
Direction of the transfer (INCOMING or OUTGOING)
Possible values: [INCOMING, OUTGOING]
Default value: INCOMING
labelstring

Optional label for the transfer method

Possible values: <= 255 characters

tagstring

Optional tag for the transfer method

Possible values: <= 255 characters

invoicestring

Lightning invoice payment request string

Possible values: <= 639 characters

unitCountExpectednumeric

Expected amount in base units (e.g., satoshis)

createdAtdate-time
updatedAtdate-time
expiresAtdate-time

Expiration time of the transfer method

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "assetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "singleUse": true,
  "assetTransferType": "BITCOIN",
  "transferDirection": "INCOMING",
  "label": "string",
  "tag": "string",
  "invoice": "string",
  "unitCountExpected": "string",
  "createdAt": "2024-07-29T15:51:28.071Z",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "expiresAt": "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"
}