--- title: Retrieve payment history slug: docs/demo/retrieve-payment-history description: Learn how to make a GET request to a specified endpoint using the curl command with this helpful code example. The snippet showcases the necessary URL and headers for accepting and sending JSON data, ensuring smooth communication between your application docTags: createdAt: 2022-03-21T20:12:45.000Z --- { "id": "CM078AY6U6KYwyyz2Mv9J", "data": { "url": "https://api.fictive.com/REST/api/accounts/{accountReference}/payments", "name": "Retrieve payment history", "method": "GET", "request": { "pathParameters": [ { "kind": "required", "name": "accountReference", "type": "string" } ], "queryParameters": [ { "kind": "optional", "name": "createDateFrom", "type": "string" }, { "kind": "optional", "name": "createDateTo", "type": "string" }, { "kind": "optional", "name": "rowsPerPage", "type": "integer" }, { "kind": "optional", "name": "currentPage", "type": "integer" }, { "kind": "optional", "name": "isAscending", "type": "boolean" }, { "kind": "optional", "name": "paymentInstructionReference", "type": "string" }, { "kind": "optional", "name": "paymentReference", "type": "string" } ], "headerParameters": [ { "kind": "optional", "name": "X-TokenId", "type": "string", "description": "The eSuite Token Id" }, { "kind": "optional", "name": "X-SessionId", "type": "string", "description": "The eSuite Session Id" }, { "kind": "required", "name": "X-Version", "type": "string", "description": "The eSuite Version" }, { "kind": "optional", "name": "Origin", "type": "string", "description": "The eSuite Origin" } ], "bodyDataParameters": [], "formDataParameters": [] }, "responses": [ { "schema": [ { "kind": "optional", "type": "array", "schema": [ { "kind": "optional", "name": "cartReference", "type": "string", "example": "", "description": "Cart Reference" }, { "kind": "optional", "name": "fulfilmentReferences", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "description": "Fulfilment References", "itemExample": "" }, { "kind": "optional", "name": "status", "type": "string", "example": "", "description": "Status" }, { "kind": "optional", "name": "paymentReference", "type": "string", "example": "", "description": "Payment Reference" }, { "kind": "optional", "name": "refundedPaymentReference", "type": "string", "example": "", "description": "Refunded Payment Reference" }, { "kind": "optional", "name": "paymentDate", "type": "string", "example": "2021-09-21T05:33:19.8854322", "description": "Payment Date" }, { "kind": "optional", "name": "description", "type": "string", "example": "", "description": "Description" }, { "kind": "optional", "name": "paymentMethod", "type": "string", "example": "", "description": "PaymentMethod" }, { "kind": "optional", "name": "subscriptionReference", "type": "string", "example": "", "description": "Subscription Reference" }, { "kind": "optional", "name": "pricing", "type": "object", "schema": [ { "kind": "optional", "name": "grossAmount", "type": "number", "example": "", "description": "Groos amount" }, { "kind": "optional", "name": "netAmount", "type": "number", "example": "", "description": "Net amount" }, { "kind": "optional", "name": "taxAmount", "type": "number", "example": "", "description": "Tax amount" }, { "kind": "optional", "name": "currency", "type": "string", "example": "", "description": "Currency" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PaymentPriceBreakdown", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PaymentPriceBreakdown", "description": "Pricing" }, { "kind": "optional", "name": "customPaymentParameters", "type": "object", "schema": [], "example": {}, "description": "Custom Payment Parameters" }, { "kind": "optional", "name": "priceBreakdown", "type": "array", "schema": [ { "kind": "optional", "name": "itemReference", "type": "string", "example": "" }, { "kind": "optional", "name": "refundedItemReference", "type": "string", "example": "" }, { "kind": "optional", "name": "itemStatus", "type": "string", "example": "" }, { "kind": "optional", "name": "itemDescription", "type": "string", "example": "" }, { "kind": "optional", "name": "itemGrossAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "itemNetAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "itemTaxAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "itemQuantity", "type": "integer", "example": 0 }, { "kind": "optional", "name": "discountOrderLineItems", "type": "array", "schema": [ { "kind": "optional", "name": "discountItemReference", "type": "string", "example": "" }, { "kind": "optional", "name": "discountItemStatus", "type": "string", "example": "" }, { "kind": "optional", "name": "offerReference", "type": "string", "example": "" }, { "kind": "optional", "name": "offerApplicationType", "type": "string", "example": "" }, { "kind": "optional", "name": "offerDescription", "type": "string", "example": "" }, { "kind": "optional", "name": "discountItemGrossAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "discountItemNetAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "discountItemTaxAmount", "type": "number", "example": "" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.DiscountOrderLineItem", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.DiscountOrderLineItem[]" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.OrderLineItem", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.OrderLineItem[]", "description": "List of OrderLineItems listing the price breakdown" }, { "kind": "optional", "name": "associatedPaymentReferences", "type": "array", "schema": [ { "kind": "optional", "name": "cartReference", "type": "string", "example": "", "description": "Cart Reference" }, { "kind": "optional", "name": "fulfilmentReferences", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "description": "Fulfilment References", "itemExample": "" }, { "kind": "optional", "name": "status", "type": "string", "example": "", "description": "Status" }, { "kind": "optional", "name": "paymentReference", "type": "string", "example": "", "description": "Payment Reference" }, { "kind": "optional", "name": "refundedPaymentReference", "type": "string", "example": "", "description": "Refunded Payment Reference" }, { "kind": "optional", "name": "paymentDate", "type": "string", "example": "2021-09-21T05:33:19.8854322", "description": "Payment Date" }, { "kind": "optional", "name": "description", "type": "string", "example": "", "description": "Description" }, { "kind": "optional", "name": "paymentMethod", "type": "string", "example": "", "description": "PaymentMethod" }, { "kind": "optional", "name": "subscriptionReference", "type": "string", "example": "", "description": "Subscription Reference" }, { "kind": "optional", "name": "pricing", "type": "object", "schema": [ { "kind": "optional", "name": "grossAmount", "type": "number", "example": "", "description": "Groos amount" }, { "kind": "optional", "name": "netAmount", "type": "number", "example": "", "description": "Net amount" }, { "kind": "optional", "name": "taxAmount", "type": "number", "example": "", "description": "Tax amount" }, { "kind": "optional", "name": "currency", "type": "string", "example": "", "description": "Currency" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PaymentPriceBreakdown", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PaymentPriceBreakdown", "description": "Pricing" }, { "kind": "optional", "name": "customPaymentParameters", "type": "object", "schema": [], "example": {}, "description": "Custom Payment Parameters" }, { "kind": "optional", "name": "priceBreakdown", "type": "array", "schema": [ { "kind": "optional", "name": "itemReference", "type": "string", "example": "" }, { "kind": "optional", "name": "refundedItemReference", "type": "string", "example": "" }, { "kind": "optional", "name": "itemStatus", "type": "string", "example": "" }, { "kind": "optional", "name": "itemDescription", "type": "string", "example": "" }, { "kind": "optional", "name": "itemGrossAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "itemNetAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "itemTaxAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "itemQuantity", "type": "integer", "example": 0 }, { "kind": "optional", "name": "discountOrderLineItems", "type": "array", "schema": [ { "kind": "optional", "name": "discountItemReference", "type": "string", "example": "" }, { "kind": "optional", "name": "discountItemStatus", "type": "string", "example": "" }, { "kind": "optional", "name": "offerReference", "type": "string", "example": "" }, { "kind": "optional", "name": "offerApplicationType", "type": "string", "example": "" }, { "kind": "optional", "name": "offerDescription", "type": "string", "example": "" }, { "kind": "optional", "name": "discountItemGrossAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "discountItemNetAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "discountItemTaxAmount", "type": "number", "example": "" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.DiscountOrderLineItem", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.DiscountOrderLineItem[]" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.OrderLineItem", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.OrderLineItem[]", "description": "List of OrderLineItems listing the price breakdown" }, { "kind": "optional", "name": "associatedPaymentReferences", "type": "array", "itemType": "", "customType": "[]", "description": "A list refunded payments linked to the current payment", "itemExample": "" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v3.Payment", "customType": "FictiveGlobal.Api.Rest.Dtos.v3.Payment[]", "description": "A list refunded payments linked to the current payment" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v3.Payment", "customType": "FictiveGlobal.Api.Rest.Dtos.v3.Payment[]", "isExpanded": true, "description": "Account payment" } ], "isExpanded": true, "statusCode": "200", "description": "OK", "jsonExample": "[\n {\n \"cartReference\": \"0010O17IDWBV5EN4G2\",\n \"fulfilmentReferences\": [\n \"0010O17IDWBV5EN4G2\"\n ],\n \"status\": \"Completed\",\n \"paymentReference\": \"0010O17IDWBV5EN4G2\",\n \"paymentDate\": \"2021-09-21T05:33:20.1667135\",\n \"description\": \"Subscription Purchase\",\n \"paymentMethod\": \"CreditCard\",\n \"subscriptionReference\": \"0010S82FD7URMMQTA1\",\n \"pricing\": {\n \"grossAmount\": 9.99,\n \"netAmount\": 9.99,\n \"taxAmount\": 0,\n \"currency\": \"GBP\"\n },\n \"customPaymentParameters\": {},\n \"priceBreakdown\": [\n {\n \"itemReference\": \"0010O17IDWBV5EN4G2\",\n \"itemStatus\": \"Payment\",\n \"itemDescription\": \"Order line item description\",\n \"itemGrossAmount\": 10,\n \"itemNetAmount\": 8,\n \"itemTaxAmount\": 2,\n \"itemQuantity\": 0,\n \"discountOrderLineItems\": [\n {\n \"discountItemReference\": \"0010O17IDWBV5EN4G2\",\n \"discountItemStatus\": \"Payment\",\n \"offerReference\": \"0010O17IDWBV5EN4G2\",\n \"offerApplicationType\": \"LowStartOfferSubscription\",\n \"offerDescription\": \"Low start offer\",\n \"discountItemGrossAmount\": -5,\n \"discountItemNetAmount\": -4,\n \"discountItemTaxAmount\": -1\n }\n ]\n }\n ]\n },\n {\n \"cartReference\": \"0010OTP6HFY8XR9UL3\",\n \"fulfilmentReferences\": [\n \"0010O17IDWBV5EN4G2\",\n \"0010LHX0A0HB0FUXD2\"\n ],\n \"status\": \"Refunded\",\n \"paymentReference\": \"0010OTP6HFY8XR9UL3\",\n \"paymentDate\": \"2021-09-21T05:33:20.1667135\",\n \"description\": \"Refund Amount on Order\",\n \"paymentMethod\": \"CreditCard\",\n \"subscriptionReference\": \"0010SAGHR1654LPS1H\",\n \"pricing\": {\n \"grossAmount\": 10,\n \"netAmount\": 9.434,\n \"taxAmount\": 0.566,\n \"currency\": \"GBP\"\n },\n \"customPaymentParameters\": {}\n },\n {\n \"cartReference\": \"0010OTP6HFY8XR9UL3\",\n \"fulfilmentReferences\": [\n \"0010O17IDWBV5EN4G2\",\n \"0010LHX0A0HB0FUXD2\"\n ],\n \"status\": \"PartialRefunded\",\n \"paymentReference\": \"0010OTP6HFY8XR9UL4\",\n \"paymentDate\": \"2021-09-21T05:33:20.1667135+00:00\",\n \"description\": \"Order 111111\",\n \"paymentMethod\": \"CreditCard\",\n \"subscriptionReference\": \"0010SAGHR1654LPS1H\",\n \"pricing\": {\n \"grossAmount\": 10,\n \"netAmount\": 9.434,\n \"taxAmount\": 0.566,\n \"currency\": \"GBP\"\n },\n \"customPaymentParameters\": {},\n \"associatedPaymentReferences\": [\n {\n \"fulfilmentReferences\": [],\n \"status\": \"Refunded\",\n \"paymentReference\": \"0010OTP6HFY8XR9UL4\",\n \"paymentDate\": \"2021-09-22T05:33:20.1667135+00:00\",\n \"description\": \"Refund Amount on Order: 111111\",\n \"paymentMethod\": \"SEPA\",\n \"subscriptionReference\": \"0010SAGHR1654LPS1H\",\n \"pricing\": {\n \"grossAmount\": 20,\n \"netAmount\": 15,\n \"taxAmount\": 5,\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n {\n \"cartReference\": \"0010OTP6HFY8XR9UL3\",\n \"fulfilmentReferences\": [],\n \"status\": \"PartialRefunded\",\n \"paymentReference\": \"0010OTP6HFY8XR9UL4\",\n \"paymentDate\": \"2021-09-21T05:33:20.1667135+00:00\",\n \"description\": \"Subscription Purchase (Auto-Renew): Bundle purchase - Bundle purchase. (Your subscription cost has been discounted by 16.25 EUR)\",\n \"paymentMethod\": \"CreditCard\",\n \"subscriptionReference\": \"0010SOIJ7XSJB9PGZ2\",\n \"pricing\": {\n \"grossAmount\": 6.25,\n \"netAmount\": 5.385,\n \"taxAmount\": 0.865,\n \"currency\": \"EUR\"\n },\n \"customPaymentParameters\": {},\n \"priceBreakdown\": [\n {\n \"itemReference\": \"0010O17IDWBV5EN4G2\",\n \"itemStatus\": \"PartiallyRefunded\",\n \"itemDescription\": \"Physical product 1\",\n \"itemGrossAmount\": 14.5,\n \"itemNetAmount\": 10,\n \"itemTaxAmount\": 4.5,\n \"itemQuantity\": 0,\n \"discountOrderLineItems\": [\n {\n \"discountItemReference\": \"0010O17IDWBV5EN4G2\",\n \"discountItemStatus\": \"Deducted\",\n \"offerReference\": \"0010O17IDWBV5EN4G2\",\n \"offerApplicationType\": \"FixedPriceDiscountOfferSubscription\",\n \"offerDescription\": \"Premium offer\",\n \"discountItemGrossAmount\": -7.25,\n \"discountItemNetAmount\": -5,\n \"discountItemTaxAmount\": -2.25\n },\n {\n \"discountItemReference\": \"001DOB1VKFBLB54JC3\",\n \"discountItemStatus\": \"Deducted\",\n \"offerReference\": \"0010O17IDWBV5EN4G2\",\n \"offerApplicationType\": \"ServiceCredits\",\n \"offerDescription\": \"ServiceCredits\",\n \"discountItemGrossAmount\": -4.4615,\n \"discountItemNetAmount\": -3.0765,\n \"discountItemTaxAmount\": -1.385\n }\n ]\n }\n ]\n }\n]" }, { "schema": [ { "kind": "optional", "type": "array", "schema": [ { "kind": "optional", "name": "cartReference", "type": "string", "example": "", "description": "Cart Reference" }, { "kind": "optional", "name": "fulfilmentReferences", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "description": "Fulfilment References", "itemExample": "" }, { "kind": "optional", "name": "status", "type": "string", "example": "", "description": "Status" }, { "kind": "optional", "name": "paymentReference", "type": "string", "example": "", "description": "Payment Reference" }, { "kind": "optional", "name": "refundedPaymentReference", "type": "string", "example": "", "description": "Refunded Payment Reference" }, { "kind": "optional", "name": "paymentDate", "type": "string", "example": "2021-09-21T05:33:19.8854322", "description": "Payment Date" }, { "kind": "optional", "name": "description", "type": "string", "example": "", "description": "Description" }, { "kind": "optional", "name": "paymentMethod", "type": "string", "example": "", "description": "PaymentMethod" }, { "kind": "optional", "name": "subscriptionReference", "type": "string", "example": "", "description": "Subscription Reference" }, { "kind": "optional", "name": "pricing", "type": "object", "schema": [ { "kind": "optional", "name": "grossAmount", "type": "number", "example": "", "description": "Groos amount" }, { "kind": "optional", "name": "netAmount", "type": "number", "example": "", "description": "Net amount" }, { "kind": "optional", "name": "taxAmount", "type": "number", "example": "", "description": "Tax amount" }, { "kind": "optional", "name": "currency", "type": "string", "example": "", "description": "Currency" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PaymentPriceBreakdown", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PaymentPriceBreakdown", "description": "Pricing" }, { "kind": "optional", "name": "customPaymentParameters", "type": "object", "schema": [], "example": {}, "description": "Custom Payment Parameters" }, { "kind": "optional", "name": "priceBreakdown", "type": "array", "schema": [ { "kind": "optional", "name": "itemReference", "type": "string", "example": "" }, { "kind": "optional", "name": "refundedItemReference", "type": "string", "example": "" }, { "kind": "optional", "name": "itemStatus", "type": "string", "example": "" }, { "kind": "optional", "name": "itemDescription", "type": "string", "example": "" }, { "kind": "optional", "name": "itemGrossAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "itemNetAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "itemTaxAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "itemQuantity", "type": "integer", "example": 0 }, { "kind": "optional", "name": "discountOrderLineItems", "type": "array", "schema": [ { "kind": "optional", "name": "discountItemReference", "type": "string", "example": "" }, { "kind": "optional", "name": "discountItemStatus", "type": "string", "example": "" }, { "kind": "optional", "name": "offerReference", "type": "string", "example": "" }, { "kind": "optional", "name": "offerApplicationType", "type": "string", "example": "" }, { "kind": "optional", "name": "offerDescription", "type": "string", "example": "" }, { "kind": "optional", "name": "discountItemGrossAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "discountItemNetAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "discountItemTaxAmount", "type": "number", "example": "" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.DiscountOrderLineItem", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.DiscountOrderLineItem[]" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.OrderLineItem", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.OrderLineItem[]", "description": "List of OrderLineItems listing the price breakdown" }, { "kind": "optional", "name": "associatedPaymentReferences", "type": "array", "schema": [ { "kind": "optional", "name": "cartReference", "type": "string", "example": "", "description": "Cart Reference" }, { "kind": "optional", "name": "fulfilmentReferences", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "description": "Fulfilment References", "itemExample": "" }, { "kind": "optional", "name": "status", "type": "string", "example": "", "description": "Status" }, { "kind": "optional", "name": "paymentReference", "type": "string", "example": "", "description": "Payment Reference" }, { "kind": "optional", "name": "refundedPaymentReference", "type": "string", "example": "", "description": "Refunded Payment Reference" }, { "kind": "optional", "name": "paymentDate", "type": "string", "example": "2021-09-21T05:33:19.8854322", "description": "Payment Date" }, { "kind": "optional", "name": "description", "type": "string", "example": "", "description": "Description" }, { "kind": "optional", "name": "paymentMethod", "type": "string", "example": "", "description": "PaymentMethod" }, { "kind": "optional", "name": "subscriptionReference", "type": "string", "example": "", "description": "Subscription Reference" }, { "kind": "optional", "name": "pricing", "type": "object", "schema": [ { "kind": "optional", "name": "grossAmount", "type": "number", "example": "", "description": "Groos amount" }, { "kind": "optional", "name": "netAmount", "type": "number", "example": "", "description": "Net amount" }, { "kind": "optional", "name": "taxAmount", "type": "number", "example": "", "description": "Tax amount" }, { "kind": "optional", "name": "currency", "type": "string", "example": "", "description": "Currency" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PaymentPriceBreakdown", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PaymentPriceBreakdown", "description": "Pricing" }, { "kind": "optional", "name": "customPaymentParameters", "type": "object", "schema": [], "example": {}, "description": "Custom Payment Parameters" }, { "kind": "optional", "name": "priceBreakdown", "type": "array", "schema": [ { "kind": "optional", "name": "itemReference", "type": "string", "example": "" }, { "kind": "optional", "name": "refundedItemReference", "type": "string", "example": "" }, { "kind": "optional", "name": "itemStatus", "type": "string", "example": "" }, { "kind": "optional", "name": "itemDescription", "type": "string", "example": "" }, { "kind": "optional", "name": "itemGrossAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "itemNetAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "itemTaxAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "itemQuantity", "type": "integer", "example": 0 }, { "kind": "optional", "name": "discountOrderLineItems", "type": "array", "schema": [ { "kind": "optional", "name": "discountItemReference", "type": "string", "example": "" }, { "kind": "optional", "name": "discountItemStatus", "type": "string", "example": "" }, { "kind": "optional", "name": "offerReference", "type": "string", "example": "" }, { "kind": "optional", "name": "offerApplicationType", "type": "string", "example": "" }, { "kind": "optional", "name": "offerDescription", "type": "string", "example": "" }, { "kind": "optional", "name": "discountItemGrossAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "discountItemNetAmount", "type": "number", "example": "" }, { "kind": "optional", "name": "discountItemTaxAmount", "type": "number", "example": "" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.DiscountOrderLineItem", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.DiscountOrderLineItem[]" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.OrderLineItem", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.OrderLineItem[]", "description": "List of OrderLineItems listing the price breakdown" }, { "kind": "optional", "name": "associatedPaymentReferences", "type": "array", "itemType": "", "customType": "[]", "description": "A list refunded payments linked to the current payment", "itemExample": "" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v3.Payment", "customType": "FictiveGlobal.Api.Rest.Dtos.v3.Payment[]", "description": "A list refunded payments linked to the current payment" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v3.Payment", "customType": "FictiveGlobal.Api.Rest.Dtos.v3.Payment[]", "isExpanded": true, "description": "Account payment" } ], "isExpanded": true, "statusCode": "204", "description": "No payments found", "jsonExample": "" }, { "isExpanded": true, "statusCode": "401", "description": "Not Authorized", "jsonExample": "" }, { "isExpanded": true, "statusCode": "404", "description": "Account could not be found: Account cannot be found. Invalid UKI and PIN or Password.", "jsonExample": "" }, { "isExpanded": true, "statusCode": "500", "description": "Internal Server Error", "jsonExample": "" } ], "contentType": "application/json", "description": "This endpoint will provide the ability to retrieve all payments placed by an account on the eSuite platform", "examples": { "languages": [ { "id": "nageoknhVoUUjkT9Xe98X", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.fictive.com/REST/api/accounts/{accountReference}/payments \\\n --header 'accept: application/json' \\\n --header 'x-version: string'" }, { "id": "EWsnXikoNEeGk8NeB_icK", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-version\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.fictive.com/REST/api/accounts/{accountReference}/payments\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "dX9hVWva02aMe7ZTkyQmN", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.fictive.com/REST/api/accounts/{accountReference}/payments\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-version\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "5eDIrlCne2odK_zCDTCDd", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.fictive.com/REST/api/accounts/{accountReference}/payments\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-version': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "nageoknhVoUUjkT9Xe98X" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "[\n {\n \"cartReference\": \"0010O17IDWBV5EN4G2\",\n \"fulfilmentReferences\": [\n \"0010O17IDWBV5EN4G2\"\n ],\n \"status\": \"Completed\",\n \"paymentReference\": \"0010O17IDWBV5EN4G2\",\n \"paymentDate\": \"2021-09-21T05:33:20.1667135\",\n \"description\": \"Subscription Purchase\",\n \"paymentMethod\": \"CreditCard\",\n \"subscriptionReference\": \"0010S82FD7URMMQTA1\",\n \"pricing\": {\n \"grossAmount\": 9.99,\n \"netAmount\": 9.99,\n \"taxAmount\": 0,\n \"currency\": \"GBP\"\n },\n \"customPaymentParameters\": {},\n \"priceBreakdown\": [\n {\n \"itemReference\": \"0010O17IDWBV5EN4G2\",\n \"itemStatus\": \"Payment\",\n \"itemDescription\": \"Order line item description\",\n \"itemGrossAmount\": 10,\n \"itemNetAmount\": 8,\n \"itemTaxAmount\": 2,\n \"itemQuantity\": 0,\n \"discountOrderLineItems\": [\n {\n \"discountItemReference\": \"0010O17IDWBV5EN4G2\",\n \"discountItemStatus\": \"Payment\",\n \"offerReference\": \"0010O17IDWBV5EN4G2\",\n \"offerApplicationType\": \"LowStartOfferSubscription\",\n \"offerDescription\": \"Low start offer\",\n \"discountItemGrossAmount\": -5,\n \"discountItemNetAmount\": -4,\n \"discountItemTaxAmount\": -1\n }\n ]\n }\n ]\n },\n {\n \"cartReference\": \"0010OTP6HFY8XR9UL3\",\n \"fulfilmentReferences\": [\n \"0010O17IDWBV5EN4G2\",\n \"0010LHX0A0HB0FUXD2\"\n ],\n \"status\": \"Refunded\",\n \"paymentReference\": \"0010OTP6HFY8XR9UL3\",\n \"paymentDate\": \"2021-09-21T05:33:20.1667135\",\n \"description\": \"Refund Amount on Order\",\n \"paymentMethod\": \"CreditCard\",\n \"subscriptionReference\": \"0010SAGHR1654LPS1H\",\n \"pricing\": {\n \"grossAmount\": 10,\n \"netAmount\": 9.434,\n \"taxAmount\": 0.566,\n \"currency\": \"GBP\"\n },\n \"customPaymentParameters\": {}\n },\n {\n \"cartReference\": \"0010OTP6HFY8XR9UL3\",\n \"fulfilmentReferences\": [\n \"0010O17IDWBV5EN4G2\",\n \"0010LHX0A0HB0FUXD2\"\n ],\n \"status\": \"PartialRefunded\",\n \"paymentReference\": \"0010OTP6HFY8XR9UL4\",\n \"paymentDate\": \"2021-09-21T05:33:20.1667135+00:00\",\n \"description\": \"Order 111111\",\n \"paymentMethod\": \"CreditCard\",\n \"subscriptionReference\": \"0010SAGHR1654LPS1H\",\n \"pricing\": {\n \"grossAmount\": 10,\n \"netAmount\": 9.434,\n \"taxAmount\": 0.566,\n \"currency\": \"GBP\"\n },\n \"customPaymentParameters\": {},\n \"associatedPaymentReferences\": [\n {\n \"fulfilmentReferences\": [],\n \"status\": \"Refunded\",\n \"paymentReference\": \"0010OTP6HFY8XR9UL4\",\n \"paymentDate\": \"2021-09-22T05:33:20.1667135+00:00\",\n \"description\": \"Refund Amount on Order: 111111\",\n \"paymentMethod\": \"SEPA\",\n \"subscriptionReference\": \"0010SAGHR1654LPS1H\",\n \"pricing\": {\n \"grossAmount\": 20,\n \"netAmount\": 15,\n \"taxAmount\": 5,\n \"currency\": \"EUR\"\n }\n }\n ]\n },\n {\n \"cartReference\": \"0010OTP6HFY8XR9UL3\",\n \"fulfilmentReferences\": [],\n \"status\": \"PartialRefunded\",\n \"paymentReference\": \"0010OTP6HFY8XR9UL4\",\n \"paymentDate\": \"2021-09-21T05:33:20.1667135+00:00\",\n \"description\": \"Subscription Purchase (Auto-Renew): Bundle purchase - Bundle purchase. (Your subscription cost has been discounted by 16.25 EUR)\",\n \"paymentMethod\": \"CreditCard\",\n \"subscriptionReference\": \"0010SOIJ7XSJB9PGZ2\",\n \"pricing\": {\n \"grossAmount\": 6.25,\n \"netAmount\": 5.385,\n \"taxAmount\": 0.865,\n \"currency\": \"EUR\"\n },\n \"customPaymentParameters\": {},\n \"priceBreakdown\": [\n {\n \"itemReference\": \"0010O17IDWBV5EN4G2\",\n \"itemStatus\": \"PartiallyRefunded\",\n \"itemDescription\": \"Physical product 1\",\n \"itemGrossAmount\": 14.5,\n \"itemNetAmount\": 10,\n \"itemTaxAmount\": 4.5,\n \"itemQuantity\": 0,\n \"discountOrderLineItems\": [\n {\n \"discountItemReference\": \"0010O17IDWBV5EN4G2\",\n \"discountItemStatus\": \"Deducted\",\n \"offerReference\": \"0010O17IDWBV5EN4G2\",\n \"offerApplicationType\": \"FixedPriceDiscountOfferSubscription\",\n \"offerDescription\": \"Premium offer\",\n \"discountItemGrossAmount\": -7.25,\n \"discountItemNetAmount\": -5,\n \"discountItemTaxAmount\": -2.25\n },\n {\n \"discountItemReference\": \"001DOB1VKFBLB54JC3\",\n \"discountItemStatus\": \"Deducted\",\n \"offerReference\": \"0010O17IDWBV5EN4G2\",\n \"offerApplicationType\": \"ServiceCredits\",\n \"offerDescription\": \"ServiceCredits\",\n \"discountItemGrossAmount\": -4.4615,\n \"discountItemNetAmount\": -3.0765,\n \"discountItemTaxAmount\": -1.385\n }\n ]\n }\n ]\n }\n]" }, { "id": "response-1-204", "language": "204", "code": "// No payments found\n[\n {\n \"cartReference\": \"\",\n \"fulfilmentReferences\": [\n \"\"\n ],\n \"status\": \"\",\n \"paymentReference\": \"\",\n \"refundedPaymentReference\": \"\",\n \"paymentDate\": \"2021-09-21T05:33:19.8854322\",\n \"description\": \"\",\n \"paymentMethod\": \"\",\n \"subscriptionReference\": \"\",\n \"pricing\": {\n \"grossAmount\": \"\",\n \"netAmount\": \"\",\n \"taxAmount\": \"\",\n \"currency\": \"\"\n },\n \"customPaymentParameters\": {},\n \"priceBreakdown\": [\n {\n \"itemReference\": \"\",\n \"refundedItemReference\": \"\",\n \"itemStatus\": \"\",\n \"itemDescription\": \"\",\n \"itemGrossAmount\": \"\",\n \"itemNetAmount\": \"\",\n \"itemTaxAmount\": \"\",\n \"itemQuantity\": \"\",\n \"discountOrderLineItems\": [\n {\n \"discountItemReference\": \"\",\n \"discountItemStatus\": \"\",\n \"offerReference\": \"\",\n \"offerApplicationType\": \"\",\n \"offerDescription\": \"\",\n \"discountItemGrossAmount\": \"\",\n \"discountItemNetAmount\": \"\",\n \"discountItemTaxAmount\": \"\"\n }\n ]\n }\n ],\n \"associatedPaymentReferences\": [\n {\n \"cartReference\": \"\",\n \"fulfilmentReferences\": [\n \"\"\n ],\n \"status\": \"\",\n \"paymentReference\": \"\",\n \"refundedPaymentReference\": \"\",\n \"paymentDate\": \"2021-09-21T05:33:19.8854322\",\n \"description\": \"\",\n \"paymentMethod\": \"\",\n \"subscriptionReference\": \"\",\n \"pricing\": {\n \"grossAmount\": \"\",\n \"netAmount\": \"\",\n \"taxAmount\": \"\",\n \"currency\": \"\"\n },\n \"customPaymentParameters\": {},\n \"priceBreakdown\": [\n {\n \"itemReference\": \"\",\n \"refundedItemReference\": \"\",\n \"itemStatus\": \"\",\n \"itemDescription\": \"\",\n \"itemGrossAmount\": \"\",\n \"itemNetAmount\": \"\",\n \"itemTaxAmount\": \"\",\n \"itemQuantity\": \"\",\n \"discountOrderLineItems\": [\n {\n \"discountItemReference\": \"\",\n \"discountItemStatus\": \"\",\n \"offerReference\": \"\",\n \"offerApplicationType\": \"\",\n \"offerDescription\": \"\",\n \"discountItemGrossAmount\": \"\",\n \"discountItemNetAmount\": \"\",\n \"discountItemTaxAmount\": \"\"\n }\n ]\n }\n ],\n \"associatedPaymentReferences\": [\n \"\"\n ]\n }\n ]\n }\n]" }, { "id": "response-2-401", "language": "401", "code": "// Not Authorized\n" }, { "id": "response-3-404", "language": "404", "code": "// Account could not be found: Account cannot be found. Invalid UKI and PIN or Password.\n" }, { "id": "response-4-500", "language": "500", "code": "// Internal Server Error\n" } ], "selectedLanguageId": "response-0-200" } }, "type": "api-oas-v2", "children": [ { "text": "" } ] }