Most successful responses from the UnDosTres API follow a consistent JSON structure designed to provide clarity and traceability.
Supported Request Formats
Most of endpoints use JSON; but some works with XML and finally createAccount uses multipart/form-data.
Response Format
A typical response includes:
{
"text": "Success",
"timestamp": "2021-06-25T16:39:15.095Z",
"endpoint": "debit/v1/someEndpoint",
"error": {},
"payload": {
// Endpoint-specific fields (e.g., cardId, customerId)
}
}
- text: A brief status message.
- timestamp: The time the response was generated (in ISO 8601 format).
- endpoint: The API path that was invoked.
- error: An empty object in successful responses, or a populated object in case of business errors.
- payload: A container for the actual data returned by the endpoint.
Note: This is the general response structure used across most JSON-based endpoints in the API. However, not all endpoints follow this format. Some endpoints return responses in XML, particularly those that are integrated with third-party systems or follow legacy formats. In such cases, the structure and content of the response will vary depending on the operation.