Settlements

Create settlement

Create a settlement request to send to your counterparty.

Use only with delivery versus payment (DVP) settlements.

Requires access token scope: wallet_spend_all

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

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/clearing/v1/enterprise/{enterpriseId}/account/{accountId}/settlement
  • Auth
    none declared. Required headers: user-id, user-agent, x-forwarded-for, token-scope, authorization

Path parameters

enterpriseIdstring required
accountIdstring required

Headers

user-idstring required
user-agentstring required
x-forwarded-forstring required
token-scopestring required
originstring
authorizationstring required

Request body

externalIdstring required
expireAtstring date-time
notationstring
addressBookConnectionIdstring required
addressBookConnectionUpdatedAtstring date-time required
bypassCounterpartySigningboolean
transactionRouteIdstring
checkForDuplicatesboolean

HTTP specific codec for create multi-currency settlement

Response

OK

idstring required
externalIdstring required
expireAtstring date-time
notationstring
requesterAccountIdstring required
status'canceled' | 'pending' | 'rejected' | 'settled' | 'expired' | 'pending-acknowledgement' required
type'direct' | 'agency' | 'disbursement' required
bypassCounterpartySigningboolean
routedTransactionIdstring
clearingMethod'manual' | 'manual-netting' | 'automated-netting'
requesterAccountNamestring
finalizedAtstring date-time
createdAtstring date-time required
updatedAtstring date-time required
unlockDatestring

Changes

No operation changes recorded.