Get user - Bread

GET

user

Get user

curl --request GET \
  --url https://processor-prod.up.railway.app/user \
  --header 'x-service-key: <api-key>'

{
  "success": true,
  "status": 200,
  "message": "User fetched successfully",
  "timestamp": "2025-09-28T15:51:44.040Z",
  "data": {
    "id": "68bb7d8399900e253084e6f7",
    "code": 7827605055,
    "name": "Bread",
    "email": "[email protected]",
    "fee": {
      "type": "percentage",
      "value": 0.5,
      "max": 1000,
      "min": 0.05
    },
    "is_active": true,
    "key": "8F7MFnbHcIGFqfexc3Gel1yw8F7MFnbHcIGudjOe",
    "webhook": {
      "enabled": false,
      "url": "https://example.com/webhook",
      "secret": "z9o4j778vsn5ivog9beUdj2849"
    },
    "fee_wallet": {
      "id": "68bb7d8399900e3849sj8393",
      "reference": "akzp20tn43bbixatfpl65zg9sqa0c2",
      "is_active": true,
      "address": {
        "evm": "0x214C05B7917A4dCf787b2bfA13C6bE27f0A9A250",
        "svm": "GfC8jFidowznLTBbQWKjJkQBEbNdSyxucNsi7ydyMjdi"
      }
    },
    "settlement_wallet": {
      "id": "68bb7d8399900e3849sj8393",
      "reference": "akzp20tn43bbixatfpl65zg9sqa0c2",
      "is_active": true,
      "address": {
        "evm": "0x214C05B7917A4dCf787b2bfA13C6bE27f0A9A250",
        "svm": "GfC8jFidowznLTBbQWKjJkQBEbNdSyxucNsi7ydyMjdi"
      }
    }
  }
}

Authorizations

x-service-key

string

header

required

Response

200 - application/json

User fetched successfully

success

boolean

Example:

true

status

integer

Example:

200

message

string

Example:

"User fetched successfully"

timestamp

string<date-time>

Example:

"2025-09-28T15:51:44.040Z"

data

object

Show child attributes

data.id

string

Unique identifier for the user

Example:

"68bb7d8399900e253084e6f7"

data.code

integer

User code

Example:

7827605055

data.name

string

User name

Example:

"Bread"

data.email

string<email>

User email address

Example:

"[email protected]"

data.fee

object

Show child attributes

data.fee.type

string

Fee type

Example:

"percentage"

data.fee.value

number

Fee value

Example:

0.5

data.fee.max

number

Maximum fee amount

Example:

1000

data.fee.min

number

Minimum fee amount

Example:

0.05

data.is_active

boolean

Whether the user account is active

Example:

true

data.key

string

API key for the user

Example:

"8F7MFnbHcIGFqfexc3Gel1yw8F7MFnbHcIGudjOe"

data.webhook

object

Show child attributes

data.webhook.enabled

boolean

Whether webhook is enabled

Example:

false

data.webhook.url

string

Webhook URL

Example:

"https://example.com/webhook"

data.webhook.secret

string

Webhook secret key

Example:

"z9o4j778vsn5ivog9beUdj2849"

data.fee_wallet

object

Show child attributes

data.fee_wallet.id

string

Wallet ID

Example:

"68bb7d8399900e3849sj8393"

data.fee_wallet.reference

string

Wallet reference

Example:

"akzp20tn43bbixatfpl65zg9sqa0c2"

data.fee_wallet.is_active

boolean

Whether the wallet is active

Example:

true

data.fee_wallet.address

object

Show child attributes

data.fee_wallet.address.evm

string

EVM address

Example:

"0x214C05B7917A4dCf787b2bfA13C6bE27f0A9A250"

data.fee_wallet.address.svm

string

SVM address

Example:

"GfC8jFidowznLTBbQWKjJkQBEbNdSyxucNsi7ydyMjdi"

data.settlement_wallet

object

Show child attributes

data.settlement_wallet.id

string

Wallet ID

Example:

"68bb7d8399900e3849sj8393"

data.settlement_wallet.reference

string

Wallet reference

Example:

"akzp20tn43bbixatfpl65zg9sqa0c2"

data.settlement_wallet.is_active

boolean

Whether the wallet is active

Example:

true

data.settlement_wallet.address

object

Show child attributes

data.settlement_wallet.address.evm

string

EVM address

Example:

"0x214C05B7917A4dCf787b2bfA13C6bE27f0A9A250"

data.settlement_wallet.address.svm

string

SVM address

Example:

"GfC8jFidowznLTBbQWKjJkQBEbNdSyxucNsi7ydyMjdi"

Create userThis endpoint allows you to create a new user account.

⌘I

Get user

curl --request GET \
  --url https://processor-prod.up.railway.app/user \
  --header 'x-service-key: <api-key>'

{
  "success": true,
  "status": 200,
  "message": "User fetched successfully",
  "timestamp": "2025-09-28T15:51:44.040Z",
  "data": {
    "id": "68bb7d8399900e253084e6f7",
    "code": 7827605055,
    "name": "Bread",
    "email": "[email protected]",
    "fee": {
      "type": "percentage",
      "value": 0.5,
      "max": 1000,
      "min": 0.05
    },
    "is_active": true,
    "key": "8F7MFnbHcIGFqfexc3Gel1yw8F7MFnbHcIGudjOe",
    "webhook": {
      "enabled": false,
      "url": "https://example.com/webhook",
      "secret": "z9o4j778vsn5ivog9beUdj2849"
    },
    "fee_wallet": {
      "id": "68bb7d8399900e3849sj8393",
      "reference": "akzp20tn43bbixatfpl65zg9sqa0c2",
      "is_active": true,
      "address": {
        "evm": "0x214C05B7917A4dCf787b2bfA13C6bE27f0A9A250",
        "svm": "GfC8jFidowznLTBbQWKjJkQBEbNdSyxucNsi7ydyMjdi"
      }
    },
    "settlement_wallet": {
      "id": "68bb7d8399900e3849sj8393",
      "reference": "akzp20tn43bbixatfpl65zg9sqa0c2",
      "is_active": true,
      "address": {
        "evm": "0x214C05B7917A4dCf787b2bfA13C6bE27f0A9A250",
        "svm": "GfC8jFidowznLTBbQWKjJkQBEbNdSyxucNsi7ydyMjdi"
      }
    }
  }
}

API reference

Authorizations

Response