| PUT | /api/settlement/{SettlementId}/processed | Update Settlement as customer processed, will also acknowledge Settlement if not yet set. |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports DX.STF.Application.ClientApi.Messages.Settlement
Imports DX.Framework.Core.Commands.Dto
Namespace Global
Namespace DX.Framework.Core.Commands.Dto
Public Partial Class TokenDto
Implements ICommandResponse
Public Overridable Property Token As Guid
End Class
End Namespace
Namespace DX.STF.Application.ClientApi.Messages.Settlement
'''<Summary>
'''Settlement
'''</Summary>
<Api(Description:="Settlement")>
<ApiResponse(Description:="Command received", IsDefaultResponse:=true, ResponseType:=GetType(TokenDto), StatusCode:=202)>
Public Partial Class UpdateSettlementClientProcessed
'''<Summary>
'''Settlement ID or Token
'''</Summary>
<ApiMember(Description:="Settlement ID or Token", ExcludeInSchema:=true, ParameterType:="path")>
Public Overridable Property SettlementId As Guid
'''<Summary>
'''Customer Settlement reference in destination system
'''</Summary>
<ApiMember(Description:="Customer Settlement reference in destination system")>
Public Overridable Property CustomerReference As String
'''<Summary>
'''Date and Time Settlement was processed in destination system
'''</Summary>
<ApiMember(Description:="Date and Time Settlement was processed in destination system")>
Public Overridable Property CustomerProcessedDate As Date
End Class
End Namespace
End Namespace
VB.NET UpdateSettlementClientProcessed DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"customerReference":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{}