Capture a Transaction

POST 
https://useast.api.elasticpath.com/v2/orders/:orderID/transactions/:transactionID/capture

Use this endpoint to capture a previously authorized payment. In this step, you can also pass in a custom reference, such as the payment reference from your chosen gateway.

Request

Path Parameters

orderID stringrequired

The UUID of the order.

transactionID stringrequired

The UUID of the transaction to capture.

application/json

Body

data object
options object
soft_descriptorstring
note_to_payerstring

Responses

200

Response Headers

application/json

Schema

Schema

data objectrequired
iduuid
The ID of the transaction.
referencestring
The payment gateway reference.
namestring
A custom name associated with the payment method.
custom_referencestring
A reference associated with the payment method. This might include loyalty points or gift card identifiers. We recommend you not to include personal information in this field.
gatewaystring
The name of the payment gateway used.
Possible values: [adyen, authorize_net, braintree, card_connect, cyber_source, elastic_path_payments_stripe, manual, paypal_express_checkout, stripe, stripe_connect, stripe_payment_intents, stripe_platform_account]
amountnumber
The amount for this transaction.
refunded_amountnumber
The refunded amount.
currencystring
The transaction currency.
transaction-typestring
The type of transaction, such as purchase, capture, authorize or refund.
statusstring
The status provided by the gateway for this transaction, such as complete or failed.
relationships object
order object
data object
typestring
Represents the type of the object being returned. It is always order.
iduuid
The ID of the order.
meta object
display_price object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
display_refunded_amount object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
timestamps object
created_atstring
The date this was created.
Example: 2023-11-07T23:04:18.845Z
updated_at
The date this was last updated.
Example: 2023-11-07T23:04:18.845Z

Example (auto)

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "reference": "string",
    "name": "string",
    "custom_reference": "string",
    "gateway": "adyen",
    "amount": 0,
    "refunded_amount": 0,
    "currency": "string",
    "transaction-type": "string",
    "status": "string",
    "relationships": {
      "order": {
        "data": {
          "type": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        }
      }
    },
    "meta": {
      "display_price": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "display_refunded_amount": {
        "amount": 0,
        "currency": "string",
        "formatted": "string"
      },
      "timestamps": {
        "created_at": "2023-11-07T23:04:18.845Z",
        "updated_at": "2023-11-07T23:04:18.845Z"
      }
    }
  }
}

400

Bad Request

application/json

Schema

Schema

errors object[]required
Array [
titlestringrequired
A brief summary of the error.
statusstring | integerrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
meta object
idstring
The resource id associated with the error
idsstring[]
item_idsstring[]
shipping_group_idstring
The shipping group id associated with the error
shipping_group_idsstring[]
cart_idstring
The cart id associated with the error
codestring
The code associated with the error.
order_idstring
The order id associated with the error.
valuestring | integer | boolean | object | array
The value associated with the error.
]

Example (auto)

{
  "errors": [
    {
      "title": "string",
      "detail": "string",
      "meta": {
        "id": "string",
        "ids": [
          "string"
        ],
        "item_ids": [
          "string"
        ],
        "shipping_group_id": "string",
        "shipping_group_ids": [
          "string"
        ],
        "cart_id": "string",
        "code": "string",
        "order_id": "string"
      }
    }
  ]
}

default

Required field missing

{
  "errors": [
    {
      "detail": "Request could not be processed",
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://useast.api.elasticpath.com/v2/orders/:orderID/transactions/:transactionID/capture");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"options\": {\n      \"soft_descriptor\": \"string\",\n      \"note_to_payer\": \"string\"\n    }\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Parameters

orderID — pathrequired

transactionID — pathrequired

Body

{
  "data": {
    "options": {
      "soft_descriptor": "string",
      "note_to_payer": "string"
    }
  }
}

ResponseClear

Click the Send API Request button above and see the response here!