| Variable | Name | Type | Format | Usage | Description |
|---|---|---|---|---|---|
| X-App-Sig | X-App-Sig | header | string | M | Dev Authentication |
| Variable | Name | Type | Format | Usage | Description |
|---|---|---|---|---|---|
| division_client_code | Division client code | string | |||
| document_reference | document_reference | string | M | The unique payment ID as assigned by the ABS system upon Payment registration in the ABS | |
| payment_id | Payment id | integer |
200 - Response successfully when status is OK
| Variable | Name | Type | Format | Description |
|---|---|---|---|---|
| status | status | string | Request execution status | |
| error_description | Error Description | string | Description of error | |
| error | Error Code | string | Error code | |
| data_type | data_type | string | Type of data | |
| total_records | total_records | string | Total count of records | |
| data | data | array | data of Response |
| Variable | Name | Type | Format | Description |
|---|---|---|---|---|
| action | Action | string | ||
| authorized_client_code | authorized_client_code | string | ||
| create_date | Create Date | string | DATETIME | The date entry was created on |
| create_user | Create User | string | The username of ABS user who has created an entry | |
| document_reference | document_reference | string | The unique payment ID as assigned by the ABS system upon Payment registration in the ABS | |
| form_title | form_title | string | Service field | |
| id | id | integer | INT64 | Record's sequence number generated in the system. |
| info | Action | string | ||
| modify_date | Modify Date | string | DATETIME | The date entry was last modified on |
| modify_user | Modify User | string | The username of ABS user who has made last changes to the entry | |
| notifications_status | notifications_status | string | ||
| oauth_access_token | Oauth access token | string | ||
| payment_id | Payment id | integer | ||
| procedure | Procedure | string | X(40) | |
| processing_status | Processing Status | string | Status of remote client data processing received from the external system | |
| processing_step | Processing step | string | Step of remote client data processing received from the external system | |
| source_table | Source table | string | ||
| state | state | integer | INT64 | Record state for replication |
| uid | uid | string | Unique record identifier which is used to distinguish between existing records | |
| version | version | integer | INT64 | Record version for replication |
200 - Response with error when status is ERROR
| Variable | Name | Type | Format | Description |
|---|---|---|---|---|
| status | status | string | Request execution status | |
| error_description | Error Description | string | Description of error | |
| error | Error Code | string | Error code | |
| data_type | data_type | string | Type of data | |
| total_records | total_records | string | Total count of records | |
| data | data | object | Empty object |