GET

Get batch settlement payload

Get batch settlement payload for signing.

Requires access token scope: wallet_view_all

Path Params

enterpriseId string required

at least 1 characters
accountId string required

at least 1 characters

Query Params

settlementIds array of strings
batchId string
excludedSettlementIds array of strings

Header Params

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

Responses

200

Response Body

object

payload 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

404

Not Found

Response Body

object

error string required
errorName string required

409

Conflict

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

curl --request GET \ --url 'https://app.bitgo-test.com/api/clearing/v1/enterprise/enterpriseId/account/accountId/settlements/batch-signing/payload&settlementIds=&batchId=string&excludedSettlementIds=' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'user-id: string' \ --header 'user-agent: string' \ --header 'x-forwarded-for: string' \ --header 'token-scope: string' \ --header 'origin: string'

const url = 'https://app.bitgo-test.com/api/clearing/v1/enterprise/enterpriseId/account/accountId/settlements/batch-signing/payload&settlementIds=&batchId=string&excludedSettlementIds='; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'user-id': 'string', 'user-agent': 'string', 'x-forwarded-for': 'string', 'token-scope': 'string', 'origin': 'string'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/clearing/v1/enterprise/enterpriseId/account/accountId/settlements/batch-signing/payload&settlementIds=&batchId=string&excludedSettlementIds=") 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["user-id"] = 'string' request["user-agent"] = 'string' request["x-forwarded-for"] = 'string' request["token-scope"] = 'string' request["origin"] = '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/clearing/v1/enterprise/enterpriseId/account/accountId/settlements/batch-signing/payload&settlementIds=&batchId=string&excludedSettlementIds=', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'user-id' => 'string', 'user-agent' => 'string', 'x-forwarded-for' => 'string', 'token-scope' => 'string', 'origin' => 'string', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/clearing/v1/enterprise/enterpriseId/account/accountId/settlements/batch-signing/payload&settlementIds=&batchId=string&excludedSettlementIds=" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "user-id": "string", "user-agent": "string", "x-forwarded-for": "string", "token-scope": "string", "origin": "string" } response = requests.get(url, headers=headers) print(response.text)