Get a payment

This endpoint returns only basic information to display to the user to begin the payment flow.

GET /v1/gateway/payment/{id}

Get a payment

cURL

curl --request GET \
  --url https://api.pay.walletconnect.com/v1/gateway/payment/{id} \
  --header 'Api-Key: <api-key>'

import requests

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

headers = {"Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'Api-Key': '<api-key>'}};

fetch('https://api.pay.walletconnect.com/v1/gateway/payment/{id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.pay.walletconnect.com/v1/gateway/payment/{id}")
  .header("Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Api-Key"] = '<api-key>'

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

200

{
  "amount": {
    "display": {
      "assetName": "USD Coin",
      "assetSymbol": "USDC",
      "decimals": 6,
      "iconUrl": "https://assets.walletconnect.com/usdc.png",
      "networkIconUrl": "https://assets.walletconnect.com/base.png",
      "networkName": "Base"
    },
    "unit": "caip19/eip155:8453/erc20:0x0000000000000000000000000000000000000000",
    "value": "1000000"
  },
  "buyer": {
    "accountCaip10": "eip155:1:0x0000000000000000000000000000000000000000",
    "accountProviderIcon": "https://example.com/icon.png",
    "accountProviderName": "Wallet"
  },
  "expiresAt": 1700000000,
  "merchant": {
    "iconUrl": "https://example.com/icon.png",
    "name": "Merchant"
  },
  "status": "requires_action"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

API KeyApiKeyAppId

Api-Key · string · header · required

Headers

Api-Key · string | null

App-Id · string | null

Client-Id · string | null

WCP-Version · string | null

Sdk-Name · string | null

Sdk-Version · string | null

Sdk-Platform · string | null

Path Parameters

id · string · required

Payment ID

Example:

"pay_7fa2ecc101ARZ3NDEKTSV4RRFFQ69G5FAV"

Response

200

application/json

Payment status retrieved successfully

amount · object · required

Show child attributes

Example:

{
  "display": {
    "assetName": "USD Coin",
    "assetSymbol": "USDC",
    "decimals": 6,
    "iconUrl": "https://assets.walletconnect.com/usdc.png",
    "networkIconUrl": "https://assets.walletconnect.com/base.png",
    "networkName": "Base"
  },
  "unit": "caip19/eip155:8453/erc20:0x0000000000000000000000000000000000000000",
  "value": "1000000"
}

expiresAt · integer<int64> · required

Required range: x >= 0

merchant · object · required

Show child attributes

Example:

{
  "iconUrl": "https://example.com/icon.png",
  "name": "Merchant"
}

status · enum<string> · required

Payment status representing the lifecycle of a payment.

Payments progress through these states from creation to terminal status. Some states are specific to the payment source (pull vs push).

Available options: requires_action, processing, succeeded, failed, expired, cancelled

buyer · null | object

Show child attributes

Example:

{
  "accountCaip10": "eip155:1:0x0000000000000000000000000000000000000000",
  "accountProviderIcon": "https://example.com/icon.png",
  "accountProviderName": "Wallet"
}