Retrieve Partner Information

This endpoint allows you to retrieve information about your account in the Peex system. You will be able to see your balance and fees that are applicable for billings.

Overview

The partner information endpoint provides essential account details needed for transaction processing and account management.

Key Information Retrieved:

Account status (is_activated)
Partner details (name, email, description)
Account timestamps

Request

Method: GET

URL: {{base_url}}disbursement/me

Headers:

SECRETKEY: Your API secret key
Content-Type: application/json

Parameters: None required - just provide the secret key in the request header.

cURL Request

curl -X GET \
  https://sandbox.peexit.com/api/v1/disbursement/me \
  -H 'SECRETKEY: ########-####-####-####-############' \
  -H 'Content-Type: application/json'

Response

Status 200 - Success

The result will contain information about your account including:

name: Partner name
email: Partner email address
address: Partner address
web_site: Partner website
description: Account description
callback_url: Webhook URL
disbursement_solde: Current account balance
orange_fees: Orange network fees
mtn_fees: MTN network fees
is_activated: Account activation status
created_at: Account creation timestamp
updated_at: Last update timestamp

Success Response

{
  "name": "peex",
  "email": "peex@peex.com",
  "address": "string",
  "web_site": "",
  "description": "fintech",
  "callback_url": null,
  "disbursement_solde": 1000,
  "orange_fees": 0,
  "mtn_fees": 0,
  "is_activated": true,
  "created_at": "2020-10-23T14:40:41.6592",
  "updated_at": "2025-01-30T10:07:14.3612"
}

Error Handling

Status 401 - Unauthorized

This means you're not authorized to make requests on the server. This could happen if:

You have not provided a correct secret key
Your secret key is wrong or expired
The secret key format is incorrect

Solution: Verify your secret key and ensure it's correctly set in the request header.

Error Response

{
  "error": {
    "statusCode": 401,
    "name": "UnauthorizedError",
    "message": "The key provided doest not exists in our system"
  }
}

Use Cases

This endpoint is commonly used for:

Dashboard Display - Show account balance and status
Pre-transaction Checks - Verify sufficient balance before payments
Fee Calculation - Get current fee rates for cost estimation
Account Monitoring - Regular health checks of account status

Next Steps

After retrieving your partner information, you can proceed with:

Verify a Wallet Disbursement Check History