REST APISettle (DVP)Settlement Signing

POST

Sign settlement.

Use only with delivery versus payment (DVP) settlements.

Requires access token scope: wallet_spend_all

Path Params

  • enterpriseId string required

    at least 1 characters

  • accountId string required

    at least 1 characters

  • settlementId string required

Header Params

  • user-id string required
  • user-agent string required
  • x-forwarded-for string required
  • token-scope string required
  • origin string

Body Params

object

  • payload string required

    at least 1 characters

  • signature string required

    at least 1 characters

Responses

200
OK

Response Body

object

  • id string required

    at least 1 characters

  • accountId string required

    at least 1 characters

  • status string enum required
    acknowledgedcanceledrejectedapprovedpendingfailedoverdueexpiredinitializedsignedsigningpending-acknowledgement
  • payload string required

    at least 1 characters

  • signature string

    at least 1 characters

  • policyDetailId string
  • policyDetail object
    policyDetail object
    • id string required

      at least 1 characters

    • resolutionTime string date-time required
    • resolvedBy array of strings required
  • signedAt string date-time
  • signedBy string

    at least 1 characters

  • approvedAt string date-time
  • createdAt string date-time required
  • updatedAt string date-time required
  • settlementId string required

    at least 1 characters

400
Bad Request
No response body
401
Unauthorized

Response Body

object

  • error string required
  • errorName string required
403
Forbidden

Response Body

object

  • error string required
  • errorName string required
422
Unprocessable Entity

Response Body

object

  • error string required
  • errorName string required
500
Internal Server Error

Response Body

object

  • error string required
  • errorName string required