Create Settlements
Overview
At least once every 24 hours you must create settlements for all trading that occurs on your platform. Settlements transfer assets off chain between your BitGo account to client BitGo accounts.
Prerequisites
- Get Started - Ensure your access token has the following permissions:
Settlement Network - Read
Settlement Network - Write
- Activate Client Connections
- Allocate Assets
- Client trading occurred on your platform in the last 24 hours.
Steps
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
POST /api/network/v1/enterprises/{enterpriseId}/partners/settlements Request Body { "payload": "string", "signature": "string", "nonce": "string", "externalId": "string", "settlementAmounts": { "destinationConnectionId1": { "currency1": "amount1", "currency2": "amount2" }, "destinationConnectionId2": { "currency3": "amount3" } }, "notes": "string" }
Step Result
1 2 3 4 5 6 7 8 9 10 11 12 13 14
{ "settlement": { "status": "completed", "notes": "string", "reason": "string", "createdAt": "2019-08-24", "updatedAt": "2019-08-24", "id": "string", "partnerId": "string", "externalId": "string", "reconciled": true, "initiatedBy": "string" } }