gobtc payDocs

Business Profile

The merchant's public business profile, display name, description, category, support email, and logo.

Get profile

POSThttps://api.gobtcpay.com/public/api/v1.2/merchant/profile/get

Returns the merchant's business profile, legalName (read-only), displayName, description, category, supportEmail, and logoUrl.

Authorization: merchantAuth

Responses

idstringrequired
Example:3fa85f64-5717-4562-b3fc-2c963f66afa6
resultobjectrequired
POST /merchant/profile/get
cURL
curl -X POST "$BASE_URL/merchant/profile/get" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
200 Successful response
JSON
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "result": {
    "$case": "success",
    "success": {
      "profile": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "legalName": "string",
        "displayName": "Satoshi Coffee",
        "description": "Order #1024",
        "category": "string",
        "supportEmail": "string",
        "logoUrl": "string"
      }
    }
  }
}

Update profile

POSThttps://api.gobtcpay.com/public/api/v1.2/merchant/profile/update

Updates the editable business profile fields (displayName, description, category, supportEmail). Admin only. Returns the updated profile.

Authorization: merchantAuth

Body required

application/json
displayNamestring

Public display name shown to payers (optional).

Example:Satoshi Coffee
descriptionstring

Human-readable description.

Example:Order #1024
categorystring

Business category, or null.

Example:string
supportEmailstring

Public support email address, or null.

Example:string

Responses

idstringrequired
Example:3fa85f64-5717-4562-b3fc-2c963f66afa6
resultobjectrequired
POST /merchant/profile/update
cURL
curl -X POST "$BASE_URL/merchant/profile/update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
  "displayName": "Satoshi Coffee",
  "description": "Order #1024",
  "category": "string",
  "supportEmail": "string"
}'
200 Successful response
JSON
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "result": {
    "$case": "success",
    "success": {
      "profile": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "legalName": "string",
        "displayName": "Satoshi Coffee",
        "description": "Order #1024",
        "category": "string",
        "supportEmail": "string",
        "logoUrl": "string"
      }
    }
  }
}

Upload logo

POSThttps://api.gobtcpay.com/public/api/v1.2/merchant/profile/logo/upload

Uploads the merchant logo (PNG / JPG / SVG, ≤2MB) as base64 fileBase64. Returns the hosted logoUrl.

Authorization: merchantAuth

Body required

application/json
fileBase64stringrequired

Logo image as a base64-encoded payload (PNG / JPG / SVG, ≤2MB).

Example:string
mimeTypestring

MIME type of the uploaded file, e.g. image/png.

Example:string

Responses

idstringrequired
Example:3fa85f64-5717-4562-b3fc-2c963f66afa6
resultobjectrequired
POST /merchant/profile/logo/upload
cURL
curl -X POST "$BASE_URL/merchant/profile/logo/upload" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
  "fileBase64": "string",
  "mimeType": "string"
}'
200 Successful response
JSON
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "result": {
    "$case": "success",
    "success": {
      "logoUrl": "string"
    }
  }
}

Delete logo

POSThttps://api.gobtcpay.com/public/api/v1.2/merchant/profile/logo/delete

Removes the merchant logo. Returns { ok }.

Authorization: merchantAuth

Responses

idstringrequired
Example:3fa85f64-5717-4562-b3fc-2c963f66afa6
resultobjectrequired
POST /merchant/profile/logo/delete
cURL
curl -X POST "$BASE_URL/merchant/profile/logo/delete" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN"
200 Successful response
JSON
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "result": {
    "$case": "success",
    "success": {
      "ok": true
    }
  }
}