GET

Get Signing Payload for Partner External Deposits

This API call allows partners to get the partner external deposits payload for signing. Partners can use this endpoint to retrieve a formatted payload that should be signed using their private key before submitting deposit information. This ensures that deposit submissions are properly authenticated and attributed to the correct partner.

Requires access token scope: settlement_network_read

Path Params

enterpriseId string required

at least 1 characters

Body Params

object

Common properties for external deposit requests. Used as the base for both signed and unsigned requests.

externalSettlementId string required

Partner's unique identifier for the settlement. Used for correlation between BitGo and partner systems.

at least 1 characters
settlementId string

Optional BitGo settlement ID associated with these deposits. May be omitted if the deposits are being submitted before the settlement is created.
deposits array of objects required
deposits object
- currency string required
  
  The currency code of the deposited asset. Identifies which cryptocurrency was deposited on-chain.
  
  at least 1 characters
- onChainTxId string required
  
  The transaction ID of the on-chain deposit. This is the unique identifier for the blockchain transaction.
  
  at least 1 characters

Responses

200

Response Body

object

payload string required

String payload that should be signed with the partner's private key. This signed payload should be included when submitting deposit information.

400

Bad Request

No response body

401

Unauthorized

Response Body

object

error string required

403

Forbidden

Response Body

object

error string required

404

Not Found

Response Body

object

error string required

409

Conflict

Response Body

object

error string required

500

Internal Server Error

Response Body

object

error string required

curl --request GET \ --url 'https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/partners/settlements/onchain/deposits/signing' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"externalSettlementId":"string","settlementId":"string","deposits":[{,"currency":"string","onChainTxId":"string"}]}'

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/partners/settlements/onchain/deposits/signing") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"externalSettlementId":"string","settlementId":"string","deposits":[{,"currency":"string","onChainTxId":"string"}]}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/partners/settlements/onchain/deposits/signing', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"externalSettlementId":"string","settlementId":"string","deposits":[{,"currency":"string","onChainTxId":"string"}]}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/partners/settlements/onchain/deposits/signing" payload = {,"externalSettlementId":"string","settlementId":"string","deposits":[{,"currency":"string","onChainTxId":"string"}]} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.text)