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.
"use strict";
export class TokenDto {
    /** @param {{token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    token;
}
export class UpdateSettlementClientProcessed {
    /** @param {{settlementId?:string,customerReference?:string,customerProcessedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Settlement ID or Token */
    settlementId;
    /**
     * @type {string}
     * @description Customer Settlement reference in destination system */
    customerReference;
    /**
     * @type {string}
     * @description Date and Time Settlement was processed in destination system */
    customerProcessedDate;
}

JavaScript 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

{
	
}