Get payment options

List available options a wallet can use to complete a payment.

POST /v1/gateway/payment/{id}/options

Get payment options

cURL

curl --request POST \
  --url https://api.pay.walletconnect.com/v1/gateway/payment/{id}/options \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accounts": [
    "<string>"
  ],
  "refresh": [
    "<string>"
  ]
}
'

import requests

url = "https://api.pay.walletconnect.com/v1/gateway/payment/{id}/options"

payload = {
    "accounts": ["<string>"],
    "refresh": ["<string>"]
}
headers = {
    "Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

fetch('https://api.pay.walletconnect.com/v1/gateway/payment/{id}/options', 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/gateway/payment/{id}/options",
  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([
    'accounts' => [
        '<string>'
    ],
    'refresh' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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/gateway/payment/{id}/options"

	payload := strings.NewReader("{\n  \"accounts\": [\n    \"<string>\"\n  ],\n  \"refresh\": [\n    \"<string>\"\n  ]\n}")

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

	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/gateway/payment/{id}/options")
  .header("Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accounts\": [\n    \"<string>\"\n  ],\n  \"refresh\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pay.walletconnect.com/v1/gateway/payment/{id}/options")

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

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

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

200

{
  "options": [
    {
      "actions": [
        {
          "data": {
            "chain_id": "<string>",
            "method": "<string>",
            "params": [
              "<unknown>"
            ]
          },
          "type": "walletRpc"
        }
      ],
      "amount": {
        "display": {
          "assetName": "<string>",
          "assetSymbol": "<string>",
          "decimals": 1,
          "iconUrl": "<string>",
          "networkIconUrl": "<string>",
          "networkName": "<string>"
        },
        "unit": "<string>",
        "value": "<string>"
      },
      "etaS": 1,
      "id": "<string>",
      "account": "<string>",
      "collectData": {
        "url": "<string>",
        "schema": {},
        "fields": [
          {
            "id": "<string>",
            "name": "<string>",
            "required": true
          }
        ]
      }
    }
  ],
  "collectData": {
    "url": "<string>",
    "schema": {},
    "fields": [
      {
        "id": "<string>",
        "name": "<string>",
        "required": true
      }
    ]
  },
  "info": {
    "amount": {
      "display": {
        "assetName": "<string>",
        "assetSymbol": "<string>",
        "decimals": 1,
        "iconUrl": "<string>",
        "networkIconUrl": "<string>",
        "networkName": "<string>"
      },
      "unit": "<string>",
      "value": "<string>"
    },
    "expiresAt": 1,
    "merchant": {
      "name": "<string>",
      "iconUrl": "<string>"
    },
    "buyer": {
      "accountCaip10": "<string>",
      "accountProviderName": "<string>",
      "accountProviderIcon": "<string>"
    }
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Api-Key · string · header · required

Headers

Api-Key · string · required

App-Id · string

Path Parameters

id · string · required

Payment ID

Query Parameters

includePaymentInfo · boolean | null

Whether to include payment information in the response

Body

application/json

accounts · string[] · required

refresh · string[] | null

Response

200

application/json

Payment options retrieved successfully

options · object[] · required

Show child attributes

collectData · object | null

Show child attributes

info · object | null

Show child attributes