Create crypto settlements

Register one or more crypto settlement destinations for the merchant. Each entry pairs a CAIP-19 asset with a CAIP-10 destination wallet on the same chain. Each (merchant, asset) pair must be unique — registering the same asset twice returns settlement_asset_conflict.

POST /v1/merchants/{merchantId}/settlements/crypto

Create crypto settlements

cURL

curl --request POST \
  --url https://api.pay.walletconnect.com/v1/merchants/{merchantId}/settlements/crypto \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "settlements": [
    {
      "asset": "<string>",
      "destination": "<string>"
    }
  ]
}
'

import requests

url = "https://api.pay.walletconnect.com/v1/merchants/{merchantId}/settlements/crypto"

payload = { "settlements": [
        {
            "asset": "<string>",
            "destination": "<string>"
        }
    ] }
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'Api-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({settlements: [{asset: '<string>', destination: '<string>'}]})
};

fetch('https://api.pay.walletconnect.com/v1/merchants/{merchantId}/settlements/crypto', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pay.walletconnect.com/v1/merchants/{merchantId}/settlements/crypto",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'settlements' => [
        [
                'asset' => '<string>',
                'destination' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pay.walletconnect.com/v1/merchants/{merchantId}/settlements/crypto"

	payload := strings.NewReader("{\n  \"settlements\": [\n    {\n      \"asset\": \"<string>\",\n      \"destination\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.pay.walletconnect.com/v1/merchants/{merchantId}/settlements/crypto")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"settlements\": [\n    {\n      \"asset\": \"<string>\",\n      \"destination\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pay.walletconnect.com/v1/merchants/{merchantId}/settlements/crypto")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"settlements\": [\n    {\n      \"asset\": \"<string>\",\n      \"destination\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

201

Example

{
  "settlements": [
    {
      "id": "crypto_Xk7nWp8XmQj2YrTv6",
      "asset": "eip155:8453/erc20:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
      "destination": "eip155:8453:0x1234567890abcdef1234567890abcdef12345678"
    }
  ]
}

Authorizations

API KeyApiKeyAppId

Api-Key · string · header · required

Headers

Idempotency-Key · string · required

Unique key to ensure idempotent request processing. Max 255 characters.

Maximum string length: 255

Path Parameters

merchantId · string · required

Body

application/json

settlements · object[] · required

List of asset/destination pairs to register. Up to 50 entries per request.

Required array length: 1 - 50 elements

Show child attributes

Response

201

application/json

Crypto settlements created

settlements · object[] · required

Show child attributes