| PUT | /api/settlement/{SettlementId}/processed | Update Settlement as customer processed, will also acknowledge Settlement if not yet set. |
|---|
export class TokenDto implements ICommandResponse
{
public token: string;
public constructor(init?: Partial<TokenDto>) { (Object as any).assign(this, init); }
}
/** @description Settlement */
// @Api(Description="Settlement")
// @ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType="typeof(DX.Framework.Core.Commands.Dto.TokenDto)", StatusCode=202)
export class UpdateSettlementClientProcessed
{
/** @description Settlement ID or Token */
// @ApiMember(Description="Settlement ID or Token", ExcludeInSchema=true, ParameterType="path")
public settlementId: string;
/** @description Customer Settlement reference in destination system */
// @ApiMember(Description="Customer Settlement reference in destination system")
public customerReference: string;
/** @description Date and Time Settlement was processed in destination system */
// @ApiMember(Description="Date and Time Settlement was processed in destination system")
public customerProcessedDate: string;
public constructor(init?: Partial<UpdateSettlementClientProcessed>) { (Object as any).assign(this, init); }
}
TypeScript UpdateSettlementClientProcessed DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /api/settlement/{SettlementId}/processed HTTP/1.1
Host: stf-api-uat.data-xchange.co.za
Accept: application/json
Content-Type: application/json
Content-Length: length
{"customerReference":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{}