GetCapture

Summary

Returns all or specific captured payments of the order

Resource URL /api/v3/orders/{orderNumber}/captures/{captureNumber}
HTTP method GET
Content type application/json; charset=utf-8

Input parameters

Parameter name Location Type / Model Description
orderNumber Path required
Order number
captureNumber Path optional
Capture number

Responses

HTTP status code Model Comment
OK(200) GetAllCapturesResponse Get all captures response
BadRequest (400) array of ResponseMessage Request failed. Check response model for list of Errors.
Unauthorized (401) API user is unauthorized. Make sure X-Auth-Key header is sent.
InternalServerError (500) Request failed due internal error. Retry request later.

Examples

{
  "captures": [
    {
      "captureId": "4e844005-9196-4751-a615-87eaac3a29e7",
      "reservationId": "24dc00d9-d51b-477f-b11f-dad81d43dd06",
      "customerNumber": "000000001",
      "captureNumber": "000000001",
      "orderNumber": "ORDER000001",
      "amount": 300.00,
      "balance": 300.00,
      "currency": "EUR",
      "insertedAt": "2018-11-20T19:12:06Z",
      "orderDate": "2018-11-20T19:12:06Z",
      "captureItems": [
        {
          "captureId": "4e844005-9196-4751-a615-87eaac3a29e7",
          "productId": "0001",
          "groupId": "0011",
          "description": "Item 1 description",
          "netUnitPrice": 10.0,
          "grossUnitPrice": 12.0,
          "quantity": 5.0,
          "vatCategory": "MiddleCategory",
          "vatPercent": 20.0,
          "vatAmount": 2.0,
          "lineNumber": 1
        },
        {
          "captureId": "4e844005-9196-4751-a615-87eaac3a29e7",
          "productId": "0002",
          "groupId": "0022",
          "description": "Item 2 description",
          "netUnitPrice": 100.0,
          "grossUnitPrice": 120.0,
          "quantity": 2.0,
          "vatCategory": "MiddleCategory",
          "vatPercent": 20.0,
          "vatAmount": 20.0,
          "lineNumber": 2
        }
      ]
    }
  ]
}
var AfterPayApi = require("./afterPay.js");
var apiKeyAuthentication = require("./api_key_filter");

var key = 'CHANGE_ME';
var client = new AfterPayApi().addFilter(apiKeyAuthentication.create(key));

client.OrderManagement.getCapture(orderNumber, captureNumber, 
  function(err, response, httpRequest, httpResponse) {
  });
$LOAD_PATH.unshift File.dirname(__FILE__)
require 'after_pay.rb'
require 'json'

client = AfterPayApi::AfterPay.new(AfterPayApi::ApiKeyCredentials.new('YOUR_API_KEY'))


client.orderManagement.getCapture_async(orderNumber, captureNumber).then{|response|

}.execute.wait
var key = "CHANGE_ME";
var client = new OrderManagementApi(new Configuration() { DefaultHeader = new Dictionary<string, string>() { { "X-Auth-Key", key} } });


var responce = client.OrderManagementGetCapture(orderNumber, captureNumber);