Skip to main content
GET
/
transactions
/
{transaction_id}
/
captures
/
{capture_id}
C#
using Gr4vy;
using Gr4vy.Models.Components;

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

var res = await sdk.Transactions.Captures.GetAsync(
    transactionId: "7099948d-7286-47e4-aad8-b68f7eb44591",
    captureId: "b1e2c3d4-5678-1234-9abc-1234567890ab"
);

// handle response
package main

import(
"context"
"os"
gr4vygo "github.com/gr4vy/gr4vy-go"
"log"
)

func main() {
ctx := context.Background()

s := gr4vy.New(
gr4vy.WithID("example"),
gr4vy.WithServer(gr4vy.ServerSandbox),
gr4vy.WithSecuritySource(withToken),
gr4vy.WithMerchantAccountID("default"),
)

res, err := s.Transactions.Captures.Get(ctx, "7099948d-7286-47e4-aad8-b68f7eb44591", "b1e2c3d4-5678-1234-9abc-1234567890ab")
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.GetTransactionCaptureResponse;
import java.lang.Exception;

public class Application {

public static void main(String[] args) throws Exception {

Gr4vy sdk = Gr4vy.builder()
.id("example")
.server(AvailableServers.SANDBOX)
.merchantAccountId("default")
.securitySource(new BearerSecuritySource.Builder(privateKey).build())
.build();

GetTransactionCaptureResponse res = sdk.transactions().captures().get()
.transactionId("7099948d-7286-47e4-aad8-b68f7eb44591")
.captureId("b1e2c3d4-5678-1234-9abc-1234567890ab")
.call();

if (res.capture().isPresent()) {
System.out.println(res.capture().get());
}
}
}
declare(strict_types=1);

require 'vendor/autoload.php';

use Gr4vy;

$sdk = Gr4vy\SDK::builder()
->setId('example')
->setServer('sandbox')
->setSecuritySource(Auth::withToken($privateKey))
->setMerchantAccountId('default')
->build();



$response = $sdk->transactions->captures->get(
transactionId: '7099948d-7286-47e4-aad8-b68f7eb44591',
captureId: 'b1e2c3d4-5678-1234-9abc-1234567890ab'

);

if ($response->capture !== null) {
// handle response
}
from gr4vy import Gr4vy
import os


with Gr4vy(
id="example",
server="sandbox",
merchant_account_id="default",
bearer_auth=auth.with_token(open("./private_key.pem").read())
) as g_client:

res = g_client.transactions.captures.get(transaction_id="7099948d-7286-47e4-aad8-b68f7eb44591", capture_id="b1e2c3d4-5678-1234-9abc-1234567890ab")

# Handle response
print(res)
import { Gr4vy, withToken } from "@gr4vy/sdk";
import fs from "fs";

const gr4vy = new Gr4vy({
id: "example",
server: "sandbox",
merchantAccountId: "default",
bearerAuth: withToken({
privateKey: fs.readFileSync("private_key.pem", "utf8"),
}),
});

async function run() {
const result = await gr4vy.transactions.captures.get("7099948d-7286-47e4-aad8-b68f7eb44591", "b1e2c3d4-5678-1234-9abc-1234567890ab");

console.log(result);
}

run();
curl --request GET \
--url https://api.sandbox.{id}.gr4vy.app/transactions/{transaction_id}/captures/{capture_id} \
--header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merchant_account_id": "<string>",
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "<string>",
  "amount": 123,
  "final": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "type": "capture",
  "xid": "capture_xYqd43gySMtori",
  "captured_at": "2013-07-16T19:23:00.000+00:00",
  "external_identifier": "capture-12345",
  "error_code": "service_error",
  "iso_response_code": "00",
  "raw_response_code": "E104",
  "raw_response_description": "Internal error",
  "transaction_external_identifier": "transaction-12345",
  "cart_items": [
    {
      "name": "<string>",
      "quantity": 123,
      "unit_amount": 49999999,
      "discount_amount": 0,
      "tax_amount": 0,
      "external_identifier": "goprohd",
      "sku": "GPHD1078",
      "upc": "012345678905",
      "product_url": "https://example.com/catalog/go-pro-hd",
      "image_url": "https://example.com/images/go-pro-hd.jpg",
      "categories": [
        "camera",
        "travel",
        "gear"
      ],
      "product_type": "physical",
      "seller_country": "US",
      "tax_exempt": false,
      "unit_of_measure": "feet",
      "commodity_code": "43211503",
      "description": "A brief description of an interesting item.",
      "duty_amount": 1299,
      "shipping_amount": 1299
    }
  ]
}
{
"type": "error",
"code": "bad_request",
"status": 400,
"message": "Generic error",
"details": []
}
{
"type": "error",
"code": "unauthorized",
"status": 401,
"message": "No valid API authentication found",
"details": []
}
{
"type": "error",
"code": "forbidden",
"status": 403,
"message": "Generic error",
"details": []
}
{
"type": "error",
"code": "not_found",
"status": 404,
"message": "The resource could not be found",
"details": []
}
{
"type": "error",
"code": "method_not_allowed",
"status": 405,
"message": "Method Not Allowed",
"details": []
}
{
"type": "error",
"code": "duplicate_record",
"status": 409,
"message": "Generic error",
"details": [],
"resource_id": "cdc70639-cb9c-4222-a73f-b8ce39f7821b"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
{
"type": "error",
"code": "too_early",
"status": 425,
"message": "Generic error",
"details": []
}
{
"type": "error",
"code": "too_many_requests",
"status": 429,
"message": "Generic error",
"details": []
}
{
"type": "error",
"code": "server_error",
"status": 500,
"message": "Request could not be processed",
"details": []
}
{
"type": "error",
"code": "bad_gateway",
"status": 502,
"message": "Request could not be processed",
"details": []
}
{
"type": "error",
"code": "gateway_timeout",
"status": 504,
"message": "Request could not be processed",
"details": []
}
This endpoint requires the transactions.read scope.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-gr4vy-merchant-account-id
string

The ID of the merchant account to use for this request.

Example:

"default"

Path Parameters

transaction_id
string<uuid>
required

The unique identifier of the transaction.

Example:

"7099948d-7286-47e4-aad8-b68f7eb44591"

capture_id
string<uuid>
required

The unique identifier of the capture.

Example:

"b1e2c3d4-5678-1234-9abc-1234567890ab"

Response

Successful Response

id
string<uuid>
required

The unique identifier for the capture.

Example:

"b1e2c3d4-5678-1234-9abc-1234567890ab"

merchant_account_id
string
required

The merchant account this capture belongs to.

Example:

"default"

transaction_id
string<uuid>
required

The ID of the transaction associated with this capture.

Example:

"7099948d-7286-47e4-aad8-b68f7eb44591"

currency
string
required

The ISO 4217 currency code for this capture.

Example:

"USD"

amount
integer
required

The capture amount in the smallest currency unit.

Example:

1299

status
enum<string>
required

The status of the capture.

Available options:
succeeded,
pending,
declined,
failed
Example:

"succeeded"

final
boolean
required

Whether this is marked as the final capture for the associated transaction.

Example:

true

created_at
string<date-time>
required

The date and time this capture was created.

Example:

"2013-07-16T19:23:00.000+00:00"

updated_at
string<date-time>
required

The date and time this capture was last updated.

Example:

"2013-07-16T19:23:00.000+00:00"

type
string
default:capture

Always capture.

Allowed value: "capture"
Example:

"capture"

xid
string | null

The payment service's unique ID for the capture.

Example:

"capture_xYqd43gySMtori"

captured_at
string<date-time> | null

The date and time the capture was completed.

Example:

"2013-07-16T19:23:00.000+00:00"

external_identifier
string | null

An external identifier that can be used to match the capture against your own records.

Example:

"capture-12345"

error_code
string | null

The standardized error code set by Gr4vy.

Example:

"service_error"

iso_response_code
string | null

The ISO response code.

Example:

"00"

raw_response_code
string | null

This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services.

Example:

"E104"

raw_response_description
string | null

This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services.

Example:

"Internal error"

transaction_external_identifier
string | null

The external identifier of the associated transaction.

Example:

"transaction-12345"

cart_items
CartItem · object[] | null

An array of cart items that represents the line items of this capture.