Get the payment status

Retrieves the status of a payment by its ID. Returns a polling delay to wait before checking the status again.

GET /v1/payments/{id}/status

Get the payment status

cURL

curl --request GET \
  --url https://api.pay.walletconnect.com/v1/payments/{id}/status \
  --header 'Api-Key: <api-key>' \
  --header 'Merchant-Id: <merchant-id>'

import requests

url = "https://api.pay.walletconnect.com/v1/payments/{id}/status"

headers = {
    "Api-Key": "<api-key>",
    "Merchant-Id": "<merchant-id>"
}

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

print(response.text)

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

fetch('https://api.pay.walletconnect.com/v1/payments/{id}/status', 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/payments/{id}/status",
  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>",
    "Merchant-Id: <merchant-id>"
  ],
]);

$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/payments/{id}/status"

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

	req.Header.Add("Api-Key", "<api-key>")
	req.Header.Add("Merchant-Id", "<merchant-id>")

	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/payments/{id}/status")
  .header("Api-Key", "<api-key>")
  .header("Merchant-Id", "<merchant-id>")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

200

{
  "info": {
    "optionAmount": {
      "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"
    },
    "txId": "0xabc123..."
  },
  "isFinal": true,
  "pollInMs": null,
  "status": "succeeded"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

API KeyApiKeyAppId

Api-Key · string · header · required

Headers

Api-Key · string · required

Merchant-Id · string · required

WCP-Version · string | null

Sdk-Name · string | null

Sdk-Version · string | null

Sdk-Platform · string | null

Idempotency-Key · string | null

Path Parameters

id · string · required

Payment ID

Example:

"pay_7fa2ecc101ARZ3NDEKTSV4RRFFQ69G5FAV"

Query Parameters

maxPollMs · integer<int64> | null

Maximum time to long-poll for payment status, in milliseconds.

Required range: x >= 0

Response

200

application/json

Payment status retrieved successfully

isFinal · boolean · required

True if the payment is in a final state and no longer requires polling

status · enum<string> · required

Payment status

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

failureCode · null | enum<string>

Machine-readable reason identifying why the payment failed. Present only when status == "failed".

Available options: declined_user

info · null | object

Payment information (transaction hash, amount). Present when status is Succeeded, null otherwise.

Show child attributes

Example:

{
  "optionAmount": {
    "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"
  },
  "txId": "0xabc123..."
}

pollInMs · integer<int64> | null

Time to poll for payment status, in milliseconds. Not present if the payment is in a final state.

Required range: x >= 0