List transactions | Payrexx Octri Demo

6 body fields

Transaction filters and options for controlling the result range and ordering.

filterDatetimeUtcGreaterThanstringoptional

Lower DateTime limit in the format of YYYY-MM-DD HH:MM:SS

filterDatetimeUtcLessThanstringoptional

Upper DateTime limit in the format of YYYY-MM-DD HH:MM:SS

filterMyTransactionsOnlybooleanoptional

When set to 1, only transactions related to this API key used will be returned.

Default:false

limitintegeroptional

Max row count

offsetintegeroptional

Row count to be used as offset

orderByTimestringoptional

ASC (ascending) or DESC (descending) for ordering by time of the transaction

Allowed:"ASC""DESC"Default:ASC

3 status codes

200Returns an object containing a `data` array of transaction records and a `status` field.

dataarray<object>optional

statusstringoptional

400Returned when a filter or sorting value is invalid.

errorobjectoptional

messagestringoptional

reasonstringoptional

statusstringoptional

404Returned when no transactions match the supplied filters.

errorobjectoptional

messagestringoptional

reasonstringoptional

statusstringoptional

Error handling

A 400 is returned when a filter or sorting value is invalid. A 404 is returned when no transactions match the supplied filters. orderByTime must be ASC or DESC.

client := payrexxdemo.NewClient("https://api.payrexx.com/v1.16")

result, err := client.Transaction.List(
	ctx,
	&ListTransactionParams{
		FilterDatetimeUtcGreaterThan: "2024-01-15T09:30:00Z",
		FilterDatetimeUtcLessThan: "2024-01-15T09:30:00Z",
		FilterMyTransactionsOnly: true,
		Limit: 20,
		Offset: 0,
	},
)
if err != nil {
	log.Fatal(err)
}

"{\n    \"status\":\"success\",\n    \"data\":[\n        {\n            \"id\":1,\n            \"uuid\":\"f384000b\",\n            \"status\":\"authorized\",\n            \"time\":\"2020-01-20 15:56:02\",\n            \"lang\":\"de\",\n            \"pageUuid\":\"892dcf5c\",\n            \"payment\":{\n                \"brand\":\"visa\",\n                \"wallet\": null,\n                \"purchaseOnInvoiceInformation\": {\n                    \"zip\": \"3600\",\n                    \"iban\": \"CH7431101111011000246\",\n                    \"place\": \"Thun\",\n                    \"swift\": \"KLARCH22XXX\",\n                    \"address\": \"Burgstrasse 20\",\n                    \"company\": \"Payrexx AG\",\n                    \"bankName\": \"Klarpay AG\",\n                    \"reference\": \"287133000000000000000128000\"\n            \t\t}\n            },\n            \"payoutUuid\": \"abcd1234\",\n            \"psp\":\"Payrexx_Payments\",\n            \"pspId\":26,\n            \"mode\":\"LIVE\",\n            \"referenceId\":\"ORDER#321\",\n            \"invoice\":{\n                \"currencyAlpha3\":\"CHF\",\n                \"products\":[\n                    {\n                        \"quantity\":1,\n                        \"name\":\"Hoodie\",\n                        \"amount\":5900\n                    },\n                    {\n                        \"quantity\":2,\n                        \"name\":\"T-Shirt\",\n                        \"amount\":2850\n                    }\n                ],\n                \"discount\":{\n                    \"code\":\"SUPERSALE\",\n                    \"percentage\":33,\n                    \"amount\":3828\n                },\n                \"shippingAmount\":150000,\n                \"totalAmount\":9272,\n                \"customFields\":{\n                    \"20\":{\n                        \"name\":\"Additional Information\",\n                        \"value\":\"Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.\"\n                    }\n                }\n            },\n            \"refundable\": true,\n            \"partiallyRefundable\": true,\n            \"contact\":{\n                \"id\":16,\n                \"uuid\":\"9c9c0282\",\n                \"company\":\"FeelGood\",\n                \"title\":\"mister\",\n                \"firstname\":\"Hans\",\n                \"lastname\":\"Schmid\",\n                \"street\":\"Dorstrasse 11\",\n                \"zip\":\"1234\",\n                \"place\":\"Habern\",\n                \"country\":\"Schweiz\",\n                \"countryISO\":\"CH\",\n                \"date_of_birth\":\"10.03.1989\",\n                \"email\":\"info@example.com\",\n                \"phone\":\"+413312345678\",\n                \"delivery_company\":\"NewFashion\",\n                \"delivery_title\":\"miss\",\n                \"delivery_firstname\":\"Fabienne\",\n                \"delivery_lastname\":\"Muster\",\n                \"delivery_street\":\"Seestrasse 39\",\n                \"delivery_zip\":\"4321\",\n                \"delivery_place\":\"Nechters\",\n                \"delivery_country\":\"Schweiz\",\n                \"delivery_countryISO\":\"CH\"\n            }\n        },\n        {\n            \"id\":223,\n            \"uuid\":\"d2571806\",\n            \"status\":\"confirmed\",\n            \"time\":\"2020-01-20 16:25:58\",\n            \"lang\":\"de\",\n            \"pageUuid\":\"892dcf5c\",\n            \"payment\":{\n                \"brand\":\"visa\",\n                \"wallet\": null,\n                \"purchaseOnInvoiceInformation\": {\n                    \"zip\": \"3600\",\n                    \"iban\": \"CH7431101111011000246\",\n                    \"place\": \"Thun\",\n                    \"swift\": \"KLARCH22XXX\",\n                    \"address\": \"Burgstrasse 20\",\n                    \"company\": \"Payrexx AG\",\n                    \"bankName\": \"Klarpay AG\",\n                    \"reference\": \"287133000000000000000128000\"\n            \t\t}\n            },\n            \"payoutUuid\": \"abcd1234\",\n            \"psp\":\"Payrexx_Payments\",\n            \"pspId\":26,\n            \"mode\":\"LIVE\",\n            \"referenceId\":\"ORDER#322\",\n            \"invoice\":{\n                \"currencyAlpha3\":\"CHF\",\n                \"products\":[\n                    {\n                        \"name\":\"T-Shirt\",\n                        \"quantity\":1,\n                        \"amount\":2850\n                    }\n                ],\n                \"discount\":null,\n                \"shippingAmount\":150000,\n                \"totalAmount\":4350,\n                \"customFields\":null\n            },\n            \"refundable\": true,\n            \"partiallyRefundable\": true,\n            \"contact\":{\n                \"id\":16,\n                \"uuid\":\"9c9c0282\",\n                \"company\":\"\",\n                \"title\":\"mister\",\n                \"lastname\":\"Muster\",\n                \"firstname\":\"Hans\",\n                \"street\":\"Dorfstrasse 49\",\n                \"zip\":\"1234\",\n                \"place\":\"Habern\",\n                \"country\":\"Schweiz\",\n                \"countryISO\":\"CH\",\n                \"date_of_birth\":\"10.03.1989\",\n                \"email\":\"info@example.com\",\n                \"phone\":\"\",\n                \"delivery_company\":\"\",\n                \"delivery_title\":\"0\",\n                \"delivery_firstname\":\"\",\n                \"delivery_lastname\":\"\",\n                \"delivery_street\":\"\",\n                \"delivery_zip\":\"\",\n                \"delivery_place\":\"\",\n                \"delivery_country\":\"\",\n                \"delivery_countryISO\":\"\"\n            }\n        }\n    ]\n}"

Request

Response

Errors