Settlement - MineSec Developer Docs

The Settlement API allows you to manage batch settlements, view settlement history, and send settlement reports.

Settlement History

Retrieves a paginated list of settlement batches.

GET /api/v2/settlement
Authorization: Bearer {jwt}
Accept: application/json

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Bearer Token
createdStart	query	string(date)	false	Filter by start date
createdEnd	query	string(date)	false	Filter by end date
batchId	query	string	false	Filter by batch ID
pageSize	query	number	false	Default 10, use -1 to get all
pageNumber	query	number	false	Default 1

Response

Status	Meaning	Description	Schema
200	OK (opens in a new tab)	Success	Wrapper: `Response<T>`

Example Response (200)

{
  "msg": "SUCCESS",
  "code": 0,
  "data": {
    "current": 1,
    "total": 50,
    "pages": 5,
    "size": 10,
    "records": [
      {
        "paymentAmt": 15000,
        "profileName": "Daily Settlement",
        "profileMessage": "Settlement completed successfully",
        "refundCount": 2,
        "uuid": "S20230615123456",
        "acquirerMid": "123456789012345",
        "mchName": "Demo Merchant",
        "voidAmt": 1000,
        "batchId": "B001234",
        "createdAt": "2023-06-15T15:30:45Z",
        "currency": "USD",
        "acquirerTid": "10001234",
        "state": 1,
        "acquirerRefNo": "REF123456789",
        "acquirerCode": "00",
        "paymentCount": 15,
        "refundAmt": 2000,
        "updatedAt": "2023-06-15T16:45:12Z",
        "voidCount": 1
      }
    ]
  }
}

Settlement Detail

Retrieves detailed information for a specific settlement batch.

GET /api/v2/settlement/{batchId}
Authorization: Bearer {jwt}
Accept: application/json

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Bearer Token
batchId	path	string	true	Batch ID

Response

Status	Meaning	Description	Schema
200	OK (opens in a new tab)	Success	Wrapper: `Response<T>`

Example Response (200)

{
  "msg": "SUCCESS",
  "code": 0,
  "data": {
    "paymentAmt": 15000,
    "profileName": "Daily Settlement",
    "profileMessage": "Settlement completed successfully",
    "refundCount": 2,
    "uuid": "S20230615123456",
    "acquirerMid": "123456789012345",
    "mchName": "Demo Merchant",
    "voidAmt": 1000,
    "batchId": "B001234",
    "transactions": [
      {
        "amount": 5000,
        "transType": "SALE",
        "count": 5,
        "paymentMethod": "VISA"
      },
      {
        "amount": 10000,
        "transType": "SALE",
        "count": 10,
        "paymentMethod": "MASTERCARD"
      },
      {
        "amount": 2000,
        "transType": "REFUND",
        "count": 2,
        "paymentMethod": "VISA"
      }
    ],
    "createdAt": "2023-06-15T15:30:45Z",
    "successTime": "2023-06-15T16:45:12Z",
    "currency": "USD",
    "acquirerTid": "10001234",
    "state": 1,
    "acquirerRefNo": "REF123456789",
    "acquirerCode": "00",
    "paymentCount": 15,
    "refundAmt": 2000,
    "voidCount": 1
  }
}

Process Settlement

Initiates the settlement process for a specified batch.

POST /api/v2/settlement/settle
Content-Type: application/json
Authorization: Bearer {jwt}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Bearer Token
batchId	body	string	true	Batch ID to settle

Request Body Example

{
  "batchId": "B001234"
}

Response

Status	Meaning	Description	Schema
200	OK (opens in a new tab)	Success	Wrapper: `Response<T>`

Example Response (200)

{
  "msg": "SUCCESS",
  "code": 0,
  "data": {
    "id": 12345
  }
}

Send Settlement Report Email

Sends a settlement report to the specified email address.

POST /api/v2/settlement/email
Content-Type: application/json
Authorization: Bearer {jwt}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Bearer Token
batchIds	body	string	true	JSON array of batch IDs
email	body	string	true	Email recipient address
mchId	body	string	true	Merchant ID

Request Body Example

{
  "batchIds": "[{\"batchId\": \"B001234\"}, {\"batchId\": \"B001235\"}]",
  "email": "merchant@example.com",
  "mchId": "M12345"
}

Response

Status	Meaning	Description	Schema
200	OK (opens in a new tab)	Success	Wrapper: `Response<T>`

Example Response (200)

{
  "msg": "SUCCESS",
  "code": 0,
  "data": {
    "id": 12345
  }
}

Transaction Data Model