Requests and responses

FormatCopy Anchor Link

Requests and responses are JSON over HTTPS. Send Content-Type: application/json with a body.

• Field names are snake_case.
• Timestamps are RFC 3339 date-times, and their field names end in _at, such as updated_at.
• Amounts are integers in the minor unit of their currency, an ISO 4217 code. 1050 with MYR is RM 10.50.

UpdatesCopy Anchor Link

PATCH takes a JSON merge patch (RFC 7396):

• a field you leave out is unchanged,
• a field you send is replaced,
• null clears a field that can be empty.

PATCH /integration/v1/tradings/{id}
Content-Type: application/json

{"name": "Kedai Ali (Shah Alam)", "contact": null}

DeletesCopy Anchor Link

A delete is refused with 409 while live records depend on the record, such as a company that still has tradings. To retire a record instead, PATCH it to "status": "inactive".