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.
UpdateSettlementClientProcessed Parameters:
NameParameterData TypeRequiredDescription
SettlementIdpathGuidNoSettlement ID or Token
CustomerReferencebodystringYesCustomer Settlement reference in destination system
CustomerProcessedDatebodyDateTimeNoDate and Time Settlement was processed in destination system
TokenDto Parameters:
NameParameterData TypeRequiredDescription
TokenformGuidNo

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

HTTP + CSV

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

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

{}