GET

Get settlement payload

Get settlement payload for signing.

Use only with delivery versus payment (DVP) settlements.

Requires access token scope: wallet_view_all

Path Params

enterpriseId string required

at least 1 characters
accountId string required

at least 1 characters
settlementId string required

Header Params

user-id string required

Responses

200

Response Body

object

payload string required

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

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/settlement/settlementId/signing' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'user-id: string'

const url = 'https://app.bitgo-test.com/api/clearing/v1/enterprise/enterpriseId/account/accountId/settlement/settlementId/signing'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'user-id': '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/settlement/settlementId/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["user-id"] = '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/settlement/settlementId/signing', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'user-id' => 'string', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/clearing/v1/enterprise/enterpriseId/account/accountId/settlement/settlementId/signing" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "user-id": "string" } response = requests.get(url, headers=headers) print(response.text)