BACK API

5.
O

Obligation settlement

Overview

Using this API, a party settles an obligation that it previously issued

Input

Input is Provider Id, Integration Key and Entry as mentioned below

"ProviderId" = Unique provider ID
"IntegrationKey" = Unique Integration Key
"Entry":
"Id": Unique Entry ID
"FormVersion": Version of form e.g. 1
"UserFirstName": User's First Name
"UserLastName": User's Last Name
"UserEmail": User's Email
"Latitude": Latidudinal position
"Longitude": Longitudinal position
"StartTime": Date Time Started
"ReceivedTime": Date Time Received
"CompleteTime": Date Time completed
"AnswersJson":
"page1":
"id": Obligation ID returned by Issue Obligation. Be sure to use the same ID.
"amount": amount of obligation
"currency": currency code e.g. "AUD"
"ProviderId": Unique provider ID
"DSRowId": Unique Row ID

Output

The amount paid off on the obligation ID, and the transaction number will be returned as output.

Example Response

50 USD paid off on obligation id SignedTransaction(id=0C3D2E28FC8DBE35D3DDAD3C4D94ECFF0977C96C0CBAC2531FCF49CCE8997C13).id.