The requests that you submit here will be handled in our sandbox.
The response is encoded in JSON. Upon successful completion of a request, the "status" field is set to "ok" while the "data" field contains the actual payload:
{ "status": "ok", "data": {...} }
This wrapping will be applied to all responses. The response classes that are defined in this documentation at each end point, therefore only show the inner, data carrying part.
Authorization
Your backend needs to authenticate itself to use our APIs. You can create the credentials in the gateway manager (see here):
- apiIdentifier
- This identifies your system on our platform and is tied to a set of permissions you are allowed to perform on our API. They usually include boarding of merchants, managing hardware, registering transactions and querying transaction.
- apiSecretKey
- This ensures that its really you who is using the apiIdentifier.
API Endpoints
-
-
-
Implementation Notes
Remove the association of a reader to a merchant and application. The reader will, however, remain in the system. The association of terminal ID and reader is removed. The terminal ID stays with the processing path of the merchant. The reader can be reassigned to any merchant or application at a later point.
Response
Parameter Data Type $.data$.data.created$.data.created.date$.data.created.date.dayshort$.data.created.date.monthshort$.data.created.date.yearint$.data.created.time$.data.created.time.hour$.data.created.time.minutebyte$.data.created.time.nanoint$.data.created.time.secondbyte$.data.details$.data.details.assignedConfigurationProfileThe name of the profile, if any, being used by this reader (it can be defined at reader or application level).Using a profile you can define a custom configuration for a reader; this includes specific firmware, software and / or configurations such as the reader's logo or EMV configuration.string(Example: MIURA_CONTACTLESS)$.data.details.hardwareRevisionThe hardware revision as printed on the back of the reader.string(Example: M006-TEST02-V2-0)$.data.details.preInjectedKeys[]Set of pre injected keys{ PIN }$.data.details.serialNoThe serial number as printed on the back of the reader. Dashes are stripped from the serial number.string(Example: 006-123456)$.data.details.terminalIdsThe terminal IDs that have been assigned to the reader. Terminal IDs are used by the clearing institute to identify readers.Map$.data.statusCurrent status of the reader{ INACTIVE | ACTIVE | DEACTIVATED }$.statusIf the request was processed as planned,ok
is returned. If the field is set toerror
, $.error will be present and will contain more information.{ ok | error }(Example: ok)Error Status Codes
HTTP Status Code Error Number Reason 400 5193 The specified Application-Reader Combination was invalid. 400 5144 The reader identifier was not in the correct format. 401 5003 The specified credentials are wrong. 401 5001 Authentication is required to access this resource. 403 5002 The provided credentials are not sufficient to access the resource. 404 5205 Application with given id not found. 404 5211 Reader not found.
-
-
-
-
-
Implementation Notes
Retrieves the details of an Event that has occurred in the system. This can be used to get further information, e.g. when having received a callback from a webhook.
Response
Parameter Data Type $.data$.data.createdThe date and time in UTC when the event was created.Date(Example: 2014-03-12 10:40:41)$.data.identifierUnique identifier of the event.UUID(Example: 12345678-abcd-1234-abcd-1234567890ab)$.data.transactionThe transaction associated with the event.$.data.transaction.alternativePaymentMethodDetailsInformation about the Alternative Payment Method used for the transactionOptional$.data.transaction.amountThe amount of the transaction.BigDecimal(Example: 15.30)$.data.transaction.avsDetailsInformation about the Address Verification System.Optional$.data.transaction.capturedIndicates whether the transaction was captured successfully.Boolean$.data.transaction.cardDetails$.data.transaction.cardDetails.cardholderNameThe cardholder name as found on the card. The format depends on the card scheme an issuing bank, e.g. "LastName\Firstname", "Firstname Lastname", "Mr. Lastname". Sometimes it is even empty or contains other data.string$.data.transaction.cardDetails.countryCodeNumberIssuer country code represented as a 3-digit ISO 3166-1 numeral.string$.data.transaction.cardDetails.expiryMonthCard expiry month.Integer$.data.transaction.cardDetails.expiryYearCard expiry year.Integer$.data.transaction.cardDetails.fingerprintHash that uniquely identifies the card used in the transaction.string$.data.transaction.cardDetails.maskedCardNumberMasked card account number.string$.data.transaction.cardDetails.schemeCard scheme.string$.data.transaction.clearingDetailsDetailed information about the clearing institute.$.data.transaction.clearingDetails.authorizationCodeThe authorization code for a successful transaction. Depending on the clearing institute used, this can be a concatenation of the clearing institute and issuer authorization codestring(Example: 123456/123456)$.data.transaction.clearingDetails.completedThe date the transaction was completed in the clearing institutes systemDate(Example: 2014-03-12 10:40:41)$.data.transaction.clearingDetails.instituteClearing institute name.string(Example: SIXCARD)$.data.transaction.clearingDetails.merchantIdThe merchant ID of the merchant performing the transaction as assigned by the clearing institutestring(Example: 123456789012345)$.data.transaction.clearingDetails.originalTransactionIdentifierIn case of refund transactions, this contains the transaction identifier as assigned by the clearing institute of the origin CHARGE transactionstring(Example: 055954)$.data.transaction.clearingDetails.statusTextA status text concerning the transaction. This can e.g. include information for voice referrals. A voice referral requires the merchant to dial a number to confirm the transactionstring$.data.transaction.clearingDetails.terminalIdThe terminal ID of the merchant performing the transactionstring(Example: 12345678)$.data.transaction.clearingDetails.transactionIdentifierThe transaction identifier as assigned by the clearing institutestring(Example: 055953)$.data.transaction.createdThe date and time in UTC when the transaction was created.LocalDateTime(Example: 2014-03-12 10:40:41)$.data.transaction.createdTimeZonedOptional$.data.transaction.currencyCurrency of the transaction.{ AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHF | CLP | CNY | COP | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GGP | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | IMP | INR | IQD | IRR | ISK | JEP | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SOS | SRD | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TVD | TWD | TZS | UAH | UGX | USD | UYU | UZS | VEF | VND | VUV | WST | XAF | XCD | XDR | XOF | XPF | YER | ZAR | ZMW | ZWD }$.data.transaction.customIdentifierCustom identifier of the transaction.string(Example: My identifier)$.data.transaction.dccDetailsInformation about Dynamic Currency Conversion.Optional$.data.transaction.detailsAdditional information about the transaction.$.data.transaction.details.applicationFeeApplication fee for stripe transactions.BigDecimal$.data.transaction.details.includedTipAmountTip included in the transaction. Only available if tip was given.BigDecimal$.data.transaction.details.metadataMetadata for stripe transactions.Map$.data.transaction.details.tipAdjustStatusTip adjust status. Only available if tip was given.{ ADJUSTABLE | NOT_ADJUSTABLE | ADJUSTED }$.data.transaction.giftCardDetailsInformation about the gift card in case it is an activation responseOptional$.data.transaction.groupIdentifierUnique identifier of the transaction group which contains the transaction. Transaction groups are used to group transactions that belong together e.g. a debit and a refund.string(Example: 12345678abcd1234abcd1234567890ab)$.data.transaction.identifierUnique identifier of the transaction.string(Example: 12345678abcd1234abcd1234567890ab)$.data.transaction.internalTypeOverride{ CHARGE | REFUND | CREDIT | PREAUTHORIZE | VERIFICATION | ACTIVATION | BALANCE_INQUIRY | CASHOUT }$.data.transaction.locationDetailsDetailed information about the location where the transaction was performed (if available).$.data.transaction.locationDetails.horizontalAccuracyThe accuracy of the location details in meters.string(Example: 10)$.data.transaction.locationDetails.latitudeThe latitude of the location where the transaction was performed in degrees.string(Example: 48.133924)$.data.transaction.locationDetails.longitudeThe longitude of the location where the transaction was performed in degrees.string(Example: 11.54934)$.data.transaction.merchant$.data.transaction.merchant.identifierIdentifier of the merchant performed the transaction.UUID$.data.transaction.merchant.nameName of the merchant performed the transaction.string$.data.transaction.modeMode of the transaction.{ TEST | TEST_CONNECTOR | LIVE }$.data.transaction.offlineDetails$.data.transaction.offlineDetails.valueObject$.data.transaction.paymentDetailsDetailed information about the payment of the transaction.$.data.transaction.paymentDetails.customerVerification$.data.transaction.paymentDetails.customerVerification.typeType of customer verification.{ UNKNOWN | CARD_SECURITY_CODE | PIN | PIN_AND_SIGNATURE | SHOPPER_DEVICE | NONE | SIGNATURE | PIN_OFFLINE_PLAINTEXT | PIN_OFFLINE_PLAINTEXT_AND_SIGNATURE | PIN_OFFLINE_ENCIPHERED | PIN_OFFLINE_ENCIPHERED_AND_SIGNATURE | PIN_ONLINE | CUSTOMER_DEVICE }$.data.transaction.paymentDetails.maskedAccountMasked account number.string(Example: 420000XXXXXX5052)$.data.transaction.paymentDetails.maskedTrack2Masked track 2 data.string(Example: 420000XXXXXX5052=15122011143857589)$.data.transaction.paymentDetails.schemeThe scheme used in this transaction.{ VISA | VISA_ELECTRON | VISA_INTERLINK | VISA_COMMON_DEBIT | V_PAY | MASTERCARD | MAESTRO | MASTERCARD_COMMON_DEBIT | JCB | DINERS | DISCOVER | DISCOVER_COMMON_DEBIT | GIROCARD | ELV | AMERICAN_EXPRESS | UNION_PAY | UNION_PAY_COMMON_DEBIT | GH_LINK | CARTES_BANCAIRES | ALIPAY | WECHAT_PAY | CYBERSOURCE_TOKEN | VALUE_LINK }$.data.transaction.paymentDetails.sourceThe source where the payment details have been collected.{ ICC | MAGSTRIPE | MAGSTRIPE_AS_FALLBACK | MANUAL | MANUAL_AS_FALLBACK | NFC_ICC | NFC_MAGSTRIPE | QR_CODE | BARCODE | SOUNDWAVE }$.data.transaction.previousTransactionTransactionResponseV2$.data.transaction.processingDetailsDetailed information about the processing of the transaction. Relevant for debugging use.$.data.transaction.processingDetails.identifierUnique ID of the transaction processor. This information is for debugging purposes.string(Example: h987i654j321k098l765m432n210o987)$.data.transaction.processingDetails.sessionCreatedThe date and time in UTC when the transaction processor session was created. This information is for debugging purposes.LocalDateTime(Example: 2014-03-12 10:40:41)$.data.transaction.processingDetails.sessionIdentifierThe session ID of the transaction processor. This information is for debugging purposes.string$.data.transaction.processingDetails.statusProcessing status code, for example 000.000.000 for transaction succeeded. This information is for debugging purposes.string(Example: 000.000.000)$.data.transaction.processingDetails.timestampThe date and time in UTC when the transaction processor processed the transaction. This information is for debugging purposes.LocalDateTime(Example: 2014-03-12 10:40:41)$.data.transaction.processingModeProcessing mode of the transaction.{ POS_OFFLINE | POS_ONLINE | ECOMMERCE }$.data.transaction.profileUserDetails$.data.transaction.profileUserDetails.firstNamestring(Example: John)$.data.transaction.profileUserDetails.lastNamestring(Example: Doe)$.data.transaction.profileUserDetails.usernameThe username and email of the user.string(Example: john.doe@example.com)$.data.transaction.readerThe reader used for performing the transaction.$.data.transaction.reader.created$.data.transaction.reader.created.date$.data.transaction.reader.created.date.dayshort$.data.transaction.reader.created.date.monthshort$.data.transaction.reader.created.date.yearint$.data.transaction.reader.created.time$.data.transaction.reader.created.time.hour$.data.transaction.reader.created.time.minutebyte$.data.transaction.reader.created.time.nanoint$.data.transaction.reader.created.time.secondbyte$.data.transaction.reader.details$.data.transaction.reader.details.assignedConfigurationProfileThe name of the profile, if any, being used by this reader (it can be defined at reader or application level).Using a profile you can define a custom configuration for a reader; this includes specific firmware, software and / or configurations such as the reader's logo or EMV configuration.string(Example: MIURA_CONTACTLESS)$.data.transaction.reader.details.hardwareRevisionThe hardware revision as printed on the back of the reader.string(Example: M006-TEST02-V2-0)$.data.transaction.reader.details.preInjectedKeys[]Set of pre injected keys{ PIN }$.data.transaction.reader.details.serialNoThe serial number as printed on the back of the reader. Dashes are stripped from the serial number.string(Example: 006-123456)$.data.transaction.reader.details.terminalIdsThe terminal IDs that have been assigned to the reader. Terminal IDs are used by the clearing institute to identify readers.Map$.data.transaction.reader.statusCurrent status of the reader{ INACTIVE | ACTIVE | DEACTIVATED }$.data.transaction.receiptDetailsTransaction details that are needed for printing receipts.$.data.transaction.receiptDetails.authorizationCodeThe authorization code for a successful transaction.string(Example: 3030)$.data.transaction.receiptDetails.emvEMV details of the transaction.$.data.transaction.receiptDetails.emv.applicationIDThe application ID of the EMV application used for this transaction.string(Example: A0000000031010)$.data.transaction.receiptDetails.emv.applicationLabelA human readable description of the EMV application used for this transaction.string(Example: VISA)$.data.transaction.receiptDetails.emv.terminalVerificationResultThe terminal verification result. This describes the cardholder verification method and other checks done by the terminal.string(Example: 0000008000)$.data.transaction.receiptDetails.emv.transactionStatusInformationThe transaction status information indicates the functions performed in a transaction.string(Example: E800)$.data.transaction.referencedTransactionIdentifierIdentifier of the referenced transaction i.e. for refund it contains identifier of initial debit transaction.string(Example: 12345678abcd1234abcd1234567890ab)$.data.transaction.refundDetailsDetailed information about how the transaction can be undone. This process is called a refund in the system. How a transaction can be undone depends on the clearing institute and time the transaction should be undone. Even for POS transactions, certain conditions exist where no card needs to present for a refund. Check the rules of the clearing institute used. This field is omitted if no refund rules have been set for the clearing institute. Refund transactions themselves are non refundable.$.data.transaction.refundDetails.process[]Processes required to perform a refund. Depending on the clearing institute and time this can be done without the original card being present for POS transactions.{ ANY_CARD | WITHOUT_CARD | SAME_CARD }$.data.transaction.refundDetails.refundTransactions[]Successfully refunded transactions. It will only be populated for CHARGE and PREAUTHORIZE transaction typesArray[RefundTransactionResponseV2]$.data.transaction.refundDetails.refundableAmountThe amount which can be refunded.BigDecimal(Example: 15.30)$.data.transaction.refundDetails.statusType of refund allowed for the transaction. It is NON_REFUNDABLE for the INITIALIZED, PENDING, DECLINED, ABORTED and ERROR transactions. For SIX it is also NON_REFUNDABLE when either a) the transaction is not the last processed transaction for the reader that was used for processing or b) was performed before the cutoff time at midnight Zurich time.{ NON_REFUNDABLE | REFUNDABLE_PARTIAL_AND_FULL | REFUNDABLE_FULL_ONLY | REFUNDED }$.data.transaction.sdkDetails$.data.transaction.sdkDetails.clientIdThe client ID generated by the OS for the installation.string(Example: E522Z0EC-91B1-4A11-93D5-F3732F0A80C7)$.data.transaction.sdkDetails.deviceOsThe device's Operating System.string(Example: iPhone OS)$.data.transaction.sdkDetails.osVersionThe device's Operating System version.string(Example: 9.3.2)$.data.transaction.sdkDetails.sdkVersionThe SDK version.string(Example: payworks.mpos.ios/2.4.6)$.data.transaction.shopperDetails$.data.transaction.shopperDetails.emailShopper email address. It will be automatically updated every time the shopper uses the receipt API.string$.data.transaction.shopperDetails.identifierShopper identifier that can be used to gather data related to it, like the cards used by it or the transactions performed.string$.data.transaction.statementDescriptorStatement descriptor of the transaction.string$.data.transaction.statusStatus of the transaction.{ INITIALIZED | PENDING | APPROVED | DECLINED | ABORTED | ERROR }$.data.transaction.statusDetailsDetailed status of the transaction.$.data.transaction.statusDetails.codeA code representing the status of the transaction.string(Example: ABORTED_MERCHANT_ABORTED)$.data.transaction.statusDetails.descriptionA description of the detailed status of a transaction.string$.data.transaction.statusDetails.developerDescriptionA description of the detailed status of a transaction intended for developers to give more debugging information.string$.data.transaction.subjectTransaction subject.string$.data.transaction.typeType of the transaction.{ CHARGE | REFUND | CREDIT | PREAUTHORIZE | VERIFICATION | ACTIVATION | BALANCE_INQUIRY | CASHOUT }$.data.transaction.typeDetailsType details of the transaction.$.data.transaction.typeDetails.code{ REFUND_BEFORE_CLEARING | REFUND_AFTER_CLEARING | PARTIAL_CAPTURE }$.data.transaction.verificationResultsResults of verifications (e.g. cvv, address).Map$.data.transaction.workflowWorkflow (e.g. POS, MOTO, ALTERNATIVE_PAYMENT_METHOD)Optional$.data.typeType of the event.string(Example: transaction.succeeded)$.statusIf the request was processed as planned,ok
is returned. If the field is set toerror
, $.error will be present and will contain more information.{ ok | error }(Example: ok)Error Status Codes
HTTP Status Code Error Number Reason 400 5129 Bad request. The id was not in the correct format. 401 5003 The specified credentials are wrong. 401 5001 Authentication is required to access this resource. 403 5002 The provided credentials are not sufficient to access the resource. 404 5200 Entity with given id not found.
-
-
-
-
-
Implementation Notes
Add a new Merchant to the System. This creates a merchant in the system with the entities such as a processing path and reader attached to it. The processing path defines where the payment is routed. It includes parameters needed for the clearing institute, such as terminal IDs and merchant IDs. These parameters differ for each clearing institute. A reader is required for making transactions and should be attached to a merchant. Attaching a reader can be done at a later point by omitting the readers parameter in the request. A reader can be assigned to the merchant by either specifying the corresponding identifier or the serial number and model. Only readers which are not assigned to other merchants can be used when creating the merchant.
Response
Parameter Data Type $.data$.data.detailsInformation about the merchant which is used to produce receipts$.data.details.additionalInformationstring(Example: VAT Identification Number)$.data.details.addressstring(Example: Shopping Street 42)$.data.details.citystring(Example: Munich)$.data.details.contactstring(Example: flower@shop.com)$.data.details.countrystring(Example: DE)$.data.details.publicNamestring(Example: Flower shop Inc)$.data.details.zipstring(Example: 80000)$.data.features[]{ FEATURE_EMPLOYEE_LOGIN | FEATURE_STANDALONE_REFUNDS | FEATURE_SECURITY_REPLAY_PROTECTION | FEATURE_SECURITY_HMAC_VERIFY | FEATURE_REPEATED_CHECKOUTS | FEATURE_RETRY_AFTER_DECLINE | FEATURE_PIN_ENTRY_BYPASS | FEATURE_TOKENIZATION | FEATURE_PARTIAL_AUTH }$.data.identifierUnique identifier of the merchant.UUID(Example: 12345678-abcd-1234-abcd-1234567890ab)$.data.nameThe name of the merchant.string(Example: Flower shop Inc)$.data.processingPaths[]$.data.processingPaths[].activeWhether or not the processing path is active.boolean$.data.processingPaths[].configuration$.data.processingPaths[].configuration.allowSkippingStreetNoBoolean$.data.processingPaths[].configuration.allowSkippingZipCodeBoolean$.data.processingPaths[].configuration.autoApproval{ ON_MATCH | ON_MATCH_OR_MAX_1_NOT_CHECKED | ON_MATCH_OR_MAX_2_NOT_CHECKED | ON_MATCH_OR_NOT_CHECKED }$.data.processingPaths[].configuration.autoDeclineCvv{ ON_MISMATCH_OR_NOT_CHECKED | ON_MISMATCH }$.data.processingPaths[].configuration.autoDeclineStreetNumber{ ON_MISMATCH_OR_NOT_CHECKED | ON_MISMATCH }$.data.processingPaths[].configuration.autoDeclineZipCheck{ ON_MISMATCH_OR_NOT_CHECKED | ON_MISMATCH }$.data.processingPaths[].configuration.treatAmexStreetNumberCheckAsPassedBoolean$.data.processingPaths[].currencies[]The currencies the merchant is able to accept.{ AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHF | CLP | CNY | COP | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GGP | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | IMP | INR | IQD | IRR | ISK | JEP | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SOS | SRD | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TVD | TWD | TZS | UAH | UGX | USD | UYU | UZS | VEF | VND | VUV | WST | XAF | XCD | XDR | XOF | XPF | YER | ZAR | ZMW | ZWD }$.data.processingPaths[].dccProvider$.data.processingPaths[].dccProvider.value$.data.processingPaths[].detailsMap$.data.processingPaths[].emvConfigurations[]$.data.processingPaths[].emvConfigurations[].applications[]$.data.processingPaths[].emvConfigurations[].applications[].aidstring$.data.processingPaths[].emvConfigurations[].applications[].contactEmvInterfaceConfigurationDto$.data.processingPaths[].emvConfigurations[].applications[].contactless[]$.data.processingPaths[].emvConfigurations[].applications[].contactless[].additionalApplicationVersions[]Array[String]$.data.processingPaths[].emvConfigurations[].applications[].contactless[].applicationVersionstring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].autoSelectionboolean$.data.processingPaths[].emvConfigurations[].applications[].contactless[].kernelIdstring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].priorityInteger$.data.processingPaths[].emvConfigurations[].applications[].contactless[].refundTransactionTypeEmvConfigurationDto$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.cardholderVerificationMethods[]{ SIGNATURE | PIN_ONLINE | PIN_OFFLINE | NO_CVM | CUSTOMER_DEVICE }$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[]$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].noCvmRequiredLimitBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].programIdstring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].statusCheckboolean$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].transactionLimitBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].zeroAmountAllowedboolean$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.noCvmRequiredLimitBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.statusCheckBoolean$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.defaultValuestring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.denialstring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.onlinestring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.transactionLimitBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.transactionLimitCustomerDeviceCvmBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.zeroAmountAllowedBoolean$.data.processingPaths[].emvConfigurations[].applications[].dataObjectLists$.data.processingPaths[].emvConfigurations[].applications[].dataObjectLists.dynamicDataAuthentication[]Array[String]$.data.processingPaths[].emvConfigurations[].applications[].dataObjectLists.processingOptionsData[]Array[String]$.data.processingPaths[].emvConfigurations[].applications[].dataObjectLists.transactionCertificate[]Array[String]$.data.processingPaths[].emvConfigurations[].capkeys[]$.data.processingPaths[].emvConfigurations[].capkeys[].expiryDateLocalDate$.data.processingPaths[].emvConfigurations[].capkeys[].exponentstring$.data.processingPaths[].emvConfigurations[].capkeys[].indexstring$.data.processingPaths[].emvConfigurations[].capkeys[].modulusLengthstring$.data.processingPaths[].emvConfigurations[].capkeys[].startDateLocalDate$.data.processingPaths[].emvConfigurations[].capkeys[].valuestring$.data.processingPaths[].emvConfigurations[].ridstring$.data.processingPaths[].identifierUnique identifier of the processing path.UUID(Example: 12345678-abcd-1234-abcd-1234567890ab)$.data.processingPaths[].modeMode of processing path.{ TEST | TEST_CONNECTOR | LIVE }$.data.processingPaths[].nameThe name of the processing path.string(Example: Default processing)$.data.processingPaths[].processingDetails$.data.processingPaths[].processingDetails.identifierUnique ID of the transaction processor. This information is for debugging purposes.string(Example: h987i654j321k098l765m432n210o987)$.data.processingPaths[].processingDetails.sessionCreatedThe date and time in UTC when the transaction processor session was created. This information is for debugging purposes.LocalDateTime(Example: 2014-03-12 10:40:41)$.data.processingPaths[].processingDetails.sessionIdentifierThe session ID of the transaction processor. This information is for debugging purposes.string$.data.processingPaths[].processingDetails.statusProcessing status code, for example 000.000.000 for transaction succeeded. This information is for debugging purposes.string(Example: 000.000.000)$.data.processingPaths[].processingDetails.timestampThe date and time in UTC when the transaction processor processed the transaction. This information is for debugging purposes.LocalDateTime(Example: 2014-03-12 10:40:41)$.data.processingPaths[].schemes[]The payment schemes the merchant is able to accept.{ VISA | MAESTRO | AMEX | VISAELECTRON | CHINAUNIONPAY | MASTER | DINERS | JCB | GIROCARD | ELV | V_PAY | DISCOVER | VISA_COMMON_DEBIT | MASTER_COMMON_DEBIT | DISCOVER_COMMON_DEBIT | UNION_PAY_COMMON_DEBIT | VISA_INTERLINK | GH_LINK | CARTES_BANCAIRES | ALIPAY | WECHAT_PAY | CYBERSOURCE_TOKEN | VALUE_LINK }$.data.readers[]$.data.readers[].created$.data.readers[].created.date$.data.readers[].created.date.dayshort$.data.readers[].created.date.monthshort$.data.readers[].created.date.yearint$.data.readers[].created.time$.data.readers[].created.time.hourbyte$.data.readers[].created.time.minutebyte$.data.readers[].created.time.nanoint$.data.readers[].created.time.secondbyte$.data.readers[].details$.data.readers[].details.assignedConfigurationProfileThe name of the profile, if any, being used by this reader (it can be defined at reader or application level).Using a profile you can define a custom configuration for a reader; this includes specific firmware, software and / or configurations such as the reader's logo or EMV configuration.string(Example: MIURA_CONTACTLESS)$.data.readers[].details.hardwareRevisionThe hardware revision as printed on the back of the reader.string(Example: M006-TEST02-V2-0)$.data.readers[].details.preInjectedKeys[]Set of pre injected keys{ PIN }$.data.readers[].details.serialNoThe serial number as printed on the back of the reader. Dashes are stripped from the serial number.string(Example: 006-123456)$.data.readers[].details.terminalIdsThe terminal IDs that have been assigned to the reader. Terminal IDs are used by the clearing institute to identify readers.Map$.data.readers[].statusCurrent status of the reader{ INACTIVE | ACTIVE | DEACTIVATED }$.statusIf the request was processed as planned,ok
is returned. If the field is set toerror
, $.error will be present and will contain more information.{ ok | error }(Example: ok)Error Status Codes
HTTP Status Code Error Number Reason 400 5148 Not enough terminal IDs specified to create readers. Check that you have at least one terminal id per reader. This may also happen if the reader is not assigned to the merchant. 400 5147 Reader with the serial number is already in use and not deactivated. Cannot use same reader for different merchants. 400 5100 Bad request, some parameters where misformed or missing. Check that all parameters have been set correctly. 401 5003 The specified credentials are wrong. 401 5001 Authentication is required to access this resource. 403 5002 The provided credentials are not sufficient to access the resource. 404 5206 Merchant with given id not found.
-
-
-
Implementation Notes
Returns the information available about a merchant. This includes attached readers and processing paths used for performing transactions.
Response
Parameter Data Type $.data$.data.detailsInformation about the merchant which is used to produce receipts$.data.details.additionalInformationstring(Example: VAT Identification Number)$.data.details.addressstring(Example: Shopping Street 42)$.data.details.citystring(Example: Munich)$.data.details.contactstring(Example: flower@shop.com)$.data.details.countrystring(Example: DE)$.data.details.publicNamestring(Example: Flower shop Inc)$.data.details.zipstring(Example: 80000)$.data.features[]{ FEATURE_EMPLOYEE_LOGIN | FEATURE_STANDALONE_REFUNDS | FEATURE_SECURITY_REPLAY_PROTECTION | FEATURE_SECURITY_HMAC_VERIFY | FEATURE_REPEATED_CHECKOUTS | FEATURE_RETRY_AFTER_DECLINE | FEATURE_PIN_ENTRY_BYPASS | FEATURE_TOKENIZATION | FEATURE_PARTIAL_AUTH }$.data.identifierUnique identifier of the merchant.UUID(Example: 12345678-abcd-1234-abcd-1234567890ab)$.data.nameThe name of the merchant.string(Example: Flower shop Inc)$.data.processingPaths[]$.data.processingPaths[].activeWhether or not the processing path is active.boolean$.data.processingPaths[].configuration$.data.processingPaths[].configuration.allowSkippingStreetNoBoolean$.data.processingPaths[].configuration.allowSkippingZipCodeBoolean$.data.processingPaths[].configuration.autoApproval{ ON_MATCH | ON_MATCH_OR_MAX_1_NOT_CHECKED | ON_MATCH_OR_MAX_2_NOT_CHECKED | ON_MATCH_OR_NOT_CHECKED }$.data.processingPaths[].configuration.autoDeclineCvv{ ON_MISMATCH_OR_NOT_CHECKED | ON_MISMATCH }$.data.processingPaths[].configuration.autoDeclineStreetNumber{ ON_MISMATCH_OR_NOT_CHECKED | ON_MISMATCH }$.data.processingPaths[].configuration.autoDeclineZipCheck{ ON_MISMATCH_OR_NOT_CHECKED | ON_MISMATCH }$.data.processingPaths[].configuration.treatAmexStreetNumberCheckAsPassedBoolean$.data.processingPaths[].currencies[]The currencies the merchant is able to accept.{ AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHF | CLP | CNY | COP | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GGP | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | IMP | INR | IQD | IRR | ISK | JEP | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SOS | SRD | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TVD | TWD | TZS | UAH | UGX | USD | UYU | UZS | VEF | VND | VUV | WST | XAF | XCD | XDR | XOF | XPF | YER | ZAR | ZMW | ZWD }$.data.processingPaths[].dccProvider$.data.processingPaths[].dccProvider.value$.data.processingPaths[].detailsMap$.data.processingPaths[].emvConfigurations[]$.data.processingPaths[].emvConfigurations[].applications[]$.data.processingPaths[].emvConfigurations[].applications[].aidstring$.data.processingPaths[].emvConfigurations[].applications[].contactEmvInterfaceConfigurationDto$.data.processingPaths[].emvConfigurations[].applications[].contactless[]$.data.processingPaths[].emvConfigurations[].applications[].contactless[].additionalApplicationVersions[]Array[String]$.data.processingPaths[].emvConfigurations[].applications[].contactless[].applicationVersionstring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].autoSelectionboolean$.data.processingPaths[].emvConfigurations[].applications[].contactless[].kernelIdstring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].priorityInteger$.data.processingPaths[].emvConfigurations[].applications[].contactless[].refundTransactionTypeEmvConfigurationDto$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.cardholderVerificationMethods[]{ SIGNATURE | PIN_ONLINE | PIN_OFFLINE | NO_CVM | CUSTOMER_DEVICE }$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[]$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].noCvmRequiredLimitBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].programIdstring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].statusCheckboolean$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].transactionLimitBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].zeroAmountAllowedboolean$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.noCvmRequiredLimitBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.statusCheckBoolean$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.defaultValuestring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.denialstring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.onlinestring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.transactionLimitBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.transactionLimitCustomerDeviceCvmBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.zeroAmountAllowedBoolean$.data.processingPaths[].emvConfigurations[].applications[].dataObjectLists$.data.processingPaths[].emvConfigurations[].applications[].dataObjectLists.dynamicDataAuthentication[]Array[String]$.data.processingPaths[].emvConfigurations[].applications[].dataObjectLists.processingOptionsData[]Array[String]$.data.processingPaths[].emvConfigurations[].applications[].dataObjectLists.transactionCertificate[]Array[String]$.data.processingPaths[].emvConfigurations[].capkeys[]$.data.processingPaths[].emvConfigurations[].capkeys[].expiryDateLocalDate$.data.processingPaths[].emvConfigurations[].capkeys[].exponentstring$.data.processingPaths[].emvConfigurations[].capkeys[].indexstring$.data.processingPaths[].emvConfigurations[].capkeys[].modulusLengthstring$.data.processingPaths[].emvConfigurations[].capkeys[].startDateLocalDate$.data.processingPaths[].emvConfigurations[].capkeys[].valuestring$.data.processingPaths[].emvConfigurations[].ridstring$.data.processingPaths[].identifierUnique identifier of the processing path.UUID(Example: 12345678-abcd-1234-abcd-1234567890ab)$.data.processingPaths[].modeMode of processing path.{ TEST | TEST_CONNECTOR | LIVE }$.data.processingPaths[].nameThe name of the processing path.string(Example: Default processing)$.data.processingPaths[].processingDetails$.data.processingPaths[].processingDetails.identifierUnique ID of the transaction processor. This information is for debugging purposes.string(Example: h987i654j321k098l765m432n210o987)$.data.processingPaths[].processingDetails.sessionCreatedThe date and time in UTC when the transaction processor session was created. This information is for debugging purposes.LocalDateTime(Example: 2014-03-12 10:40:41)$.data.processingPaths[].processingDetails.sessionIdentifierThe session ID of the transaction processor. This information is for debugging purposes.string$.data.processingPaths[].processingDetails.statusProcessing status code, for example 000.000.000 for transaction succeeded. This information is for debugging purposes.string(Example: 000.000.000)$.data.processingPaths[].processingDetails.timestampThe date and time in UTC when the transaction processor processed the transaction. This information is for debugging purposes.LocalDateTime(Example: 2014-03-12 10:40:41)$.data.processingPaths[].schemes[]The payment schemes the merchant is able to accept.{ VISA | MAESTRO | AMEX | VISAELECTRON | CHINAUNIONPAY | MASTER | DINERS | JCB | GIROCARD | ELV | V_PAY | DISCOVER | VISA_COMMON_DEBIT | MASTER_COMMON_DEBIT | DISCOVER_COMMON_DEBIT | UNION_PAY_COMMON_DEBIT | VISA_INTERLINK | GH_LINK | CARTES_BANCAIRES | ALIPAY | WECHAT_PAY | CYBERSOURCE_TOKEN | VALUE_LINK }$.data.readers[]$.data.readers[].created$.data.readers[].created.date$.data.readers[].created.date.dayshort$.data.readers[].created.date.monthshort$.data.readers[].created.date.yearint$.data.readers[].created.time$.data.readers[].created.time.hourbyte$.data.readers[].created.time.minutebyte$.data.readers[].created.time.nanoint$.data.readers[].created.time.secondbyte$.data.readers[].details$.data.readers[].details.assignedConfigurationProfileThe name of the profile, if any, being used by this reader (it can be defined at reader or application level).Using a profile you can define a custom configuration for a reader; this includes specific firmware, software and / or configurations such as the reader's logo or EMV configuration.string(Example: MIURA_CONTACTLESS)$.data.readers[].details.hardwareRevisionThe hardware revision as printed on the back of the reader.string(Example: M006-TEST02-V2-0)$.data.readers[].details.preInjectedKeys[]Set of pre injected keys{ PIN }$.data.readers[].details.serialNoThe serial number as printed on the back of the reader. Dashes are stripped from the serial number.string(Example: 006-123456)$.data.readers[].details.terminalIdsThe terminal IDs that have been assigned to the reader. Terminal IDs are used by the clearing institute to identify readers.Map$.data.readers[].statusCurrent status of the reader{ INACTIVE | ACTIVE | DEACTIVATED }$.statusIf the request was processed as planned,ok
is returned. If the field is set toerror
, $.error will be present and will contain more information.{ ok | error }(Example: ok)Error Status Codes
HTTP Status Code Error Number Reason 400 5124 The merchant identifier was not in the correct format. 401 5003 The specified credentials are wrong. 401 5001 Authentication is required to access this resource. 403 5002 The provided credentials are not sufficient to access the resource. 404 5206 Merchant with given id not found.
-
-
-
Implementation Notes
Update an existing Merchant in the System.
Response
Parameter Data Type $.data$.data.detailsInformation about the merchant which is used to produce receipts$.data.details.additionalInformationstring(Example: VAT Identification Number)$.data.details.addressstring(Example: Shopping Street 42)$.data.details.citystring(Example: Munich)$.data.details.contactstring(Example: flower@shop.com)$.data.details.countrystring(Example: DE)$.data.details.publicNamestring(Example: Flower shop Inc)$.data.details.zipstring(Example: 80000)$.data.features[]{ FEATURE_EMPLOYEE_LOGIN | FEATURE_STANDALONE_REFUNDS | FEATURE_SECURITY_REPLAY_PROTECTION | FEATURE_SECURITY_HMAC_VERIFY | FEATURE_REPEATED_CHECKOUTS | FEATURE_RETRY_AFTER_DECLINE | FEATURE_PIN_ENTRY_BYPASS | FEATURE_TOKENIZATION | FEATURE_PARTIAL_AUTH }$.data.identifierUnique identifier of the merchant.UUID(Example: 12345678-abcd-1234-abcd-1234567890ab)$.data.nameThe name of the merchant.string(Example: Flower shop Inc)$.data.processingPaths[]$.data.processingPaths[].activeWhether or not the processing path is active.boolean$.data.processingPaths[].configuration$.data.processingPaths[].configuration.allowSkippingStreetNoBoolean$.data.processingPaths[].configuration.allowSkippingZipCodeBoolean$.data.processingPaths[].configuration.autoApproval{ ON_MATCH | ON_MATCH_OR_MAX_1_NOT_CHECKED | ON_MATCH_OR_MAX_2_NOT_CHECKED | ON_MATCH_OR_NOT_CHECKED }$.data.processingPaths[].configuration.autoDeclineCvv{ ON_MISMATCH_OR_NOT_CHECKED | ON_MISMATCH }$.data.processingPaths[].configuration.autoDeclineStreetNumber{ ON_MISMATCH_OR_NOT_CHECKED | ON_MISMATCH }$.data.processingPaths[].configuration.autoDeclineZipCheck{ ON_MISMATCH_OR_NOT_CHECKED | ON_MISMATCH }$.data.processingPaths[].configuration.treatAmexStreetNumberCheckAsPassedBoolean$.data.processingPaths[].currencies[]The currencies the merchant is able to accept.{ AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHF | CLP | CNY | COP | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GGP | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | IMP | INR | IQD | IRR | ISK | JEP | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SOS | SRD | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TVD | TWD | TZS | UAH | UGX | USD | UYU | UZS | VEF | VND | VUV | WST | XAF | XCD | XDR | XOF | XPF | YER | ZAR | ZMW | ZWD }$.data.processingPaths[].dccProvider$.data.processingPaths[].dccProvider.value$.data.processingPaths[].detailsMap$.data.processingPaths[].emvConfigurations[]$.data.processingPaths[].emvConfigurations[].applications[]$.data.processingPaths[].emvConfigurations[].applications[].aidstring$.data.processingPaths[].emvConfigurations[].applications[].contactEmvInterfaceConfigurationDto$.data.processingPaths[].emvConfigurations[].applications[].contactless[]$.data.processingPaths[].emvConfigurations[].applications[].contactless[].additionalApplicationVersions[]Array[String]$.data.processingPaths[].emvConfigurations[].applications[].contactless[].applicationVersionstring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].autoSelectionboolean$.data.processingPaths[].emvConfigurations[].applications[].contactless[].kernelIdstring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].priorityInteger$.data.processingPaths[].emvConfigurations[].applications[].contactless[].refundTransactionTypeEmvConfigurationDto$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.cardholderVerificationMethods[]{ SIGNATURE | PIN_ONLINE | PIN_OFFLINE | NO_CVM | CUSTOMER_DEVICE }$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[]$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].noCvmRequiredLimitBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].programIdstring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].statusCheckboolean$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].transactionLimitBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].zeroAmountAllowedboolean$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.noCvmRequiredLimitBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.statusCheckBoolean$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.defaultValuestring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.denialstring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.onlinestring$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.transactionLimitBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.transactionLimitCustomerDeviceCvmBigDecimal$.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.zeroAmountAllowedBoolean$.data.processingPaths[].emvConfigurations[].applications[].dataObjectLists$.data.processingPaths[].emvConfigurations[].applications[].dataObjectLists.dynamicDataAuthentication[]Array[String]$.data.processingPaths[].emvConfigurations[].applications[].dataObjectLists.processingOptionsData[]Array[String]$.data.processingPaths[].emvConfigurations[].applications[].dataObjectLists.transactionCertificate[]Array[String]$.data.processingPaths[].emvConfigurations[].capkeys[]$.data.processingPaths[].emvConfigurations[].capkeys[].expiryDateLocalDate$.data.processingPaths[].emvConfigurations[].capkeys[].exponentstring$.data.processingPaths[].emvConfigurations[].capkeys[].indexstring$.data.processingPaths[].emvConfigurations[].capkeys[].modulusLengthstring$.data.processingPaths[].emvConfigurations[].capkeys[].startDateLocalDate$.data.processingPaths[].emvConfigurations[].capkeys[].valuestring$.data.processingPaths[].emvConfigurations[].ridstring$.data.processingPaths[].identifierUnique identifier of the processing path.UUID(Example: 12345678-abcd-1234-abcd-1234567890ab)$.data.processingPaths[].modeMode of processing path.{ TEST | TEST_CONNECTOR | LIVE }$.data.processingPaths[].nameThe name of the processing path.string(Example: Default processing)$.data.processingPaths[].processingDetails$.data.processingPaths[].processingDetails.identifierUnique ID of the transaction processor. This information is for debugging purposes.string(Example: h987i654j321k098l765m432n210o987)$.data.processingPaths[].processingDetails.sessionCreatedThe date and time in UTC when the transaction processor session was created. This information is for debugging purposes.LocalDateTime(Example: 2014-03-12 10:40:41)$.data.processingPaths[].processingDetails.sessionIdentifierThe session ID of the transaction processor. This information is for debugging purposes.string$.data.processingPaths[].processingDetails.statusProcessing status code, for example 000.000.000 for transaction succeeded. This information is for debugging purposes.string(Example: 000.000.000)$.data.processingPaths[].processingDetails.timestampThe date and time in UTC when the transaction processor processed the transaction. This information is for debugging purposes.LocalDateTime(Example: 2014-03-12 10:40:41)$.data.processingPaths[].schemes[]The payment schemes the merchant is able to accept.{ VISA | MAESTRO | AMEX | VISAELECTRON | CHINAUNIONPAY | MASTER | DINERS | JCB | GIROCARD | ELV | V_PAY | DISCOVER | VISA_COMMON_DEBIT | MASTER_COMMON_DEBIT | DISCOVER_COMMON_DEBIT | UNION_PAY_COMMON_DEBIT | VISA_INTERLINK | GH_LINK | CARTES_BANCAIRES | ALIPAY | WECHAT_PAY | CYBERSOURCE_TOKEN | VALUE_LINK }$.data.readers[]$.data.readers[].created$.data.readers[].created.date$.data.readers[].created.date.dayshort$.data.readers[].created.date.monthshort$.data.readers[].created.date.yearint$.data.readers[].created.time$.data.readers[].created.time.hourbyte$.data.readers[].created.time.minutebyte$.data.readers[].created.time.nanoint$.data.readers[].created.time.secondbyte$.data.readers[].details$.data.readers[].details.assignedConfigurationProfileThe name of the profile, if any, being used by this reader (it can be defined at reader or application level).Using a profile you can define a custom configuration for a reader; this includes specific firmware, software and / or configurations such as the reader's logo or EMV configuration.string(Example: MIURA_CONTACTLESS)$.data.readers[].details.hardwareRevisionThe hardware revision as printed on the back of the reader.string(Example: M006-TEST02-V2-0)$.data.readers[].details.preInjectedKeys[]Set of pre injected keys{ PIN }$.data.readers[].details.serialNoThe serial number as printed on the back of the reader. Dashes are stripped from the serial number.string(Example: 006-123456)$.data.readers[].details.terminalIdsThe terminal IDs that have been assigned to the reader. Terminal IDs are used by the clearing institute to identify readers.Map$.data.readers[].statusCurrent status of the reader{ INACTIVE | ACTIVE | DEACTIVATED }$.statusIf the request was processed as planned,ok
is returned. If the field is set toerror
, $.error will be present and will contain more information.{ ok | error }(Example: ok)Error Status Codes
HTTP Status Code Error Number Reason 401 5003 The specified credentials are wrong. 401 5001 Authentication is required to access this resource. 403 5002 The provided credentials are not sufficient to access the resource.
-
-
-
Implementation Notes
Add a new Processing path to the Merchant. This creates a processing path in the system and attaches it the Merchant. The processing path defines where the payment is routed. It includes parameters needed for the clearing institute, such as terminal IDs and merchant IDs. These parameters differ for each clearing institute.
Response
Parameter Data Type $.data$.data.activeWhether or not the processing path is active.boolean$.data.configuration$.data.configuration.allowSkippingStreetNoBoolean$.data.configuration.allowSkippingZipCodeBoolean$.data.configuration.autoApproval{ ON_MATCH | ON_MATCH_OR_MAX_1_NOT_CHECKED | ON_MATCH_OR_MAX_2_NOT_CHECKED | ON_MATCH_OR_NOT_CHECKED }$.data.configuration.autoDeclineCvv{ ON_MISMATCH_OR_NOT_CHECKED | ON_MISMATCH }$.data.configuration.autoDeclineStreetNumber{ ON_MISMATCH_OR_NOT_CHECKED | ON_MISMATCH }$.data.configuration.autoDeclineZipCheck{ ON_MISMATCH_OR_NOT_CHECKED | ON_MISMATCH }$.data.configuration.treatAmexStreetNumberCheckAsPassedBoolean$.data.currencies[]The currencies the merchant is able to accept.{ AED | AFN | ALL | AMD | ANG | AOA | ARS | AUD | AWG | AZN | BAM | BBD | BDT | BGN | BHD | BIF | BMD | BND | BOB | BRL | BSD | BTN | BWP | BYR | BZD | CAD | CDF | CHF | CLP | CNY | COP | CRC | CUC | CUP | CVE | CZK | DJF | DKK | DOP | DZD | EGP | ERN | ETB | EUR | FJD | FKP | GBP | GEL | GGP | GHS | GIP | GMD | GNF | GTQ | GYD | HKD | HNL | HRK | HTG | HUF | IDR | ILS | IMP | INR | IQD | IRR | ISK | JEP | JMD | JOD | JPY | KES | KGS | KHR | KMF | KPW | KRW | KWD | KYD | KZT | LAK | LBP | LKR | LRD | LSL | LYD | MAD | MDL | MGA | MKD | MMK | MNT | MOP | MRO | MUR | MVR | MWK | MXN | MYR | MZN | NAD | NGN | NIO | NOK | NPR | NZD | OMR | PAB | PEN | PGK | PHP | PKR | PLN | PYG | QAR | RON | RSD | RUB | RWF | SAR | SBD | SCR | SDG | SEK | SGD | SHP | SLL | SOS | SRD | STD | SVC | SYP | SZL | THB | TJS | TMT | TND | TOP | TRY | TTD | TVD | TWD | TZS | UAH | UGX | USD | UYU | UZS | VEF | VND | VUV | WST | XAF | XCD | XDR | XOF | XPF | YER | ZAR | ZMW | ZWD }$.data.dccProvider$.data.dccProvider.value$.data.detailsMap$.data.emvConfigurations[]$.data.emvConfigurations[].applications[]$.data.emvConfigurations[].applications[].aidstring$.data.emvConfigurations[].applications[].contactEmvInterfaceConfigurationDto$.data.emvConfigurations[].applications[].contactless[]$.data.emvConfigurations[].applications[].contactless[].additionalApplicationVersions[]Array[String]$.data.emvConfigurations[].applications[].contactless[].applicationVersionstring$.data.emvConfigurations[].applications[].contactless[].autoSelectionboolean$.data.emvConfigurations[].applications[].contactless[].kernelIdstring$.data.emvConfigurations[].applications[].contactless[].priorityInteger$.data.emvConfigurations[].applications[].contactless[].refundTransactionTypeEmvConfigurationDto$.data.emvConfigurations[].applications[].contactless[].sale$.data.emvConfigurations[].applications[].contactless[].sale.cardholderVerificationMethods[]{ SIGNATURE | PIN_ONLINE | PIN_OFFLINE | NO_CVM | CUSTOMER_DEVICE }$.data.emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[]$.data.emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].noCvmRequiredLimitBigDecimal$.data.emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].programIdstring$.data.emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].statusCheckboolean$.data.emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].transactionLimitBigDecimal$.data.emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].zeroAmountAllowedboolean$.data.emvConfigurations[].applications[].contactless[].sale.noCvmRequiredLimitBigDecimal$.data.emvConfigurations[].applications[].contactless[].sale.statusCheckBoolean$.data.emvConfigurations[].applications[].contactless[].sale.terminalActionCodes$.data.emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.defaultValuestring$.data.emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.denialstring$.data.emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.onlinestring$.data.emvConfigurations[].applications[].contactless[].sale.transactionLimitBigDecimal$.data.emvConfigurations[].applications[].contactless[].sale.transactionLimitCustomerDeviceCvmBigDecimal$.data.emvConfigurations[].applications[].contactless[].sale.zeroAmountAllowedBoolean$.data.emvConfigurations[].applications[].dataObjectLists$.data.emvConfigurations[].applications[].dataObjectLists.dynamicDataAuthentication[]Array[String]$.data.emvConfigurations[].applications[].dataObjectLists.processingOptionsData[]Array[String]$.data.emvConfigurations[].applications[].dataObjectLists.transactionCertificate[]Array[String]$.data.emvConfigurations[].capkeys[]$.data.emvConfigurations[].capkeys[].expiryDateLocalDate$.data.emvConfigurations[].capkeys[].exponentstring$.data.emvConfigurations[].capkeys[].indexstring$.data.emvConfigurations[].capkeys[].modulusLengthstring$.data.emvConfigurations[].capkeys[].startDateLocalDate$.data.emvConfigurations[].capkeys[].valuestring$.data.emvConfigurations[].ridstring$.data.identifierUnique identifier of the processing path.UUID(Example: 12345678-abcd-1234-abcd-1234567890ab)$.data.modeMode of processing path.{ TEST | TEST_CONNECTOR | LIVE }$.data.nameThe name of the processing path.string(Example: Default processing)$.data.processingDetails$.data.processingDetails.identifierUnique ID of the transaction processor. This information is for debugging purposes.string(Example: h987i654j321k098l765m432n210o987)$.data.processingDetails.sessionCreatedThe date and time in UTC when the transaction processor session was created. This information is for debugging purposes.(Example: 2014-03-12 10:40:41)$.data.processingDetails.sessionCreated.date$.data.processingDetails.sessionCreated.date.dayshort$.data.processingDetails.sessionCreated.date.monthshort$.data.processingDetails.sessionCreated.date.yearint$.data.processingDetails.sessionCreated.time$.data.processingDetails.sessionCreated.time.hourbyte$.data.processingDetails.sessionCreated.time.minutebyte$.data.processingDetails.sessionCreated.time.nano
-
-