Get a payment session capture

curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/captures/{captureId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/captures/{captureId}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/captures/{captureId}', 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.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/captures/{captureId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/captures/{captureId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/captures/{captureId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/captures/{captureId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "captureId": "capture_82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
  "paymentSessionId": "paymentSession_82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
  "status": "succeeded",
  "amount": "1.00",
  "finalCapture": true,
  "metadata": {
    "customer_id": "cust_12345",
    "order_reference": "order-67890"
  },
  "onchainTransactions": [
    {
      "transactionHash": "0xdef456abc789012345678901234567890abcdef1234567890abcdef12345678",
      "network": "base"
    }
  ],
  "createdAt": "2025-06-15T12:20:00.000Z",
  "updatedAt": "2025-06-15T12:21:00.000Z"
}

{
  "errorType": "not_found",
  "errorMessage": "Capture with the given ID does not exist."
}

{
  "errorType": "internal_server_error",
  "errorMessage": "An internal server error occurred. Please try again later."
}

{
  "errorType": "bad_gateway",
  "errorMessage": "Bad gateway. Please try again later."
}

{
  "errorType": "service_unavailable",
  "errorMessage": "Service unavailable. Please try again later."
}

GET

payment-sessions

{paymentSessionId}

captures

{captureId}

Get a payment session capture

curl --request GET \
  --url https://api.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/captures/{captureId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/captures/{captureId}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/captures/{captureId}', 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.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/captures/{captureId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/captures/{captureId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/captures/{captureId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cdp.coinbase.com/platform/v2/payment-sessions/{paymentSessionId}/captures/{captureId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "captureId": "capture_82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
  "paymentSessionId": "paymentSession_82c879c1-84e1-44ed-a8c2-1ac239cf09ad",
  "status": "succeeded",
  "amount": "1.00",
  "finalCapture": true,
  "metadata": {
    "customer_id": "cust_12345",
    "order_reference": "order-67890"
  },
  "onchainTransactions": [
    {
      "transactionHash": "0xdef456abc789012345678901234567890abcdef1234567890abcdef12345678",
      "network": "base"
    }
  ],
  "createdAt": "2025-06-15T12:20:00.000Z",
  "updatedAt": "2025-06-15T12:21:00.000Z"
}

{
  "errorType": "not_found",
  "errorMessage": "Capture with the given ID does not exist."
}

{
  "errorType": "internal_server_error",
  "errorMessage": "An internal server error occurred. Please try again later."
}

{
  "errorType": "bad_gateway",
  "errorMessage": "Bad gateway. Please try again later."
}

{
  "errorType": "service_unavailable",
  "errorMessage": "Service unavailable. Please try again later."
}

Authorizations

Authorization

string

header

required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.

Path Parameters

paymentSessionId

string

required

The unique identifier of the payment session. The ID of the payment session, a UUID prefixed by paymentSession_.

Pattern: ^paymentSession_[a-f0-9\-]{36}$

Example:

"paymentSession_82c879c1-84e1-44ed-a8c2-1ac239cf09ad"

captureId

string

required

The unique identifier of the capture. The ID of the capture, a UUID prefixed by capture_.

Pattern: ^capture_[a-f0-9\-]{36}$

Example:

"capture_82c879c1-84e1-44ed-a8c2-1ac239cf09ad"

Response

Successfully retrieved capture.

A collection of authorized funds. Multiple partial captures are allowed up to the authorized amount. Each capture settles funds to the merchant's target.

finalCapture

boolean

required

When true, this capture is treated as the final one for the authorization. Any remaining capturable balance is released back to the payer immediately after the capture settles. When false, the remaining capturable balance stays held and is available for subsequent partial captures (subject to captureExpiresAt). Has no effect if amount equals the full capturable balance, since no remaining balance exists to release.

Example:

true

captureId

string

The unique identifier of the capture.

Pattern: ^capture_[a-f0-9\-]{36}$

Example:

"capture_82c879c1-84e1-44ed-a8c2-1ac239cf09ad"

paymentSessionId

string

The ID of the payment session this capture belongs to.

Pattern: ^paymentSession_[a-f0-9\-]{36}$

Example:

"paymentSession_82c879c1-84e1-44ed-a8c2-1ac239cf09ad"

status

enum<string>

The current status of the capture.

Available options:

pending,

succeeded,

failed

Example:

"pending"

amount

string

A decimal representation of the captured amount, denominated in the session's asset.

Example:

"1.00"

error

object

An error that occurred during a payment operation.

Show child attributes

Example:

{
  "code": "insufficient_funds",
  "message": "The payer does not have sufficient funds.",
  "occurredAt": "2025-06-15T12:00:00.000Z"
}

metadata

object

Optional metadata as key-value pairs. Use this to store additional structured information on a resource, such as customer IDs, order references, or any application-specific data. Up to 10 key/value pairs may be provided. Keys and values are both strings. Keys must be ≤ 40 characters; values must be ≤ 500 characters.

Show child attributes

Example:

{
  "customer_id": "cust_12345",
  "order_reference": "order-67890"
}

externalReferenceId

string

A merchant-provided internal identifier for this capture, from the merchant's own system—not visible to the payer. A manual capture uses the caller-provided value; an auto-capture reuses the authorization's value and omits it when the authorization omitted it. It never falls back to PaymentSession.externalReferenceId.

Maximum string length: 256

Example:

"merchant-capture-abc123"

customerDisplay

Operation Customer Display · object

Customer-facing display data for this capture, shown to the payer. A manual capture falls back to the session's orderCode when referenceCode is omitted; an auto-capture reuses the authorization's referenceCode.

Show child attributes

Example:

{ "referenceCode": "REF-ABC123" }

onchainTransactions

object[]

The onchain transactions associated with this capture.

Show child attributes

Example:

[
  {
    "transactionHash": "0xdef456abc789012345678901234567890abcdef1234567890abcdef12345678",
    "network": "base"
  }
]

createdAt

string<date-time>

The UTC ISO 8601 timestamp at which the capture was created.

Example:

"2025-06-15T12:20:00.000Z"

updatedAt

string<date-time>

The UTC ISO 8601 timestamp at which the capture was last updated.

Example:

"2025-06-15T12:21:00.000Z"