GET

Get Signing Payload for Partner Settlement

This API call allows partners to get the partner settlement payload for signing. The returned payload should be cryptographically signed by the partner and included in the subsequent settlement creation request. If your HTTP client doesn't support sending a request body on a get request, use the V1PartnerSettlementsSigningPostRoute

Requires access token scope: settlement_network_read

Path Params

enterpriseId string required

at least 1 characters

Body Params

object

externalId string required

External identifier for the settlement request. This should be unique for each settlement request and is used for idempotence and correlation with partner systems.

at least 1 characters
notes string

Optional notes about the settlement. Can contain additional context or information about the purpose of the settlement.

at least 1 characters
settlementAmounts object required
ONE OF
- <key> map of strings
  value object
  
  <key> string
  
  For unmapped settlement amounts where the amount can be either BigNumberFromString or BigIntFromString. This provides flexibility in how monetary values are represented in settlement requests.
- <key> map of objects
  value object
  
  <key> map of strings
  
  value object
  
  <key> string
  
  For unmapped settlement amounts where the amount can be either BigNumberFromString or BigIntFromString. This provides flexibility in how monetary values are represented in settlement requests.
nonce string required

A unique nonce value used for cryptographic operations. This provides additional security for settlement operations.

at least 1 characters
cutoffAt string date-time

The date and time of the most recent trade being settled, represented in ISO 8601 format. Optional field used for v2 settlements.

Responses

200

Response Body

object

payload string required

400

Bad Request

No response body

401

Unauthorized

Response Body

object

error string required

403

Forbidden

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-signing' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"externalId":"string","notes":"string","settlementAmounts":{"key":{"key":"string"}}{"key":{"key":{"key":"string"}}},"nonce":"string","cutoffAt":"string"}'

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/partners/settlements-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 = '{,"externalId":"string","notes":"string","settlementAmounts":{"key":{"key":"string"}}{"key":{"key":{"key":"string"}}},"nonce":"string","cutoffAt":"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-signing', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"externalId":"string","notes":"string","settlementAmounts":{"key":{"key":"string"}}{"key":{"key":{"key":"string"}}},"nonce":"string","cutoffAt":"string"}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/network/v1/enterprises/enterpriseId/partners/settlements-signing" payload = {,"externalId":"string","notes":"string","settlementAmounts":{"key":{"key":"string"}}{"key":{"key":{"key":"string"}}},"nonce":"string","cutoffAt":"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)