List of account types
This page gives an overview over the account types supported by PayData and their additional account and transaction fields.
note
Not all types might be available to your partner. If you wish to get access to more account types, then please contact the PayData support.
Adyen
Id: adyen
JSON
{
"id": "adyen",
"name": "Adyen",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/adyen.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/adyen_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/adyen.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/adyen/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/adyen/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/adyen/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "username",
"name": "Username",
"shortDescription": "In the form report_1234@Company.Firma",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "password",
"name": "Password",
"shortDescription": null,
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "merchant-account-name",
"name": "Merchant Account Name",
"shortDescription": null,
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.7076330Z",
"values": [],
"minValue": "2000-01-21T13:04:55.1611941Z",
"maxValue": "2025-01-21T13:04:55.1611991Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "shopperEmail",
"name": "Shopper Email",
"description": "Email address of the shopper.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "shopperName",
"name": "Shopper name",
"description": "Name of the shopper.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "pspReference",
"name": "PSP Reference",
"description": "Adyen's 16-character unique reference associated with the transaction/the request",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "shopperReference",
"name": "Shopper reference",
"description": "Reference number of the shopper.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "batchId",
"name": "Batch Id",
"description": "The sequence number of the settlement.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "modificationReference",
"name": "Modification Reference",
"description": "Adyen's unique identifier (PSP reference) for the modification request.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "modificationMerchantReference",
"name": "Modification Merchant Reference",
"description": "Optional modification reference for modifications like capture or refund.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "merchantReference",
"name": "Merchant Reference",
"description": "Reference number provided when initiating the payment request.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "journalType",
"name": "Journal Type",
"description": "The Journal type of the entry.",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| username | Username | In the form report_1234@Company.Firma | Text | ✓ | |
| password | Password | Password | ✓ | ||
| merchant-account-name | Merchant Account Name | Text | ✓ | ||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| batchId | Batch Id | The sequence number of the settlement. |
| journalType | Journal Type | The Journal type of the entry. |
| merchantReference | Merchant Reference | Reference number provided when initiating the payment request. |
| modificationMerchantReference | Modification Merchant Reference | Optional modification reference for modifications like capture or refund. |
| modificationReference | Modification Reference | Adyen's unique identifier (PSP reference) for the modification request. |
| pspReference | PSP Reference | Adyen's 16-character unique reference associated with the transaction/the request |
| shopperEmail | Shopper Email | Email address of the shopper. |
| shopperName | Shopper name | Name of the shopper. |
| shopperReference | Shopper reference | Reference number of the shopper. |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Amazon
Id: amazon
JSON
{
"id": "amazon",
"name": "Amazon",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/amazon.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/amazon_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/amazon.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/amazon/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/amazon/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/amazon/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "marketplace",
"name": "Marktplatz",
"shortDescription": null,
"description": null,
"required": true,
"requiredDuringAuth": true,
"type": "Selection",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [
{
"name": "amazon.de",
"value": "amazon.de"
},
{
"name": "amazon.co.uk",
"value": "amazon.co.uk"
},
{
"name": "amazon.com",
"value": "amazon.com"
},
{
"name": "amazon.ae",
"value": "amazon.ae"
},
{
"name": "amazon.es",
"value": "amazon.es"
},
{
"name": "amazon.fr",
"value": "amazon.fr"
},
{
"name": "amazon.in",
"value": "amazon.in"
},
{
"name": "amazon.it",
"value": "amazon.it"
},
{
"name": "amazon.nl",
"value": "amazon.nl"
},
{
"name": "amazon.pl",
"value": "amazon.pl"
},
{
"name": "amazon.se",
"value": "amazon.se"
},
{
"name": "amazon.com.tr",
"value": "amazon.com.tr"
},
{
"name": "amazon.com.br",
"value": "amazon.com.br"
},
{
"name": "amazon.ca",
"value": "amazon.ca"
},
{
"name": "amazon.com.au",
"value": "amazon.com.au"
},
{
"name": "amazon.com.mx",
"value": "amazon.com.mx"
},
{
"name": "amazon.com.be",
"value": "amazon.com.be"
},
{
"name": "amazon.sg",
"value": "amazon.sg"
},
{
"name": "amazon.sa",
"value": "amazon.sa"
}
],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.6983757Z",
"values": [],
"minValue": "2000-01-21T13:04:55.1142665Z",
"maxValue": "2025-01-21T13:04:55.1143609Z",
"requiredFields": []
},
{
"id": "auth-reference",
"name": "Zugriff genehmigen",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Auth",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": [
"marketplace"
]
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique identifier",
"description": "Unique identifier generated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "invoiceNumber",
"name": "Seller or merchant order ID",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'merchantOrderId'"
},
{
"id": "orderNumber",
"name": "Amazon order number",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'orderId'"
},
{
"id": "transactionId",
"name": "Transaction ID",
"description": "Fee transaction ID or Amazon order ID.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference1",
"name": "",
"description": null,
"isDeprecated": true,
"deprecationReason": "Duplicate information, use orderId field."
},
{
"id": "reference3",
"name": "Additional Fee ID",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'additionalFeeId'"
},
{
"id": "reference4",
"name": "Additional Fee Type",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'additionalFeeType'"
},
{
"id": "marketplace",
"name": "Amazon Marketplace",
"description": "The Amazon marketplace of the transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionType",
"name": "Amazon Transaction Type",
"description": "Amazon transaction type (e.g. Order or OtherTransaction).",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionDescription",
"name": "Amazon Transaction Description",
"description": "Amazon transaction description (e.g. Current Reserve Amount or Cost of Advertising).",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderId",
"name": "Amazon Order ID",
"description": "The Amazon order ID.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "merchantOrderId",
"name": "Merchant Order ID",
"description": "Merchant or Seller order ID.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "additionalFeeId",
"name": "Additional Fee ID",
"description": "Additional fee ID for enrollments, coupons and deals.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "additionalFeeType",
"name": "Additional Fee Type",
"description": "Additional fee type for enrollments, coupons and deals.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "bookingText",
"name": "Transaction Type",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionType'"
},
{
"id": "paymentType",
"name": "Amazon Transaction Description",
"description": "Amazon transaction description (e.g. Current Reserve Amount or Cost of Advertising).",
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionDescription'"
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| marketplace | Marktplatz | Selection | ✓ | ||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ | |
| auth-reference | Zugriff genehmigen | Auth |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| additionalFeeId | Additional Fee ID | Additional fee ID for enrollments, coupons and deals. |
| additionalFeeType | Additional Fee Type | Additional fee type for enrollments, coupons and deals. |
| marketplace | Amazon Marketplace | The Amazon marketplace of the transaction. |
| merchantOrderId | Merchant Order ID | Merchant or Seller order ID. |
| orderId | Amazon Order ID | The Amazon order ID. |
| transactionDescription | Amazon Transaction Description | Amazon transaction description (e.g. Current Reserve Amount or Cost of Advertising). |
| transactionId | Transaction ID | Fee transaction ID or Amazon order ID. |
| transactionType | Amazon Transaction Type | Amazon transaction type (e.g. Order or OtherTransaction). |
| uniqueId | Unique identifier | Unique identifier generated by PayData. |
Deprecated fields
| ID | Name | Reason |
|---|---|---|
| bookingText | Transaction Type | Renamed to 'transactionType' |
| invoiceNumber | Seller or merchant order ID | Renamed to 'merchantOrderId' |
| orderNumber | Amazon order number | Renamed to 'orderId' |
| paymentType | Amazon Transaction Description | Renamed to 'transactionDescription' |
| reference1 | Duplicate information, use orderId field. | |
| reference3 | Additional Fee ID | Renamed to 'additionalFeeId' |
| reference4 | Additional Fee Type | Renamed to 'additionalFeeType' |
AmazonPay
Id: amazon_payments
JSON
{
"id": "amazon_payments",
"name": "AmazonPay",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/amazon_pay.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/amazon_pay_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/amazon_pay.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/amazon_payments/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/amazon_payments/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/amazon_payments/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "merchant-id",
"name": "Amazon Händler ID",
"shortDescription": "Die Händler-ID (Merchant-ID) von Ihrem Amazon-Konto",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "mws-auth-token",
"name": "MWS AuthToken",
"shortDescription": "Die Amazon Autorisierungsnummer (AuthToken)",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.7038474Z",
"values": [],
"minValue": "2000-01-21T13:04:55.1458525Z",
"maxValue": "2025-01-21T13:04:55.1458575Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier generated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "sellerOrderId",
"name": "Seller Order Id",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Amazon Transaction Id",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "sellerReferenceId",
"name": "Seller Reference Id",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderReferenceId",
"name": "Amazon Order Reference Id",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "settlementId",
"name": "Settlement Id",
"description": "The ID of the settlement report of this transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "storeName",
"name": "Store Name",
"description": "Name of the store.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionDescription",
"name": "Transaction Description",
"description": "Transaction description for fees (e.g. Current Reserve Balance).",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionType",
"name": "Transaction Type",
"description": "Amazon transaction type (e.g. Capture, Refund or Reserve).",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "invoiceNumber",
"name": "Amazon transaction Id",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionId'"
},
{
"id": "orderNumber",
"name": "Order Number",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'sellerOrderId'"
},
{
"id": "reference1",
"name": "Seller Reference Id",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'sellerReferenceId'"
},
{
"id": "reference2",
"name": "Amazon Order Reference Id",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'orderReferenceId'"
},
{
"id": "reference4",
"name": "Settlement Id",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'settlementId'"
},
{
"id": "marketplace",
"name": "Store Name",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'storeName'"
},
{
"id": "bookingText",
"name": "Transaction Description",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionDescription'"
},
{
"id": "paymentType",
"name": "Transaction Type",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionType'"
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| merchant-id | Amazon Händler ID | Die Händler-ID (Merchant-ID) von Ihrem Amazon-Konto | Text | ✓ | |
| mws-auth-token | MWS AuthToken | Die Amazon Autorisierungsnummer (AuthToken) | Password | ✓ | |
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| orderReferenceId | Amazon Order Reference Id | |
| sellerOrderId | Seller Order Id | |
| sellerReferenceId | Seller Reference Id | |
| settlementId | Settlement Id | The ID of the settlement report of this transaction. |
| storeName | Store Name | Name of the store. |
| transactionDescription | Transaction Description | Transaction description for fees (e.g. Current Reserve Balance). |
| transactionId | Amazon Transaction Id | |
| transactionType | Transaction Type | Amazon transaction type (e.g. Capture, Refund or Reserve). |
| uniqueId | Unique Identifier | Unique identifier generated by PayData. |
Deprecated fields
| ID | Name | Reason |
|---|---|---|
| bookingText | Transaction Description | Renamed to 'transactionDescription' |
| invoiceNumber | Amazon transaction Id | Renamed to 'transactionId' |
| marketplace | Store Name | Renamed to 'storeName' |
| orderNumber | Order Number | Renamed to 'sellerOrderId' |
| paymentType | Transaction Type | Renamed to 'transactionType' |
| reference1 | Seller Reference Id | Renamed to 'sellerReferenceId' |
| reference2 | Amazon Order Reference Id | Renamed to 'orderReferenceId' |
| reference4 | Settlement Id | Renamed to 'settlementId' |
AvocadoStore (CSV)
Id: avocadostore_csv
JSON
{
"id": "avocadostore_csv",
"name": "AvocadoStore (CSV)",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/avocadostore_csv.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/avocadostore_csv_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/avocadostore_csv.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/avocadostore_csv/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/avocadostore_csv/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/avocadostore_csv/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "email-address",
"name": "E-Mail-Adresse",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": true,
"readOnly": true,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customer",
"name": "Customer",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderNumber",
"name": "Order Number",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionDescription",
"name": "Transaction Description",
"description": "Description of the transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "settlementId",
"name": "Settlement ID",
"description": "ID of the Avocadostore settlement (e.g. S21026342).",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionType",
"name": "Transaction Type",
"description": "Type of the transaction (e.g. Gutschrift, Belastung).",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| email-address | E-Mail-Adresse | Text | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| customer | Customer | |
| orderNumber | Order Number | |
| settlementId | Settlement ID | ID of the Avocadostore settlement (e.g. S21026342). |
| transactionDescription | Transaction Description | Description of the transaction. |
| transactionType | Transaction Type | Type of the transaction (e.g. Gutschrift, Belastung). |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
B&S Card
Id: bundscard
JSON
{
"id": "bundscard",
"name": "B&S Card",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/bundscard.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/bundscard_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/bundscard.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/bundscard/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/bundscard/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/bundscard/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "email-address",
"name": "E-Mail-Adresse",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": true,
"readOnly": true,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerName",
"name": "Customer Name",
"description": "Name of the customer.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "merchantReference",
"name": "Merchant Reference",
"description": "Reference number from the merchant.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerNumber",
"name": "Customer Number",
"description": "Customer number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "cardType",
"name": "Card Type",
"description": "Type of the creditcard.",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| email-address | E-Mail-Adresse | Text | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| cardType | Card Type | Type of the creditcard. |
| customerName | Customer Name | Name of the customer. |
| customerNumber | Customer Number | Customer number. |
| merchantReference | Merchant Reference | Reference number from the merchant. |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Check24 (CSV)
Id: check24_csv
JSON
{
"id": "check24_csv",
"name": "Check24 (CSV)",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/check24_csv.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/check24_csv_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/check24_csv.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/check24_csv/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/check24_csv/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/check24_csv/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "email-address",
"name": "E-Mail-Adresse",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": true,
"readOnly": true,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "firstAndLastName",
"name": "First and Last Name",
"description": "First and last name of the buyer.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderNumberShop",
"name": "Order Number (Shop)",
"description": "Order number from the shop.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderNumber",
"name": "Order Number",
"description": "Order number from the CHECK24.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "correctionDescription",
"name": "Correction Description",
"description": "Description describing the correction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "shop",
"name": "Shop",
"description": "Name of the shop where the transaction originates from.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "productName",
"name": "Product Name",
"description": "Name of the sold product.",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| email-address | E-Mail-Adresse | Text | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| correctionDescription | Correction Description | Description describing the correction. |
| firstAndLastName | First and Last Name | First and last name of the buyer. |
| orderNumber | Order Number | Order number from the CHECK24. |
| orderNumberShop | Order Number (Shop) | Order number from the shop. |
| productName | Product Name | Name of the sold product. |
| shop | Shop | Name of the shop where the transaction originates from. |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Conrad
Id: conrad
JSON
{
"id": "conrad",
"name": "Conrad",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/conrad.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/conrad_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/conrad.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/conrad/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/conrad/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/conrad/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "api-key",
"name": "API-Schlüssel",
"shortDescription": null,
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "shop-id",
"name": "Shop-ID",
"shortDescription": "Optionale Shop-ID, wenn mehrere Shops im Einsatz sind.",
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "shop-name",
"name": "Shop-Name",
"shortDescription": "Wird automatisch gesetzt.",
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": true,
"defaultValue": "unbekannt",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8422597Z",
"values": [],
"minValue": "2000-01-21T13:04:55.3709829Z",
"maxValue": "2025-01-21T13:04:55.3709880Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "accountingDocumentNumber",
"name": "Accounting Document Number",
"description": "The billing cycle's accounting document number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderId",
"name": "Order ID",
"description": "Order ID of the transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentImprintNumber",
"name": "Payment Imprint Number",
"description": "The received payment imprint number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentType",
"name": "Payment Type",
"description": "The payment's type used by the customer to pay this order.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Transaction Id",
"description": "Identifier of the transaction from Conrad.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionType",
"name": "Transaction Type",
"description": "Type of transaction (refund, transaction fee, etc ...).",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| api-key | API-Schlüssel | Password | ✓ | ||
| shop-id | Shop-ID | Optionale Shop-ID, wenn mehrere Shops im Einsatz sind. | Text | ||
| shop-name | Shop-Name | Wird automatisch gesetzt. | Text | ✓ | |
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| accountingDocumentNumber | Accounting Document Number | The billing cycle's accounting document number. |
| orderId | Order ID | Order ID of the transaction. |
| paymentImprintNumber | Payment Imprint Number | The received payment imprint number. |
| paymentType | Payment Type | The payment's type used by the customer to pay this order. |
| transactionId | Transaction Id | Identifier of the transaction from Conrad. |
| transactionType | Transaction Type | Type of transaction (refund, transaction fee, etc ...). |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Decathlon (EU)
Id: decathlon
JSON
{
"id": "decathlon",
"name": "Decathlon (EU)",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/decathlon.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/decathlon_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/decathlon.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/decathlon/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/decathlon/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/decathlon/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "api-key",
"name": "API-Schlüssel",
"shortDescription": null,
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "shop-id",
"name": "Shop-ID",
"shortDescription": "Optionale Shop-ID, wenn mehrere Shops im Einsatz sind.",
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "shop-name",
"name": "Shop-Name",
"shortDescription": "Wird automatisch gesetzt.",
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": true,
"defaultValue": "unbekannt",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8447816Z",
"values": [],
"minValue": "2000-01-21T13:04:55.3826097Z",
"maxValue": "2025-01-21T13:04:55.3826158Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "accountingDocumentNumber",
"name": "Accounting Document Number",
"description": "The billing cycle's accounting document number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderId",
"name": "Order ID",
"description": "Order ID of the transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentImprintNumber",
"name": "Payment Imprint Number",
"description": "The received payment imprint number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentType",
"name": "Payment Type",
"description": "The payment's type used by the customer to pay this order.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Transaction Id",
"description": "Identifier of the transaction from Decathlon (EU).",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionType",
"name": "Transaction Type",
"description": "Type of transaction (refund, transaction fee, etc ...).",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| api-key | API-Schlüssel | Password | ✓ | ||
| shop-id | Shop-ID | Optionale Shop-ID, wenn mehrere Shops im Einsatz sind. | Text | ||
| shop-name | Shop-Name | Wird automatisch gesetzt. | Text | ✓ | |
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| accountingDocumentNumber | Accounting Document Number | The billing cycle's accounting document number. |
| orderId | Order ID | Order ID of the transaction. |
| paymentImprintNumber | Payment Imprint Number | The received payment imprint number. |
| paymentType | Payment Type | The payment's type used by the customer to pay this order. |
| transactionId | Transaction Id | Identifier of the transaction from Decathlon (EU). |
| transactionType | Transaction Type | Type of transaction (refund, transaction fee, etc ...). |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
eBay Payments
Id: ebay_payments_api
JSON
{
"id": "ebay_payments_api",
"name": "eBay Payments",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/ebay_payments_api.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/ebay_payments_api_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/ebay_payments_api.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/ebay_payments_api/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/ebay_payments_api/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/ebay_payments_api/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "auth-reference",
"name": "Zugriff auf eBay Konto genehmigen",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Auth",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "ebay-username",
"name": "eBay Username",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": true,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8162178Z",
"values": [],
"minValue": "2000-01-21T13:04:55.3078680Z",
"maxValue": "2025-01-21T13:04:55.3078732Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "userName",
"name": "User name",
"description": "The eBay user name of the buyer.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderId",
"name": "Order Id",
"description": "The unique identifier of the eBay order associated with the monetary transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Transaction ID",
"description": "The unique identifier of the monetary transaction. A monetary transaction can be a sales order, an order refund to the buyer, a credit to the seller's account, a debit to the seller for the purchase of a shipping label, or a transaction where eBay recouped money from the seller if the seller lost a buyer-initiated payment dispute.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payoutId",
"name": "Payout Id",
"description": "The unique identifier of the seller payout associated with the monetary transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionStatus",
"name": "Status",
"description": "This value indicates the status of the seller payout associated with the monetary transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionMemo",
"name": "Transaction Memo",
"description": "This field provides more details on shipping label transactions and transactions where the funds are being held by eBay. For shipping label transactions, the transactionMemo gives details about a purchase, a refund, or a price adjustment to the cost of the shipping label. For on-hold transactions, the transactionMemo provides information on the reason for the hold or when the hold will be released (e.g., \"Funds on hold. Estimated release on Jun 1\").",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionType",
"name": "Transaction Type",
"description": "This value indicates the type of monetary transaction. Examples of monetary transactions include a buyer's payment for an order, a refund to the buyer for a returned item or cancelled order, or a credit issued by eBay to the seller's account.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "salesRecordReference",
"name": "Sales record reference",
"description": "The Sales Record Number associated with a sales order. Sales Record Numbers are Selling Manager/Selling Manager Pro identifiers that are created at order checkout.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payoutInstrument",
"name": "Payout Instrument",
"description": "This value is the seller-provided nickname that the seller uses to represent the bank account that receives the payout.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payerName1",
"name": "User name",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'userName'."
},
{
"id": "orderNumber",
"name": "Order Id",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'orderId'."
},
{
"id": "reference1",
"name": "Payout Id",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'payoutId'."
},
{
"id": "reference2",
"name": "Sales record reference",
"description": null,
"isDeprecated": true,
"deprecationReason": "Split into 'salesRecordReference' and 'payoutInstrument'."
},
{
"id": "reference3",
"name": "Status",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionStatus'."
},
{
"id": "reference4",
"name": "Booking entry",
"description": null,
"isDeprecated": true,
"deprecationReason": "Removed as value is just of internal use."
},
{
"id": "bookingText",
"name": "Memo",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionMemo'."
},
{
"id": "paymentType",
"name": "Transaction Type",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionType'."
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| auth-reference | Zugriff auf eBay Konto genehmigen | Auth | |||
| ebay-username | eBay Username | Text | ✓ | ||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| orderId | Order Id | The unique identifier of the eBay order associated with the monetary transaction. |
| payoutId | Payout Id | The unique identifier of the seller payout associated with the monetary transaction. |
| payoutInstrument | Payout Instrument | This value is the seller-provided nickname that the seller uses to represent the bank account that receives the payout. |
| salesRecordReference | Sales record reference | The Sales Record Number associated with a sales order. Sales Record Numbers are Selling Manager/Selling Manager Pro identifiers that are created at order checkout. |
| transactionId | Transaction ID | The unique identifier of the monetary transaction. A monetary transaction can be a sales order, an order refund to the buyer, a credit to the seller's account, a debit to the seller for the purchase of a shipping label, or a transaction where eBay recouped money from the seller if the seller lost a buyer-initiated payment dispute. |
| transactionMemo | Transaction Memo | This field provides more details on shipping label transactions and transactions where the funds are being held by eBay. For shipping label transactions, the transactionMemo gives details about a purchase, a refund, or a price adjustment to the cost of the shipping label. For on-hold transactions, the transactionMemo provides information on the reason for the hold or when the hold will be released (e.g., "Funds on hold. Estimated release on Jun 1"). |
| transactionStatus | Status | This value indicates the status of the seller payout associated with the monetary transaction. |
| transactionType | Transaction Type | This value indicates the type of monetary transaction. Examples of monetary transactions include a buyer's payment for an order, a refund to the buyer for a returned item or cancelled order, or a credit issued by eBay to the seller's account. |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
| userName | User name | The eBay user name of the buyer. |
Deprecated fields
| ID | Name | Reason |
|---|---|---|
| bookingText | Memo | Renamed to 'transactionMemo'. |
| orderNumber | Order Id | Renamed to 'orderId'. |
| payerName1 | User name | Renamed to 'userName'. |
| paymentType | Transaction Type | Renamed to 'transactionType'. |
| reference1 | Payout Id | Renamed to 'payoutId'. |
| reference2 | Sales record reference | Split into 'salesRecordReference' and 'payoutInstrument'. |
| reference3 | Status | Renamed to 'transactionStatus'. |
| reference4 | Booking entry | Removed as value is just of internal use. |
Etsy
Id: etsy_api
JSON
{
"id": "etsy_api",
"name": "Etsy",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/etsy.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/etsy_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/etsy.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/etsy_api/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/etsy_api/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/etsy_api/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "auth-reference",
"name": "Zugriff genehmigen",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Auth",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "shop-name",
"name": "Shop-Name",
"shortDescription": "Der Name des Shops, welcher in der Etsy URL zu sehen ist.",
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": true,
"defaultValue": "Unbekannt",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "text-1",
"name": " ",
"shortDescription": null,
"description": "Der Begriff 'Etsy' ist ein Markenzeichen von Etsy, Inc. Diese Anwendung verwendet die Etsy-API, sie wurde jedoch von Etsy weder befürwortet noch zertifiziert.",
"required": false,
"requiredDuringAuth": false,
"type": "TextLine",
"generated": false,
"readOnly": true,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8246920Z",
"values": [],
"minValue": "2000-01-21T13:04:55.3225655Z",
"maxValue": "2025-01-21T13:04:55.3225722Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "buyerName",
"name": "Buyer Name",
"description": "Name of the buyer on the receipt.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "buyerMail",
"name": "Buyer Mail",
"description": "E-Mail of the buyer on the receipt.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "receiptId",
"name": "Receipt ID",
"description": "Etsy ID of the receipt",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "buyerUserId",
"name": "Buyer User Id",
"description": "Etsy user ID of the buyer.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentMethod",
"name": "Payment Method",
"description": "Payment method of the receipt.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentAdjustmentReasonCode",
"name": "Payment Adjustment Reason Code",
"description": "Reason for the payment adjustment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "ledgerEntryDescription",
"name": "Ledger Entry Description",
"description": "Description of the ledger entry.",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| auth-reference | Zugriff genehmigen | Auth | |||
| shop-name | Shop-Name | Der Name des Shops, welcher in der Etsy URL zu sehen ist. | Text | ✓ | |
| text-1 | TextLine | ✓ | |||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| buyerMail | Buyer Mail | E-Mail of the buyer on the receipt. |
| buyerName | Buyer Name | Name of the buyer on the receipt. |
| buyerUserId | Buyer User Id | Etsy user ID of the buyer. |
| ledgerEntryDescription | Ledger Entry Description | Description of the ledger entry. |
| paymentAdjustmentReasonCode | Payment Adjustment Reason Code | Reason for the payment adjustment. |
| paymentMethod | Payment Method | Payment method of the receipt. |
| receiptId | Receipt ID | Etsy ID of the receipt |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
GoCardless
Id: gocardless
JSON
{
"id": "gocardless",
"name": "GoCardless",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/gocardless.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/gocardless_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/gocardless.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/gocardless/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/gocardless/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/gocardless/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "auth-reference",
"name": "Zugriff auf GoCardless genehmigen",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Auth",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8308936Z",
"values": [],
"minValue": "2000-01-21T13:04:55.3339256Z",
"maxValue": "2025-01-21T13:04:55.3339307Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Transaction ID",
"description": "GoCardless unique identifier, beginning with \"PM\" for transactions or \"PO\" for payouts.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference",
"name": "Transaction Reference",
"description": "An optional reference that will appear on your customer's bank statement.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "description",
"name": "Transaction Description",
"description": "A human-readable description of the payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "metadata",
"name": "Metadata",
"description": "Newline separated GoCardless transaction metadata.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payoutType",
"name": "Payout Type",
"description": "Whether a payout contains merchant revenue or partner fees.",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| auth-reference | Zugriff auf GoCardless genehmigen | Auth | |||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| description | Transaction Description | A human-readable description of the payment. |
| metadata | Metadata | Newline separated GoCardless transaction metadata. |
| payoutType | Payout Type | Whether a payout contains merchant revenue or partner fees. |
| reference | Transaction Reference | An optional reference that will appear on your customer's bank statement. |
| transactionId | Transaction ID | GoCardless unique identifier, beginning with "PM" for transactions or "PO" for payouts. |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Kaufland (API)
Id: kaufland_api
JSON
{
"id": "kaufland_api",
"name": "Kaufland (API)",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/real.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/real_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/real.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/kaufland_api/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/kaufland_api/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/kaufland_api/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "client-key",
"name": "Client Key",
"shortDescription": null,
"description": "Client Key for Kaufland API.",
"required": true,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": "",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "secret-key",
"name": "Secret Key",
"shortDescription": null,
"description": "Secret Key for Kaufland API.",
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": "",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "storefront",
"name": "Storefront",
"shortDescription": null,
"description": "Storefront to be fetched.",
"required": true,
"requiredDuringAuth": false,
"type": "Selection",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [
{
"name": "de",
"value": "de"
},
{
"name": "cz",
"value": "cz"
},
{
"name": "sk",
"value": "sk"
},
{
"name": "pl",
"value": "pl"
},
{
"name": "at",
"value": "at"
}
],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8336313Z",
"values": [],
"minValue": "2000-01-21T13:04:55.3465891Z",
"maxValue": "2025-01-21T13:04:55.3465950Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "buyerEmail",
"name": "Buyer Email",
"description": "Buyer's Kaufland proxy email address.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderNumber",
"name": "Order Number",
"description": "Transaction booking number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "bookingText",
"name": "Booking Text",
"description": "Transaction booking text. Provides essential details about the transaction type and payment flow.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "billingName",
"name": "Full Name",
"description": "Full name of the billed customer.",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| client-key | Client Key | Text | ✓ | ||
| secret-key | Secret Key | Password | ✓ | ||
| storefront | Storefront | Selection | ✓ | ||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| billingName | Full Name | Full name of the billed customer. |
| bookingText | Booking Text | Transaction booking text. Provides essential details about the transaction type and payment flow. |
| buyerEmail | Buyer Email | Buyer's Kaufland proxy email address. |
| orderNumber | Order Number | Transaction booking number. |
Kaufland.de
Id: real
JSON
{
"id": "real",
"name": "Kaufland.de",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/real.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/real_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/real.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/real/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/real/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/real/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "email-address",
"name": "E-Mail-Adresse",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": true,
"readOnly": true,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "buyerEmail",
"name": "Buyer Email",
"description": "Buyer's Kaufland proxy email address.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderNumber",
"name": "Order Number",
"description": "Transaction booking number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "bookingText",
"name": "Booking Text",
"description": "Transaction booking text. Provides essential details about the transaction type and payment flow.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "billingName",
"name": "Full Name",
"description": "Full name of the billed customer.",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| email-address | E-Mail-Adresse | Text | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| billingName | Full Name | Full name of the billed customer. |
| bookingText | Booking Text | Transaction booking text. Provides essential details about the transaction type and payment flow. |
| buyerEmail | Buyer Email | Buyer's Kaufland proxy email address. |
| orderNumber | Order Number | Transaction booking number. |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Klarna
Id: klarna_api
JSON
{
"id": "klarna_api",
"name": "Klarna",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/klarna.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/klarna_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/klarna.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/klarna_api/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/klarna_api/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/klarna_api/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "username",
"name": "Username",
"shortDescription": null,
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "password",
"name": "Passwort",
"shortDescription": null,
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8365140Z",
"values": [],
"minValue": "2000-01-21T13:04:55.3589314Z",
"maxValue": "2025-01-21T13:04:55.3589362Z",
"requiredFields": []
},
{
"id": "shopify-hint",
"name": "Shopify",
"shortDescription": null,
"description": "Verknüpfen Sie zusätzlich Ihren Shopify Shop, wenn Sie dort Klarna als Zahlungsmethode einsetzen und die Shopify Bestellnummern benötigen. Mehr Infos finden Sie in der <a target=\"_blank\" href=\"https://hilfe.payjoe.de/payjoe-hilfe/systeme-anbinden/zahlungssysteme/klarna.php\">PayJoe Hilfe</a>.",
"required": false,
"requiredDuringAuth": false,
"type": "TextLine",
"generated": false,
"readOnly": true,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "shopify-shop-url",
"name": "Shop-URL",
"shortDescription": "The shop URL in the form of: myshop.myshopify.com",
"description": null,
"required": false,
"requiredDuringAuth": true,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "shopify-access-token",
"name": "Shopify Admin-API-Zugriffstoken",
"shortDescription": "Der Zugriffstoken Ihrer benutzerdefinierten Shopify App",
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "shopifyOrderNumber",
"name": "Shopify Order Number",
"description": "Shopify order number, if the account was authorized to access the Shopify orders.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "shopifyOrderId",
"name": "Short Order ID or Shopify Order ID",
"description": "Shopify order ID, if the account was authorized to access the Shopify orders.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Transaction ID",
"description": "Capture, refund or payout ID from Klarna.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "merchantReference1",
"name": "Merchant Reference 1",
"description": "Internal reference to the order, that has been submitted during order creation.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "merchantReference2",
"name": "Merchant Reference 2",
"description": "Internal reference to the order, that has been submitted during order creation.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderId",
"name": "Order ID",
"description": "Unique identifier of the order.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentReference",
"name": "Payment Reference",
"description": "The reference ID of the payout.",
"isDeprecated": true,
"deprecationReason": "Same reference ID for all transactions of a settlement report. Information available as report name through the reports endpoint."
},
{
"id": "shortOrderId",
"name": "Short Order ID",
"description": "Customer-facing order ID.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionType",
"name": "Transaction Type",
"description": "The type of transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "bookingText",
"name": "Short Order ID",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'shortOrderId'"
},
{
"id": "reference1",
"name": "Merchant Reference 1",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'merchantReference1'"
},
{
"id": "reference2",
"name": "Merchant Reference 2",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'merchantReference2'"
},
{
"id": "reference3",
"name": "Order ID",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'orderId'"
},
{
"id": "reference4",
"name": "Payment Reference",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'paymentReference'"
},
{
"id": "paymentType",
"name": "Transaction Type",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionType'"
},
{
"id": "invoiceNumber",
"name": "Shopify Order Number",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionType'"
},
{
"id": "orderNumber",
"name": "Short Order ID or Shopify Order ID",
"description": null,
"isDeprecated": true,
"deprecationReason": "Split into to 'shopifyOrderId' and 'shortOrderId'"
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| username | Username | Text | ✓ | ||
| password | Passwort | Password | ✓ | ||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ | |
| shopify-hint | Shopify | TextLine | ✓ | ||
| shopify-shop-url | Shop-URL | The shop URL in the form of: myshop.myshopify.com | Text | ||
| shopify-access-token | Shopify Admin-API-Zugriffstoken | Der Zugriffstoken Ihrer benutzerdefinierten Shopify App | Password |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| merchantReference1 | Merchant Reference 1 | Internal reference to the order, that has been submitted during order creation. |
| merchantReference2 | Merchant Reference 2 | Internal reference to the order, that has been submitted during order creation. |
| orderId | Order ID | Unique identifier of the order. |
| shopifyOrderId | Short Order ID or Shopify Order ID | Shopify order ID, if the account was authorized to access the Shopify orders. |
| shopifyOrderNumber | Shopify Order Number | Shopify order number, if the account was authorized to access the Shopify orders. |
| shortOrderId | Short Order ID | Customer-facing order ID. |
| transactionId | Transaction ID | Capture, refund or payout ID from Klarna. |
| transactionType | Transaction Type | The type of transaction. |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Deprecated fields
| ID | Name | Reason |
|---|---|---|
| bookingText | Short Order ID | Renamed to 'shortOrderId' |
| invoiceNumber | Shopify Order Number | Renamed to 'transactionType' |
| orderNumber | Short Order ID or Shopify Order ID | Split into to 'shopifyOrderId' and 'shortOrderId' |
| paymentReference | Payment Reference | Same reference ID for all transactions of a settlement report. Information available as report name through the reports endpoint. |
| paymentType | Transaction Type | Renamed to 'transactionType' |
| reference1 | Merchant Reference 1 | Renamed to 'merchantReference1' |
| reference2 | Merchant Reference 2 | Renamed to 'merchantReference2' |
| reference3 | Order ID | Renamed to 'orderId' |
| reference4 | Payment Reference | Renamed to 'paymentReference' |
MediaMarktSaturn
Id: mediamarktsaturn
JSON
{
"id": "mediamarktsaturn",
"name": "MediaMarktSaturn",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/mediamarktsaturn.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/mediamarktsaturn_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/mediamarktsaturn.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/mediamarktsaturn/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/mediamarktsaturn/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/mediamarktsaturn/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "api-key",
"name": "API-Schlüssel",
"shortDescription": null,
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "shop-id",
"name": "Shop-ID",
"shortDescription": "Optionale Shop-ID, wenn mehrere Shops im Einsatz sind.",
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "shop-name",
"name": "Shop-Name",
"shortDescription": "Wird automatisch gesetzt.",
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": true,
"defaultValue": "unbekannt",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8470952Z",
"values": [],
"minValue": "2000-01-21T13:04:55.3940053Z",
"maxValue": "2025-01-21T13:04:55.3940105Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "accountingDocumentNumber",
"name": "Accounting Document Number",
"description": "The billing cycle's accounting document number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderId",
"name": "Order ID",
"description": "Order ID of the transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentImprintNumber",
"name": "Payment Imprint Number",
"description": "The received payment imprint number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentType",
"name": "Payment Type",
"description": "The payment's type used by the customer to pay this order.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Transaction Id",
"description": "Identifier of the transaction from MediaMarktSaturn.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionType",
"name": "Transaction Type",
"description": "Type of transaction (refund, transaction fee, etc ...).",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| api-key | API-Schlüssel | Password | ✓ | ||
| shop-id | Shop-ID | Optionale Shop-ID, wenn mehrere Shops im Einsatz sind. | Text | ||
| shop-name | Shop-Name | Wird automatisch gesetzt. | Text | ✓ | |
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| accountingDocumentNumber | Accounting Document Number | The billing cycle's accounting document number. |
| orderId | Order ID | Order ID of the transaction. |
| paymentImprintNumber | Payment Imprint Number | The received payment imprint number. |
| paymentType | Payment Type | The payment's type used by the customer to pay this order. |
| transactionId | Transaction Id | Identifier of the transaction from MediaMarktSaturn. |
| transactionType | Transaction Type | Type of transaction (refund, transaction fee, etc ...). |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Mollie
Id: mollie
JSON
{
"id": "mollie",
"name": "Mollie",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/mollie.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/mollie_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/mollie.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/mollie/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/mollie/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/mollie/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "auth-reference",
"name": "Zugriff auf Mollie genehmigen",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Auth",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "organization",
"name": "Unternehmen",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": true,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8547865Z",
"values": [],
"minValue": "2000-01-21T13:04:55.4306746Z",
"maxValue": "2025-01-21T13:04:55.4306794Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Capture, refund, chargeback or settlement ID from mollie.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerBic",
"name": "Customer BIC",
"description": "BIC of the customer for bank payments.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerIban",
"name": "Customer IBAN",
"description": "IBAN of the customer for bank payments.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerMail",
"name": "Customer Mail",
"description": "Mail address of the customer.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerName",
"name": "Customer Name",
"description": "Name of the customer or card holder.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "invoiceNumber",
"name": "Settlement Invoice Id / Metadata Invoice",
"description": null,
"isDeprecated": true,
"deprecationReason": "Split into 'settlementInvoiceId' and 'metadataInvoice'."
},
{
"id": "orderId",
"name": "Order ID",
"description": "Order ID from the payment or metadata.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Transaction ID",
"description": "Capture, refund, chargeback or settlement ID from mollie.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerId",
"name": "Customer Id",
"description": "Mollie customer ID.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference1",
"name": "",
"description": null,
"isDeprecated": true,
"deprecationReason": "Split into 'paymentReference' and 'paymentId'"
},
{
"id": "reference2",
"name": "",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'paymentReference'"
},
{
"id": "reference3",
"name": "",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'paymentReference'"
},
{
"id": "transactionStatus",
"name": "Transaction Status",
"description": "Status of the payment or refund.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionDescription",
"name": "Transaction description",
"description": "Description of the payment or fee.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentType",
"name": "",
"description": null,
"isDeprecated": true,
"deprecationReason": "Split into 'transactionType' and 'paymentMethod'"
},
{
"id": "settlementInvoiceId",
"name": "Settlement Invoice Id",
"description": "Invoice ID for payouts.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "metadataInvoice",
"name": "Invoice metadata field",
"description": "Metadata field 'invoice' from the payment metadata.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderNumber",
"name": "Order ID",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'orderId'"
},
{
"id": "paymentId",
"name": "Payment ID",
"description": "ID of the original payment for a chargeback or refund.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentReference",
"name": "Payment Reference",
"description": "Payment reference, if available (e.g PayPal transaction ID or Shopify payment/refund ID).",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference4",
"name": "Transaction Status",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionStatus'"
},
{
"id": "bookingText",
"name": "Transaction description",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionDescription'"
},
{
"id": "transactionType",
"name": "Transaction Type",
"description": "Type of the Mollie transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentMethod",
"name": "Payment Method",
"description": "Method of the payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payerName1",
"name": "Customer Mail",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'customerMail'"
},
{
"id": "payerName2",
"name": "Customer Name",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'customerName'"
},
{
"id": "payerBic",
"name": "Customer BIC",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'customerBic'"
},
{
"id": "payerIban",
"name": "Customer IBAN",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'customerIban'"
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| auth-reference | Zugriff auf Mollie genehmigen | Auth | |||
| organization | Unternehmen | Text | ✓ | ||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| customerBic | Customer BIC | BIC of the customer for bank payments. |
| customerIban | Customer IBAN | IBAN of the customer for bank payments. |
| customerId | Customer Id | Mollie customer ID. |
| customerMail | Customer Mail | Mail address of the customer. |
| customerName | Customer Name | Name of the customer or card holder. |
| metadataInvoice | Invoice metadata field | Metadata field 'invoice' from the payment metadata. |
| orderId | Order ID | Order ID from the payment or metadata. |
| paymentId | Payment ID | ID of the original payment for a chargeback or refund. |
| paymentMethod | Payment Method | Method of the payment. |
| paymentReference | Payment Reference | Payment reference, if available (e.g PayPal transaction ID or Shopify payment/refund ID). |
| settlementInvoiceId | Settlement Invoice Id | Invoice ID for payouts. |
| transactionDescription | Transaction description | Description of the payment or fee. |
| transactionId | Transaction ID | Capture, refund, chargeback or settlement ID from mollie. |
| transactionStatus | Transaction Status | Status of the payment or refund. |
| transactionType | Transaction Type | Type of the Mollie transaction. |
| uniqueId | Unique Identifier | Capture, refund, chargeback or settlement ID from mollie. |
Deprecated fields
| ID | Name | Reason |
|---|---|---|
| bookingText | Transaction description | Renamed to 'transactionDescription' |
| invoiceNumber | Settlement Invoice Id / Metadata Invoice | Split into 'settlementInvoiceId' and 'metadataInvoice'. |
| orderNumber | Order ID | Renamed to 'orderId' |
| payerBic | Customer BIC | Renamed to 'customerBic' |
| payerIban | Customer IBAN | Renamed to 'customerIban' |
| payerName1 | Customer Mail | Renamed to 'customerMail' |
| payerName2 | Customer Name | Renamed to 'customerName' |
| paymentType | Split into 'transactionType' and 'paymentMethod' | |
| reference1 | Split into 'paymentReference' and 'paymentId' | |
| reference2 | Renamed to 'paymentReference' | |
| reference3 | Renamed to 'paymentReference' | |
| reference4 | Transaction Status | Renamed to 'transactionStatus' |
Novalnet
Id: novalnet
JSON
{
"id": "novalnet",
"name": "Novalnet",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/novalnet.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/novalnet_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/novalnet.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/novalnet/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/novalnet/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/novalnet/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "email-address",
"name": "E-Mail-Adresse",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": true,
"readOnly": true,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| email-address | E-Mail-Adresse | Text | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Otto (CSV)
Id: otto_csv
JSON
{
"id": "otto_csv",
"name": "Otto (CSV)",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/otto_csv.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/otto_csv_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/otto_csv.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/otto_csv/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/otto_csv/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/otto_csv/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "email-address",
"name": "E-Mail-Adresse",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": true,
"readOnly": true,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "invoiceId",
"name": "Invoice ID",
"description": "'RechnungID' or 'Invoice ID' column from the CSV file.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderNumber",
"name": "Order Number",
"description": "'Auftragsnummer' or 'Order Number' column from the CSV file.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "bookingId",
"name": "Booking ID",
"description": "'VorgangsID' or 'Booking ID' column from the CSV file.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "referenceBookingId",
"name": "Reference Booking ID",
"description": "'Reference Booking ID' column from the CSV file.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "bookingType",
"name": "Booking Type",
"description": "'Vorgangstyp' or 'Booking Type' column fol the CSV file.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Transaction Id",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'bookingId'"
},
{
"id": "paymentType",
"name": "Payment Type",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'bookingType'"
},
{
"id": "invoiceNumber",
"name": "Invoice number",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'invoiceId'"
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| email-address | E-Mail-Adresse | Text | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| bookingId | Booking ID | 'VorgangsID' or 'Booking ID' column from the CSV file. |
| bookingType | Booking Type | 'Vorgangstyp' or 'Booking Type' column fol the CSV file. |
| invoiceId | Invoice ID | 'RechnungID' or 'Invoice ID' column from the CSV file. |
| orderNumber | Order Number | 'Auftragsnummer' or 'Order Number' column from the CSV file. |
| referenceBookingId | Reference Booking ID | 'Reference Booking ID' column from the CSV file. |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Deprecated fields
| ID | Name | Reason |
|---|---|---|
| invoiceNumber | Invoice number | Renamed to 'invoiceId' |
| paymentType | Payment Type | Renamed to 'bookingType' |
| transactionId | Transaction Id | Renamed to 'bookingId' |
Payone
Id: payone
JSON
{
"id": "payone",
"name": "Payone",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/payone.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/payone_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/payone.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/payone/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/payone/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/payone/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "email-address",
"name": "E-Mail-Adresse",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": true,
"readOnly": true,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "firstName",
"name": "First Name",
"description": "First name of the buyer.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "lastName",
"name": "Last Name",
"description": "Last name of the buyer.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "txId",
"name": "Transaction ID",
"description": "Transaction ID of the PAYONE platform.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "documentReference",
"name": "Document Reference",
"description": "External reference number of the payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference",
"name": "Reference",
"description": "Reference from the merchant.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "email",
"name": "User E-Mail",
"description": "Buyer e-mail address.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "event",
"name": "Event",
"description": "Type of the transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "clearingType",
"name": "Clearing Type",
"description": "Payment type category.",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| email-address | E-Mail-Adresse | Text | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| clearingType | Clearing Type | Payment type category. |
| documentReference | Document Reference | External reference number of the payment. |
| User E-Mail | Buyer e-mail address. | |
| event | Event | Type of the transaction. |
| firstName | First Name | First name of the buyer. |
| lastName | Last Name | Last name of the buyer. |
| reference | Reference | Reference from the merchant. |
| txId | Transaction ID | Transaction ID of the PAYONE platform. |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
PayPal
Id: paypal
JSON
{
"id": "paypal",
"name": "PayPal",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/paypal.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/paypal_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/paypal.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/paypal/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/paypal/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/paypal/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "auth-reference",
"name": "Zugriff auf PayPal-Konto genehmigen",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Auth",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8583736Z",
"values": [],
"minValue": "2023-01-21T13:04:55.4442551Z",
"maxValue": "2025-01-21T13:04:55.4442602Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier for the PayData transaction (PayPal Transaction ID).",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payerMail",
"name": "Payer E-Mail",
"description": "E-Mail address of the payer.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payerName",
"name": "Payer name",
"description": "Name/username of the payer.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "invoiceId",
"name": "Invoice-ID",
"description": "Invoice ID from the PayPal payment info.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "custom",
"name": "User defined field",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Transaction ID",
"description": "The PayPal transaction identifier.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference1",
"name": "First Payment Item Name",
"description": "Product name of the first item.",
"isDeprecated": true,
"deprecationReason": "Information not relevant."
},
{
"id": "memo",
"name": "Memo",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "subject",
"name": "Subject",
"description": "Subject of payment as passed through by the payer to the merchant.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "parentTransactionId",
"name": "Parent transaction ID",
"description": "ID of a related transaction (e.g. the ID of original payment for a refund).",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionStatus",
"name": "Transaction Status",
"description": "The PayPal transaction status.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionType",
"name": "Transaction Type",
"description": "The PayPal transaction type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "invoiceNumber",
"name": "PayPal Invoice-ID",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'invoiceId'."
},
{
"id": "bookingText",
"name": "PayPal transaction status",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionStatus'"
},
{
"id": "paymentType",
"name": "PayPal transaction type",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionType'"
},
{
"id": "payerName1",
"name": "Payer E-Mail",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'payerMail'"
},
{
"id": "payerName2",
"name": "Payer name",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'payerName'"
},
{
"id": "reference2",
"name": "Memo",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'memo'"
},
{
"id": "reference3",
"name": "Subject",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'subject'"
},
{
"id": "reference4",
"name": "Higher level transaction ID",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'parentTransactionId'"
},
{
"id": "orderNumber",
"name": "User defined field",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'custom'"
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| auth-reference | Zugriff auf PayPal-Konto genehmigen | Auth | |||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| custom | User defined field | |
| invoiceId | Invoice-ID | Invoice ID from the PayPal payment info. |
| memo | Memo | |
| parentTransactionId | Parent transaction ID | ID of a related transaction (e.g. the ID of original payment for a refund). |
| payerMail | Payer E-Mail | E-Mail address of the payer. |
| payerName | Payer name | Name/username of the payer. |
| subject | Subject | Subject of payment as passed through by the payer to the merchant. |
| transactionId | Transaction ID | The PayPal transaction identifier. |
| transactionStatus | Transaction Status | The PayPal transaction status. |
| transactionType | Transaction Type | The PayPal transaction type. |
| uniqueId | Unique Identifier | Unique identifier for the PayData transaction (PayPal Transaction ID). |
Deprecated fields
| ID | Name | Reason |
|---|---|---|
| bookingText | PayPal transaction status | Renamed to 'transactionStatus' |
| invoiceNumber | PayPal Invoice-ID | Renamed to 'invoiceId'. |
| orderNumber | User defined field | Renamed to 'custom' |
| payerName1 | Payer E-Mail | Renamed to 'payerMail' |
| payerName2 | Payer name | Renamed to 'payerName' |
| paymentType | PayPal transaction type | Renamed to 'transactionType' |
| reference1 | First Payment Item Name | Information not relevant. |
| reference2 | Memo | Renamed to 'memo' |
| reference3 | Subject | Renamed to 'subject' |
| reference4 | Higher level transaction ID | Renamed to 'parentTransactionId' |
Saferpay
Id: saferpay
JSON
{
"id": "saferpay",
"name": "Saferpay",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/saferpay.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/saferpay_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/saferpay.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/saferpay/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/saferpay/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/saferpay/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "email-address",
"name": "E-Mail-Adresse",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": true,
"readOnly": true,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| email-address | E-Mail-Adresse | Text | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Shop Apotheke
Id: shop_apotheke
JSON
{
"id": "shop_apotheke",
"name": "Shop Apotheke",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/shop_apotheke.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/shop_apotheke_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/shop_apotheke.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/shop_apotheke/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/shop_apotheke/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/shop_apotheke/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "api-key",
"name": "API-Schlüssel",
"shortDescription": null,
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "shop-id",
"name": "Shop-ID",
"shortDescription": "Optionale Shop-ID, wenn mehrere Shops im Einsatz sind.",
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "shop-name",
"name": "Shop-Name",
"shortDescription": "Wird automatisch gesetzt.",
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": true,
"defaultValue": "unbekannt",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8494357Z",
"values": [],
"minValue": "2000-01-21T13:04:55.4061060Z",
"maxValue": "2025-01-21T13:04:55.4061113Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "accountingDocumentNumber",
"name": "Accounting Document Number",
"description": "The billing cycle's accounting document number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderId",
"name": "Order ID",
"description": "Order ID of the transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentImprintNumber",
"name": "Payment Imprint Number",
"description": "The received payment imprint number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentType",
"name": "Payment Type",
"description": "The payment's type used by the customer to pay this order.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Transaction Id",
"description": "Identifier of the transaction from Shop Apotheke.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionType",
"name": "Transaction Type",
"description": "Type of transaction (refund, transaction fee, etc ...).",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| api-key | API-Schlüssel | Password | ✓ | ||
| shop-id | Shop-ID | Optionale Shop-ID, wenn mehrere Shops im Einsatz sind. | Text | ||
| shop-name | Shop-Name | Wird automatisch gesetzt. | Text | ✓ | |
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| accountingDocumentNumber | Accounting Document Number | The billing cycle's accounting document number. |
| orderId | Order ID | Order ID of the transaction. |
| paymentImprintNumber | Payment Imprint Number | The received payment imprint number. |
| paymentType | Payment Type | The payment's type used by the customer to pay this order. |
| transactionId | Transaction Id | Identifier of the transaction from Shop Apotheke. |
| transactionType | Transaction Type | Type of transaction (refund, transaction fee, etc ...). |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Shopify Payments
Id: shopify_custom_app
JSON
{
"id": "shopify_custom_app",
"name": "Shopify Payments",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/shopify.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/shopify_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/shopify.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/shopify_custom_app/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/shopify_custom_app/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/shopify_custom_app/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "shop-url",
"name": "Shop-URL",
"shortDescription": "Ihre Shop URL in der Form: meinshop.myshopify.com",
"description": null,
"required": true,
"requiredDuringAuth": true,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "access-token",
"name": "Admin-API-Zugriffstoken",
"shortDescription": "Access Token im Format 'shpat_1234567890abcdefghij1234567890ab'",
"description": "Der Admin-Zugriffstoken Ihrer benutzerdefinierten App",
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8746838Z",
"values": [],
"minValue": "2000-01-21T13:04:55.4612555Z",
"maxValue": "2025-01-21T13:04:55.4612603Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier for the PayData transaction (Shopify Transaction ID).",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerEMail",
"name": "Order E-Mail",
"description": "Customer e-mail address from the order.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerName",
"name": "Billing Address Name",
"description": "Company, first and last name from the billing address.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderName",
"name": "Order Name",
"description": "The unique identifier for the order that appears on the order page in the Shopify admin and the Order status page.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderNameClean",
"name": "Order Name (without prefix and suffix)",
"description": "The order name with pre and suffix removed.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Transaction ID",
"description": "Shopify Transaction identifier.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "sourceId",
"name": "Source ID",
"description": "The id of the Shopify resource leading to the transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderTransactionId",
"name": "Order Transaction ID",
"description": "The id of the Shopify Order Transaction that resulted in this transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "sourceType",
"name": "Source Type",
"description": "The type of the Shopify resource leading to the transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payoutId",
"name": "Payout ID",
"description": "The id of the Shopify payout the transaction was paid out in.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "authorizationCode",
"name": "Authorization Code",
"description": "The authorization code associated with the transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionType",
"name": "Transaction type",
"description": "The type of the Shopify transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payerName1",
"name": "E-Mail",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'customerEMail'"
},
{
"id": "payerName2",
"name": "Client",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'customerName'"
},
{
"id": "invoiceNumber",
"name": "Order number",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'orderName'"
},
{
"id": "orderNumber",
"name": "Order number (without prefix and suffix)",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'orderNameClean'"
},
{
"id": "reference1",
"name": "Source ID",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'sourceId'"
},
{
"id": "reference2",
"name": "Order transaction ID",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'orderTransactionId'"
},
{
"id": "reference3",
"name": "Source type",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'sourceType'"
},
{
"id": "reference4",
"name": "Payout ID",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'payoutId'"
},
{
"id": "bookingText",
"name": "Authorization Code",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'authorizationCode'"
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| shop-url | Shop-URL | Ihre Shop URL in der Form: meinshop.myshopify.com | Text | ✓ | |
| access-token | Admin-API-Zugriffstoken | Access Token im Format 'shpat_1234567890abcdefghij1234567890ab' | Password | ✓ | |
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| authorizationCode | Authorization Code | The authorization code associated with the transaction. |
| customerEMail | Order E-Mail | Customer e-mail address from the order. |
| customerName | Billing Address Name | Company, first and last name from the billing address. |
| orderName | Order Name | The unique identifier for the order that appears on the order page in the Shopify admin and the Order status page. |
| orderNameClean | Order Name (without prefix and suffix) | The order name with pre and suffix removed. |
| orderTransactionId | Order Transaction ID | The id of the Shopify Order Transaction that resulted in this transaction. |
| payoutId | Payout ID | The id of the Shopify payout the transaction was paid out in. |
| sourceId | Source ID | The id of the Shopify resource leading to the transaction. |
| sourceType | Source Type | The type of the Shopify resource leading to the transaction. |
| transactionId | Transaction ID | Shopify Transaction identifier. |
| transactionType | Transaction type | The type of the Shopify transaction. |
| uniqueId | Unique Identifier | Unique identifier for the PayData transaction (Shopify Transaction ID). |
Deprecated fields
| ID | Name | Reason |
|---|---|---|
| bookingText | Authorization Code | Renamed to 'authorizationCode' |
| invoiceNumber | Order number | Renamed to 'orderName' |
| orderNumber | Order number (without prefix and suffix) | Renamed to 'orderNameClean' |
| payerName1 | Renamed to 'customerEMail' | |
| payerName2 | Client | Renamed to 'customerName' |
| reference1 | Source ID | Renamed to 'sourceId' |
| reference2 | Order transaction ID | Renamed to 'orderTransactionId' |
| reference3 | Source type | Renamed to 'sourceType' |
| reference4 | Payout ID | Renamed to 'payoutId' |
smart2pay (CSV)
Id: s2p
JSON
{
"id": "s2p",
"name": "smart2pay (CSV)",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/smart2pay.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/smart2pay_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/smart2pay.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/s2p/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/s2p/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/s2p/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "email-address",
"name": "E-Mail-Adresse",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": true,
"readOnly": true,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| email-address | E-Mail-Adresse | Text | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Sofort
Id: sofort
JSON
{
"id": "sofort",
"name": "Sofort",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/sofort.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/sofort_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/sofort.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/sofort/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/sofort/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/sofort/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "email-address",
"name": "E-Mail-Adresse",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": true,
"readOnly": true,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| email-address | E-Mail-Adresse | Text | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Stripe
Id: stripe_api
JSON
{
"id": "stripe_api",
"name": "Stripe",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/stripe.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/stripe_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/stripe.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/stripe_api/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/stripe_api/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/stripe_api/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "api-key",
"name": "Token",
"shortDescription": "Beginnt mit rk_live oder sk_live.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "metadata-field",
"name": "Payment Metadata Feld",
"shortDescription": "Feld, in dem zusätzliche Informationen wie Bestellnummern enthalten sind.",
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8780758Z",
"values": [],
"minValue": "2000-01-21T13:04:55.4728621Z",
"maxValue": "2025-01-21T13:04:55.4728664Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier for the PayData transaction (Stripe transaction ID).",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerName",
"name": "Customer name",
"description": "Billing or charge customer name.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerMail",
"name": "Customer E-Mail",
"description": "Stripe Billing or Stripe charge customer mail.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "invoiceNumber",
"name": "Invoice number",
"description": "Stripe charge invoice number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "receiptNumber",
"name": "Receipt number",
"description": "Stripe transaction receipt number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Transaction ID",
"description": "Stripe transaction identifier.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerId",
"name": "Customer ID",
"description": "Stripe customer ID.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "description",
"name": "Description",
"description": "Stripe transaction description. An arbitrary string attached to the object. Often useful for displaying to users.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionStatus",
"name": "Transaction Status",
"description": "The status of the Stripe transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "statementDescriptor",
"name": "Statement descriptor",
"description": "Extra information about a payout that displays on the user's bank statement.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionType",
"name": "Type",
"description": "Stripe transaction type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payerName1",
"name": "Customer name",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'customerName'"
},
{
"id": "payerName2",
"name": "Customer E-Mail",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'customerMail'"
},
{
"id": "orderNumber",
"name": "Receipt number",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'receiptNumber'"
},
{
"id": "reference1",
"name": "Description",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'description'"
},
{
"id": "reference2",
"name": "Charge ID",
"description": null,
"isDeprecated": true,
"deprecationReason": "Split into 'chargeId', 'paymentIntentId' and 'payoutDescription'"
},
{
"id": "paymentIntentId",
"name": "Payment Intent Id",
"description": "The Stripe payment intent ID for charges.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "chargeId",
"name": "Charge ID",
"description": "The Stripe refund charge ID.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payoutDescription",
"name": "Payout Description",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference3",
"name": "Status",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionStatus'"
},
{
"id": "paymentType",
"name": "Type",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'transactionType'"
},
{
"id": "bookingText",
"name": "Statement descriptor",
"description": null,
"isDeprecated": true,
"deprecationReason": "Renamed to 'statementDescriptor'"
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| api-key | Token | Beginnt mit rk_live oder sk_live. | Password | ✓ | |
| metadata-field | Payment Metadata Feld | Feld, in dem zusätzliche Informationen wie Bestellnummern enthalten sind. | Text | ||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| chargeId | Charge ID | The Stripe refund charge ID. |
| customerId | Customer ID | Stripe customer ID. |
| customerMail | Customer E-Mail | Stripe Billing or Stripe charge customer mail. |
| customerName | Customer name | Billing or charge customer name. |
| description | Description | Stripe transaction description. An arbitrary string attached to the object. Often useful for displaying to users. |
| invoiceNumber | Invoice number | Stripe charge invoice number. |
| paymentIntentId | Payment Intent Id | The Stripe payment intent ID for charges. |
| payoutDescription | Payout Description | |
| receiptNumber | Receipt number | Stripe transaction receipt number. |
| statementDescriptor | Statement descriptor | Extra information about a payout that displays on the user's bank statement. |
| transactionId | Transaction ID | Stripe transaction identifier. |
| transactionStatus | Transaction Status | The status of the Stripe transaction. |
| transactionType | Type | Stripe transaction type. |
| uniqueId | Unique Identifier | Unique identifier for the PayData transaction (Stripe transaction ID). |
Deprecated fields
| ID | Name | Reason |
|---|---|---|
| bookingText | Statement descriptor | Renamed to 'statementDescriptor' |
| orderNumber | Receipt number | Renamed to 'receiptNumber' |
| payerName1 | Customer name | Renamed to 'customerName' |
| payerName2 | Customer E-Mail | Renamed to 'customerMail' |
| paymentType | Type | Renamed to 'transactionType' |
| reference1 | Description | Renamed to 'description' |
| reference2 | Charge ID | Split into 'chargeId', 'paymentIntentId' and 'payoutDescription' |
| reference3 | Status | Renamed to 'transactionStatus' |
Sumup API
Id: sumup
JSON
{
"id": "sumup",
"name": "Sumup API",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/sumup.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/sumup_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/sumup.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/sumup/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/sumup/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/sumup/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "auth-reference",
"name": "Zugriff genehmigen",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Auth",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8846288Z",
"values": [],
"minValue": "2000-01-21T13:04:55.4859728Z",
"maxValue": "2025-01-21T13:04:55.4859776Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "transactionCode",
"name": "Transaction Code",
"description": "SumUp transaction code of the payment or payout.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Transaction ID",
"description": "SumUp ID of the transaction or payout.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payoutReference",
"name": "Payout Reference",
"description": "SumUp reference number of the payout.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "cardType",
"name": "Card Type",
"description": "Card type of the payment (e.g. MAESTRO, MASTERCARD, ...).",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "type",
"name": "Type",
"description": "SumUp transaction type (e.g. PAYMENT, REFUND, CHARGE_BACK, PAYOUT).",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| auth-reference | Zugriff genehmigen | Auth | |||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| cardType | Card Type | Card type of the payment (e.g. MAESTRO, MASTERCARD, ...). |
| payoutReference | Payout Reference | SumUp reference number of the payout. |
| transactionCode | Transaction Code | SumUp transaction code of the payment or payout. |
| transactionId | Transaction ID | SumUp ID of the transaction or payout. |
| type | Type | SumUp transaction type (e.g. PAYMENT, REFUND, CHARGE_BACK, PAYOUT). |
voelkner
Id: voelkner
JSON
{
"id": "voelkner",
"name": "voelkner",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/voelkner.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/voelkner_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/voelkner.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/voelkner/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/voelkner/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/voelkner/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "api-key",
"name": "API-Schlüssel",
"shortDescription": null,
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "shop-id",
"name": "Shop-ID",
"shortDescription": "Optionale Shop-ID, wenn mehrere Shops im Einsatz sind.",
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "shop-name",
"name": "Shop-Name",
"shortDescription": "Wird automatisch gesetzt.",
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": true,
"defaultValue": "unbekannt",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8523369Z",
"values": [],
"minValue": "2000-01-21T13:04:55.4186842Z",
"maxValue": "2025-01-21T13:04:55.4186892Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "uniqueId",
"name": "Unique Identifier",
"description": "Unique identifier calculated by PayData.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "accountingDocumentNumber",
"name": "Accounting Document Number",
"description": "The billing cycle's accounting document number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderId",
"name": "Order ID",
"description": "Order ID of the transaction.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentImprintNumber",
"name": "Payment Imprint Number",
"description": "The received payment imprint number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentType",
"name": "Payment Type",
"description": "The payment's type used by the customer to pay this order.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Transaction Id",
"description": "Identifier of the transaction from voelkner.",
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionType",
"name": "Transaction Type",
"description": "Type of transaction (refund, transaction fee, etc ...).",
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| api-key | API-Schlüssel | Password | ✓ | ||
| shop-id | Shop-ID | Optionale Shop-ID, wenn mehrere Shops im Einsatz sind. | Text | ||
| shop-name | Shop-Name | Wird automatisch gesetzt. | Text | ✓ | |
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| accountingDocumentNumber | Accounting Document Number | The billing cycle's accounting document number. |
| orderId | Order ID | Order ID of the transaction. |
| paymentImprintNumber | Payment Imprint Number | The received payment imprint number. |
| paymentType | Payment Type | The payment's type used by the customer to pay this order. |
| transactionId | Transaction Id | Identifier of the transaction from voelkner. |
| transactionType | Transaction Type | Type of transaction (refund, transaction fee, etc ...). |
| uniqueId | Unique Identifier | Unique identifier calculated by PayData. |
Dummy
Id: dummy
JSON
{
"id": "dummy",
"name": "Dummy",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/dummy.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/dummy_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/dummy.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/dummy/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/dummy/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/dummy/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "generated-field",
"name": "Generated Field",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": true,
"defaultValue": "default",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "token",
"name": "Username",
"shortDescription": "Name of the user",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "token-secret",
"name": "Token secret",
"shortDescription": null,
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "max-transactions-per-day",
"name": "Maximum number of transactions per day",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "import-errors",
"name": "Errors when importing transactions",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Checkbox",
"generated": false,
"readOnly": false,
"defaultValue": "False",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8893066Z",
"values": [],
"minValue": "2024-01-21T13:04:55.4973287Z",
"maxValue": "2025-01-21T13:04:55.4973336Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "payerName1",
"name": "Dummy payer name",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payerName2",
"name": "Dummy payer email",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "invoiceNumber",
"name": "Dummy Invoice-ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderNumber",
"name": "User defined field",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Dummy transaction ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerId",
"name": "Dummy payer customer number",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference1",
"name": "Dummy payment position 1 name",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference2",
"name": "Memo",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference3",
"name": "Subject",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference4",
"name": "Higher level transaction ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "bookingText",
"name": "Dummy memo",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentType",
"name": "Dummy transaction type",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| generated-field | Generated Field | Text | ✓ | ||
| token | Username | Name of the user | Text | ✓ | |
| token-secret | Token secret | Password | ✓ | ||
| max-transactions-per-day | Maximum number of transactions per day | Text | |||
| import-errors | Errors when importing transactions | Checkbox | |||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| bookingText | Dummy memo | |
| customerId | Dummy payer customer number | |
| invoiceNumber | Dummy Invoice-ID | |
| orderNumber | User defined field | |
| payerName1 | Dummy payer name | |
| payerName2 | Dummy payer email | |
| paymentType | Dummy transaction type | |
| reference1 | Dummy payment position 1 name | |
| reference2 | Memo | |
| reference3 | Subject | |
| reference4 | Higher level transaction ID | |
| transactionId | Dummy transaction ID |
Dummy OAuth
Id: dummy-oauth
JSON
{
"id": "dummy-oauth",
"name": "Dummy OAuth",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/dummy-oauth.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/dummy-oauth_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/dummy-oauth.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/dummy-oauth/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/dummy-oauth/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/dummy-oauth/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "auth-reference",
"name": "Confirm access to your Dummy OAuth account",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Auth",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "token",
"name": "Username",
"shortDescription": "Name of the user",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "token-secret",
"name": "Token secret",
"shortDescription": null,
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "max-transactions-per-day",
"name": "Maximum number of transactions per day",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8920809Z",
"values": [],
"minValue": "2024-01-21T13:04:55.5092232Z",
"maxValue": "2025-01-21T13:04:55.5092285Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "payerName1",
"name": "Dummy payer name",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payerName2",
"name": "Dummy payer email",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "invoiceNumber",
"name": "Dummy Invoice-ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderNumber",
"name": "User defined field",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Dummy transaction ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerId",
"name": "Dummy payer customer number",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference1",
"name": "Dummy payment position 1 name",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference2",
"name": "Memo",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference3",
"name": "Subject",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference4",
"name": "Higher level transaction ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "bookingText",
"name": "Dummy memo",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentType",
"name": "Dummy transaction type",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| auth-reference | Confirm access to your Dummy OAuth account | Auth | |||
| token | Username | Name of the user | Text | ✓ | |
| token-secret | Token secret | Password | ✓ | ||
| max-transactions-per-day | Maximum number of transactions per day | Text | |||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| bookingText | Dummy memo | |
| customerId | Dummy payer customer number | |
| invoiceNumber | Dummy Invoice-ID | |
| orderNumber | User defined field | |
| payerName1 | Dummy payer name | |
| payerName2 | Dummy payer email | |
| paymentType | Dummy transaction type | |
| reference1 | Dummy payment position 1 name | |
| reference2 | Memo | |
| reference3 | Subject | |
| reference4 | Higher level transaction ID | |
| transactionId | Dummy transaction ID |
Dummy Shop
Id: dummy-shop
JSON
{
"id": "dummy-shop",
"name": "Dummy Shop",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/dummy-shop.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/dummy-shop_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/dummy-shop.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/dummy-shop/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/dummy-shop/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/dummy-shop/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "generated-field",
"name": "Generated Field",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": true,
"defaultValue": "default",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "token",
"name": "Username",
"shortDescription": "Name of the user",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "token-secret",
"name": "Token secret",
"shortDescription": null,
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "max-transactions-per-day",
"name": "Maximum number of transactions per day",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "shop-url",
"name": "Shop URL",
"shortDescription": "Your shop URL in the form: shopname.myshop.de",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "import-errors",
"name": "Errors when importing transactions",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Checkbox",
"generated": false,
"readOnly": false,
"defaultValue": "False",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8947735Z",
"values": [],
"minValue": "2024-01-21T13:04:55.5202933Z",
"maxValue": "2025-01-21T13:04:55.5202983Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "payerName1",
"name": "Dummy payer name",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payerName2",
"name": "Dummy payer email",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "invoiceNumber",
"name": "Dummy Invoice-ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderNumber",
"name": "User defined field",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Dummy transaction ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "customerId",
"name": "Dummy payer customer number",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference1",
"name": "Dummy payment position 1 name",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference2",
"name": "Memo",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference3",
"name": "Subject",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference4",
"name": "Higher level transaction ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "bookingText",
"name": "Dummy memo",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentType",
"name": "Dummy transaction type",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| generated-field | Generated Field | Text | ✓ | ||
| token | Username | Name of the user | Text | ✓ | |
| token-secret | Token secret | Password | ✓ | ||
| max-transactions-per-day | Maximum number of transactions per day | Text | |||
| shop-url | Shop URL | Your shop URL in the form: shopname.myshop.de | Text | ✓ | |
| import-errors | Errors when importing transactions | Checkbox | |||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| bookingText | Dummy memo | |
| customerId | Dummy payer customer number | |
| invoiceNumber | Dummy Invoice-ID | |
| orderNumber | User defined field | |
| payerName1 | Dummy payer name | |
| payerName2 | Dummy payer email | |
| paymentType | Dummy transaction type | |
| reference1 | Dummy payment position 1 name | |
| reference2 | Memo | |
| reference3 | Subject | |
| reference4 | Higher level transaction ID | |
| transactionId | Dummy transaction ID |
Dummy with Reports
Id: dummy-reports
JSON
{
"id": "dummy-reports",
"name": "Dummy with Reports",
"logos": {
"Standard": "https://paydatapublic.blob.core.windows.net/images/accounts/dummy-reports.png",
"Gray": "https://paydatapublic.blob.core.windows.net/images/accounts/dummy-reports_gray.png",
"Svg": "https://paydatapublic.blob.core.windows.net/images/accounts/dummy-reports.svg"
},
"helpUrls": {
"Setup": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/dummy-reports/setup.php",
"Accounting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/dummy-reports/accounting.php",
"Troubleshooting": "https://paydata-api.com/user-help/default-825rwd3452haqz0js56/dummy-reports/troubleshooting.php"
},
"deprecated": false,
"connectionTestSupported": false,
"accountFields": [
{
"id": "generated-field",
"name": "Generated Field",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": true,
"defaultValue": "default",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "token",
"name": "Username",
"shortDescription": "Name of the user",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "token-secret",
"name": "Token secret",
"shortDescription": null,
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Password",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "max-transactions-per-day",
"name": "Maximum number of transactions per day",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Text",
"generated": false,
"readOnly": false,
"defaultValue": null,
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "import-errors",
"name": "Errors when importing transactions",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Checkbox",
"generated": false,
"readOnly": false,
"defaultValue": "False",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "reports-list-errors",
"name": "Errors when listing reports",
"shortDescription": null,
"description": null,
"required": false,
"requiredDuringAuth": false,
"type": "Checkbox",
"generated": false,
"readOnly": false,
"defaultValue": "False",
"values": [],
"minValue": null,
"maxValue": null,
"requiredFields": []
},
{
"id": "start-date",
"name": "Startdatum für Abruf",
"shortDescription": "Ruft nur Zahlungen ab dem gewählten Datum ab.",
"description": null,
"required": true,
"requiredDuringAuth": false,
"type": "Date",
"generated": false,
"readOnly": false,
"defaultValue": "2024-12-21T13:04:54.8972825Z",
"values": [],
"minValue": "2024-01-21T13:04:55.5319092Z",
"maxValue": "2025-01-21T13:04:55.5319138Z",
"requiredFields": []
}
],
"transactionFields": [
{
"id": "payerName1",
"name": "Dummy payer email",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "payerName2",
"name": "Dummy payer name",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "invoiceNumber",
"name": "Dummy Invoice-ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "orderNumber",
"name": "User defined field",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "transactionId",
"name": "Dummy transaction ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference1",
"name": "Dummy payment position 1 name",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference2",
"name": "Memo",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference3",
"name": "Subject",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "reference4",
"name": "Higher level transaction ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "bookingText",
"name": "Dummy memo",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"id": "paymentType",
"name": "Dummy transaction type",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
]
}
Account fields
| ID | Name | Description | Type | Required | R/O |
|---|---|---|---|---|---|
| generated-field | Generated Field | Text | ✓ | ||
| token | Username | Name of the user | Text | ✓ | |
| token-secret | Token secret | Password | ✓ | ||
| max-transactions-per-day | Maximum number of transactions per day | Text | |||
| import-errors | Errors when importing transactions | Checkbox | |||
| reports-list-errors | Errors when listing reports | Checkbox | |||
| start-date | Startdatum für Abruf | Ruft nur Zahlungen ab dem gewählten Datum ab. | Date | ✓ |
Transaction Fields
| ID | Name | Description |
|---|---|---|
| bookingText | Dummy memo | |
| invoiceNumber | Dummy Invoice-ID | |
| orderNumber | User defined field | |
| payerName1 | Dummy payer email | |
| payerName2 | Dummy payer name | |
| paymentType | Dummy transaction type | |
| reference1 | Dummy payment position 1 name | |
| reference2 | Memo | |
| reference3 | Subject | |
| reference4 | Higher level transaction ID | |
| transactionId | Dummy transaction ID |