GET
/
api
/
v2
/
platform
/
payments
Return a list of Payments
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/payments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "6",
      "type": "payment",
      "attributes": {
        "amount": "45.75",
        "source_type": "Spree::CreditCard",
        "state": "invalid",
        "response_code": "12345",
        "avs_response": null,
        "created_at": "2022-11-08T19:34:50.932Z",
        "updated_at": "2022-11-08T19:34:50.951Z",
        "number": "PPC5V5ZL",
        "cvv_response_code": null,
        "cvv_response_message": null,
        "public_metadata": {},
        "private_metadata": {},
        "display_amount": "$45.75"
      },
      "relationships": {
        "order": {
          "data": {
            "id": "72",
            "type": "order"
          }
        },
        "payment_method": {
          "data": {
            "id": "60",
            "type": "payment_method"
          }
        },
        "source": {
          "data": {
            "id": "5",
            "type": "credit_card"
          }
        },
        "log_entries": {
          "data": []
        },
        "state_changes": {
          "data": [
            {
              "id": "15",
              "type": "state_change"
            }
          ]
        },
        "payment_capture_events": {
          "data": []
        },
        "refunds": {
          "data": []
        }
      }
    },
    {
      "id": "7",
      "type": "payment",
      "attributes": {
        "amount": "45.75",
        "source_type": "Spree::CreditCard",
        "state": "checkout",
        "response_code": "12345",
        "avs_response": null,
        "created_at": "2022-11-08T19:34:50.949Z",
        "updated_at": "2022-11-08T19:34:50.949Z",
        "number": "PB59CC7E",
        "cvv_response_code": null,
        "cvv_response_message": null,
        "public_metadata": {},
        "private_metadata": {},
        "display_amount": "$45.75"
      },
      "relationships": {
        "order": {
          "data": {
            "id": "72",
            "type": "order"
          }
        },
        "payment_method": {
          "data": {
            "id": "60",
            "type": "payment_method"
          }
        },
        "source": {
          "data": {
            "id": "6",
            "type": "credit_card"
          }
        },
        "log_entries": {
          "data": []
        },
        "state_changes": {
          "data": []
        },
        "payment_capture_events": {
          "data": []
        },
        "refunds": {
          "data": []
        }
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/payments?page=1&per_page=&include=&filter[payment_method_id_eq]=&filter[amount_gteq]=",
    "next": "http://www.example.com/api/v2/platform/payments?filter%5Bamount_gteq%5D=&filter%5Bpayment_method_id_eq%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/payments?filter%5Bamount_gteq%5D=&filter%5Bpayment_method_id_eq%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/payments?filter%5Bamount_gteq%5D=&filter%5Bpayment_method_id_eq%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/payments?filter%5Bamount_gteq%5D=&filter%5Bpayment_method_id_eq%5D=&include=&page=1&per_page="
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
​
per_page
integer
​
include
string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

​
filter[payment_method_id_eq]
string
​
filter[amount_gteq]
string

Response

200
application/vnd.api+json

Records returned

The response is of type object.