Request Parameters
Request Method
All requests use the POST method
Request Headers
All APIs must include the following fields in the request headers:
| 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 |
Response Headers
All APIs will include the following fields in the response headers:
| 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 Format
All API responses follow this data structure:
json
{
"code": "SYS_SUCCESS",
"message": null,
"messageDetail": null,
"data": {},
"success": true
}{
"code": "SYS_SUCCESS",
"message": null,
"messageDetail": null,
"data": {},
"success": true
}Response Field Descriptions
| Field Name | Type | Description |
|---|---|---|
| code | string | Response code, SYS_SUCCESS indicates success |
| message | string | Response message |
| messageDetail | string | Detailed response message |
| data | object | Business data |
| success | boolean | Whether the request was successful |