List all captures

How to fetch a collection of captures via API

To fetch a collection of captures, send a GET request to the /api/captures endpoint.

Request

GET https://yourdomain.commercelayer.io/api/captures

Example

Request

The following request fetches a collection of captures:

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/captures/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Response

On success, the API responds with a 200 OK status code, returning a paginated collection of resource objects:

{
  "data": [
    {
      "id": "xYZkjABcde",
      "type": "captures",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde"
      },
      "attributes": {
        "number": "42/T/001",
        "type": "authorizations",
        "currency_code": "EUR",
        "amount_cents": 1500,
        "amount_float": 15.0,
        "formatted_amount": "€15,00",
        "succeeded": false,
        "message": "Accepted",
        "error_code": "00001",
        "error_detail": "Already settled",
        "token": "xxxx-yyyy-zzzz",
        "gateway_transaction_id": "xxxx-yyyy-zzzz",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANY-EXTERNAL-REFEFERNCE",
        "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
        "metadata": {
          "foo": "bar"
        },
        "refund_amount_cents": 500,
        "refund_amount_float": 5.0,
        "formatted_refund_amount": "€5,00",
        "refund_balance_cents": 1000,
        "refund_balance_float": 10.0,
        "formatted_refund_balance": "€10,00"
      },
      "relationships": {
        "order": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/relationships/order",
            "related": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/order"
          }
        },
        "payment_source": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/relationships/payment_source",
            "related": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/payment_source"
          }
        },
        "attachments": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/relationships/attachments",
            "related": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/attachments"
          }
        },
        "events": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/relationships/events",
            "related": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/events"
          }
        },
        "versions": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/relationships/versions",
            "related": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/versions"
          }
        },
        "reference_authorization": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/relationships/reference_authorization",
            "related": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/reference_authorization"
          }
        },
        "refunds": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/relationships/refunds",
            "related": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/refunds"
          }
        },
        "return": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/relationships/return",
            "related": "https://yourdomain.commercelayer.io/api/captures/xYZkjABcde/return"
          }
        }
      },
      "meta": {
        "mode": "test",
        "organization_id": "xRRkjDFafe",
        "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
      }
    },
    {
      "other": "... 9 captures (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14
  },
  "links": {
    "first": "https://yourdomain.commercelayer.io/api/captures?page[number]=1&page[size]=10",
    "next": "https://yourdomain.commercelayer.io/api/captures?page[number]=2&page[size]=10",
    "last": "https://yourdomain.commercelayer.io/api/captures?page[number]=14&page[size]=10"
  }
}

Remember that when you fetch a list of resources you get paginated result.

Sortable fields

The list of captures can be sorted by the following fields:

Attributes

• number

• type

• amount_cents

• id

• created_at

• updated_at

• reference

• reference_origin

Relationships

• order

• return

Filterable fields

The list of captures can be filtered by the following fields:

Attributes

• number

• type

• currency_code

• amount_cents

• succeeded

• message

• error_code

• error_detail

• token

• gateway_transaction_id

• id

• created_at

• updated_at

• reference

• reference_origin

• metadata

Relationships

• order

• payment_source

• attachments

• events

• return