Sign settlement

post/api/clearing/v1/enterprise/{enterpriseId}/account/{accountId}/settlement/{settlementId}/signing

Sign settlement.

Use only with delivery versus payment (DVP) settlements.

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters
  • accountIdstringRequired
    Min length: >= 1 characters
  • settlementIdstringRequired

Request Body

payload string required
Min length: >= 1 characters
signature string required
Min length: >= 1 characters

200 Response

id string required
Min length: >= 1 characters
accountId string required
Min length: >= 1 characters
status string required
Allowed values: acknowledged canceled rejected approved pending failed overdue expired initialized signed signing pending-acknowledgement
payload string required
Min length: >= 1 characters
signature string
Min length: >= 1 characters
policyDetailId string
policyDetail object
id string required
Min length: >= 1 characters
resolutionTime string <date-time>required
resolvedBy array[string] required
signedAt string <date-time>
signedBy string
Min length: >= 1 characters
approvedAt string <date-time>
createdAt string <date-time>required
updatedAt string <date-time>required
settlementId string required
Min length: >= 1 characters

400 Response

401 Response

error string required
errorName string required

403 Response

error string required
errorName string required

422 Response

error string required
errorName string required

500 Response

error string required
errorName string required