API Request

API Request records hold the details of a Bulk API request.

Method Purpose
GET (Singular) Return API Request details

GET (Singular)

Action: Return API Request details.
Method: GET
URL: https://api.smarterpaycloud.com/service.svc/apirequest/{ID}

{ID} denotes ID of record.

Response Parameters

Property Description
id The ID of the Record.
status Status of the API Request. Can be “Inserting”, “Queued”, “Processing”, “Complete” or “Failed”.
created_at Datetime formatted as ISO8601.
edited_at Datetime formatted as ISO8601.

Response Sample

{
    "id": "RR0112AB34CD56EF78GH",
    "status": "Complete",
    "created_at": "2024-10-11T11:36:33Z",
    "edited_at": "2024-10-11T11:37:14Z"
}