Settlement Record Inquiry API

Endpoint
POST {BASE_URL}/api/v2.0/payments/settlements

Retrieve the settlement records of a specified date

Request Body
datestringREQUIRED

Date to be queried, e.g.：20230516
The value must comply with the regular expression: ((19|20)\d{2}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]))

Settlement Inquiry Request Body
{
    "date": "string"
}
Response (200 OK)
settlementsarray [object]

Settlement records

Hide child parameters
settlements.settleInfoobject

Settlement information

Hide child parameters
settlements.settleInfo.settleNostring

Unique settlement number

settlements.settleInfo.creditAmountstring

Credited amount of current settlement

settlements.settleInfo.debitAmountstring

Debited amount of current settlement

settlements.settleInfo.netAmountstring

Net transaction amount of current settlement creditAmount-debitAmount

settlements.settleInfo.serviceFeestring

AlphaPay service fee

settlements.settleInfo.settleAmountstring

Settled amount

settlements.bankInfoobject

Bank information

Hide child parameters
settlements.bankInfo.storeCodestring

Store code: Set by Merchant

settlements.bankInfo.companyNamestring

Merchant bank account name

settlements.bankInfo.transitNostring

Bank branch No.

settlements.bankInfo.institutionNostring

Bank institution No.

settlements.bankInfo.accountNostring

Merchant bank account No.

resultobject

Process result

Hide child parameters
result.resultCodestring

Process result code, please refer to resultCode

result.resultMessagestring

Process result message

result.resultStatusstring

The status of an API call, please refer to resultStatus

  • S: API call succeeded.
  • F: API call failed, the resultMessage field will provide a detailed description of the error, which could be caused by either the merchant or the platform, when an error occurs during API invocation.
  • U: In cases where the handling result is unknown or in an intermediate state. Such as receiving a PAYMENT_IN_PROCESS status after submitting a payment order, the query interface can be used to confirm the status of the payment result.
Settlement Inquiry Response
{
    "settlements": [
        {
            "settleInfo": {
                "settleNo": "string",
                "creditAmount": "string",
                "debitAmount": "string",
                "netAmount": "string",
                "serviceFee": "string",
                "settleAmount": "string"
            },
            "bankInfo": {
                "storeCode": "string",
                "companyName": "string",
                "transitNo": "string",
                "institutionNo": "string",
                "accountNo": "string"
            }
        }
    ],
    "result": {
        "resultCode": "string",
        "resultMessage": "string",
        "resultStatus": "S"
    }
}