Ctrl+K

Reject Settlements

Overview

You can reject settlements that either you or your counterparties initiate. Unlike approving settlements, rejecting a settlement is only ever 1 API call.

Prerequisites

1. Reject Settlement

Acknowledging a settlement is a final check that lets your counterparty know you reviewed and confirmed the amounts for transfer. Acknowledging doesn't sign the settlement.

Endpoint: Update settlement approval request

  • cURL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
export ENTERPRISE_ID="<YOUR_ENTERPRISE_ID>"
export ACCOUNT_ID="<YOUR_ACCOUNT_ID>"
export APPROVAL_REQUEST_ID="<APPROVAL_REQUEST_ID>"
export ACCESS_TOKEN="<YOUR_ACCESS_TOKEN>"
export PAYLOAD="<SETTLEMENT_PAYLOAD>"
export SIGNATURE="<YOUR_PUBLIC_KEY>"

curl -X POST \
  https://app.bitgo-test.com/api/clearing/v1/enterprise/$ENTERPRISE_ID/account/$ACCOUNT_ID/approval-requests/$APPROVAL_REQUEST_ID \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{"status": "rejected"}'
  // "rejected" if your counterparty initiated the settlement
  // "canceled" if you initiated the settlement

Step Result

The settlement cancels. Any assets that were in hold state in your Go Account are released, freeing them for other transactions.

  • JSON
1
2
3
4
5
6
7
8
9
10
11
{
  "settlementId": "string",
  "approvedAt": "2019-08-24",
  "createdAt": "2019-08-24",
  "updatedAt": "2019-08-24",
  "id": "string",
  "accountId": "string",
  "status": "rejected",
  "payload": "string",
  "signature": "string"
}

Next Steps

You can confirm your unchanged balances by viewing your Go Account in BitGo or by calling the Get wallet by ID endpoint. If a settlement still needs to occur, you or your counterparty can Create Settlements.

See Also