DX STF Client API

<back to all web services

UpdateSettlementClientProcessed

Settlement Requests

Settlement

Requires Authentication
The following routes are available for this service:
PUT/api/settlement/{SettlementId}/processedUpdate Settlement as customer processed, will also acknowledge Settlement if not yet set.
namespace DX.Framework.Core.Commands.Dto

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TokenDto() = 
        member val Token:Guid = new Guid() with get,set

    ///<summary>
    ///Settlement
    ///</summary>
    [<Api(Description="Settlement")>]
    [<ApiResponse(Description="Command received", IsDefaultResponse=true, ResponseType=typeof<TokenDto>, StatusCode=202)>]
    [<AllowNullLiteral>]
    type UpdateSettlementClientProcessed() = 
        ///<summary>
        ///Settlement ID or Token
        ///</summary>
        [<ApiMember(Description="Settlement ID or Token", ExcludeInSchema=true, ParameterType="path")>]
        member val SettlementId:Guid = new Guid() with get,set

        ///<summary>
        ///Customer Settlement reference in destination system
        ///</summary>
        [<ApiMember(Description="Customer Settlement reference in destination system")>]
        member val CustomerReference:String = null with get,set

        ///<summary>
        ///Date and Time Settlement was processed in destination system
        ///</summary>
        [<ApiMember(Description="Date and Time Settlement was processed in destination system")>]
        member val CustomerProcessedDate:DateTime = new DateTime() with get,set

F# UpdateSettlementClientProcessed DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
Content-Type: text/jsv
Content-Length: length

{
	customerReference: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}