Get Settlement Files
Request Method and Path
POST /payin/v1/getSettlementFiles
| Field Name | Type | Required | Description |
|---|
| content-type | string | Yes | application/json |
| x-api-key | string | Yes | Provided by Paydify, same as appId |
| x-api-timestamp | string | Yes | Timestamp in milliseconds |
| x-api-signature | string | Yes | Signature, see Signature Algorithm |
Request Body
| Field Name | Type | Required | Description |
|---|
| settlementDate | string(10) | Yes | Settlement date (T+1), format: yyyy-MM-dd |
| merchantId | string(64) | No | Merchant ID of the settlement owner (sub-merchant). Required when calling with a partner credential on behalf of a sub-merchant; can be omitted with a merchant-owned credential (defaults to the credential owner). Max 64 characters |
| merchantAppId | string(64) | No | App ID under the owner merchant, used for disambiguation when the owner merchant has multiple authorized apps. Required if the credential covers multiple apps of the owner merchant; can be omitted when only one app is authorized (resolved automatically). Max 64 characters |
| Field Name | Type | Required | Description |
|---|
| x-api-key | string | Yes | Provided by Paydify, same as appId |
| x-api-timestamp | string | Yes | Timestamp in milliseconds |
| x-api-signature | string | Yes | Signature, see Signature Algorithm |
Response
| Field Name | Type | Description |
|---|
| code | string | Response code, SYS_SUCCESS indicates success |
| message | string | Response message |
| messageDetail | string | Detailed response message |
| success | boolean | Whether the request was successful |
| data | array | Settlement files list |
data[i].batchId | string | Settlement batch ID |
data[i].appId | string | App ID |
data[i].merchantId | string | Merchant ID |
data[i].merchantName | string | Merchant name |
data[i].settlementDate | string | Settlement date (T+1), format: yyyy-MM-dd |
data[i].summaryFileUrl | string | Summary file download URL (S3 pre-signed link, valid for 60 minutes; call this API again for a fresh link after expiry) |
data[i].summaryFileName | string | Summary file name |
data[i].detailFileUrl | string | Detail file download URL (S3 pre-signed link, valid for 60 minutes; call this API again for a fresh link after expiry) |
data[i].detailFileName | string | Detail file name |
Example
// Request
{
"settlementDate": "2025-12-12"
}
// Successful response
{
"code": "SYS_SUCCESS",
"message": null,
"messageDetail": null,
"data": [
{
"batchId": "BATCH_20251212_001",
"appId": "APP_123456",
"merchantId": "MCH_789012",
"merchantName": "Example Merchant",
"settlementDate": "2025-12-12",
"summaryFileUrl": "https://files.paydify.com/settlement/summary/BATCH_20251212_001.csv",
"summaryFileName": "settlement_summary_20251212.csv",
"detailFileUrl": "https://files.paydify.com/settlement/detail/BATCH_20251212_001.csv",
"detailFileName": "settlement_detail_20251212.csv"
}
],
"success": true
}
// Failed response
{
"code": "SYS_ERROR",
"message": "System error",
"messageDetail": "Error details",
"data": null,
"success": false
}
// No settlement files found
{
"code": "SYS_SUCCESS",
"message": null,
"messageDetail": null,
"data": [],
"success": true
}
