v1

latestOpenAPI 3.0.12026-07-2412502.6 MB

Orders

Capture an order

Capture an existing order that has already been authorized.

post/orders/{order_id}/capture

Response

successboolean

response_codeinteger

responsestring

gateway_response_idstring

gateway_response_gateway_idstring

gateway_response_codestring

gateway_auth_codestring

gateway_response_cvvstring

gateway_response_avsstring

gateway_response_textstring

gateway_request_textstring

processor_response_textstring

date_requeststring date-time nullable

date_responsestring date-time nullable

merchant_idinteger

merchant_descriptorstring nullable

reasonstring nullable

Reason in case of merchant error.

gateway_response_descriptionstring

gateway_hard_declinestring

transaction_idinteger

transaction_totalstring

post_datastring nullable

shipment_idinteger nullable

customer_idinteger

order_idinteger

Example response

{
  "date_request": "2023-04-01 00:00:00",
  "date_response": "2023-04-01 00:00:00",
  "reattempt_data": [
    {
      "date_request": "2023-04-01 00:00:00",
      "date_response": "2023-04-01 00:00:00"
    }
  ],
  "order": {
    "date_created": "2023-04-01 00:00:00",
    "date_modified": "2023-04-01 00:00:00",
    "date_authorized": "2023-04-01 00:00:00",
    "date_auto_capture": "2023-04-01 00:00:00",
    "date_ordered": "2023-04-01 00:00:00",
    "date_capture": "2023-04-01 00:00:00",
    "cart": {
      "campaign": {
        "campaign_checkout_upsell": {
          "items": [
            {
              "date_created": "2023-04-01 00:00:00",
              "date_modified": "2023-04-01 00:00:00"
            }
          ]
        }
      },
      "order": {
        "date_authorized": "2023-04-01 00:00:00",
        "date_ordered": "2023-04-01 00:00:00"
      },
      "offers": [
        {
          "gift_date": "2023-04-01 00:00:00",
          "upsells": [
            {
              "items": [
                {
                  "date_created": "2023-04-01 00:00:00",
                  "date_modified": "2023-04-01 00:00:00"
                }
              ]
            }
          ]
        }
      ]
    },
    "order_offers": [
      {
        "date_cancel": "2023-04-01 00:00:00",
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00",
        "date_ordered": "2023-04-01 00:00:00",
        "date_reactivate": "2023-04-01 00:00:00",
        "date_pause": "2023-04-01 00:00:00",
        "date_unpause": "2023-04-01 00:00:00",
        "last_recurring_date": "2023-04-01 00:00:00",
        "next_recurring_date": "2023-04-01 00:00:00",
        "order_offer_shipments": [
          {
            "date_cancel": "2023-04-01 00:00:00",
            "date_scheduled": "2023-04-01 00:00:00",
            "date_complete": "2023-04-01 00:00:00",
            "date_scan": "2023-04-01 00:00:00",
            "date_deliver": "2023-04-01 00:00:00",
            "date_return": "2023-04-01 00:00:00",
            "date_skip": "2023-04-01 00:00:00",
            "date_rma": "2023-04-01 00:00:00",
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          }
        ],
        "order_offer_items": [
          {
            "date_created": "2023-04-01 00:00:00",
            "date_modified": "2023-04-01 00:00:00"
          }
        ],
        "order_offer_gifts": [
          {
            "gift_date": "2023-04-01 00:00:00",
            "gift_date_sent": "2023-04-01 00:00:00"
          }
        ]
      }
    ],
    "customer_card": {
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00"
    }
  },
  "upsells": [
    {
      "items": [
        {
          "date_created": "2023-04-01 00:00:00",
          "date_modified": "2023-04-01 00:00:00"
        }
      ]
    }
  ]
}