Deposits

Balance deposits and payments

Create deposit request

post
/deposits/create

Create a new deposit request

Authorizations
AuthorizationstringRequired

JWT token obtained from login or register endpoint

Body
amountnumber · min: 10RequiredExample: 100
payment_methodstringOptionalDefault: piprapayExample: piprapay
Responses
post
/deposits/create
POST /api/v3/deposits/create HTTP/1.1
Host: localhost:8009
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "amount": 100,
  "payment_method": "piprapay"
}
201

Deposit request created successfully

{
  "success": true,
  "data": {
    "deposit": {
      "id": 1,
      "deposit_id": "DEP-1701234567-1-5678",
      "amount": 100,
      "payment_method": "piprapay",
      "status": "pending",
      "created_at": "2023-12-01 10:30:00",
      "payment_url": "text"
    }
  }
}

Get user deposits

get
/deposits

Retrieve list of user's deposits

Authorizations
AuthorizationstringRequired

JWT token obtained from login or register endpoint

Query parameters
statusstring · enumOptionalPossible values:
pageintegerOptionalDefault: 1
limitintegerOptionalDefault: 20
Responses
200

Deposits retrieved successfully

application/json
get
/deposits
GET /api/v3/deposits HTTP/1.1
Host: localhost:8009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Deposits retrieved successfully

{
  "success": true,
  "data": {
    "deposits": [
      {
        "id": 1,
        "deposit_id": "DEP-1701234567-1-5678",
        "amount": 100,
        "payment_method": "piprapay",
        "status": "pending",
        "created_at": "2023-12-01 10:30:00"
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 20,
      "total": 100,
      "total_pages": 5
    }
  }
}

Get deposit details

get
/deposits/{depositId}

Retrieve detailed information about a deposit

Authorizations
AuthorizationstringRequired

JWT token obtained from login or register endpoint

Path parameters
depositIdstringRequiredExample: DEP-1701234567-1-5678
Responses
200

Deposit details retrieved successfully

application/json
get
/deposits/{depositId}
GET /api/v3/deposits/{depositId} HTTP/1.1
Host: localhost:8009
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Deposit details retrieved successfully

{
  "success": true,
  "data": {
    "deposit": {
      "id": 1,
      "deposit_id": "DEP-1701234567-1-5678",
      "amount": 100,
      "payment_method": "piprapay",
      "status": "pending",
      "created_at": "2023-12-01 10:30:00"
    }
  }
}
PreviousOrdersNextReferrals

Last updated