API Documentation

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

  • /applications

      • delete /v2/applications/{applicationId}/readers/{readerIdentifier}

        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.day
        short
        $.data.created.date.month
        short
        $.data.created.date.year
        int
        $.data.created.time
        $.data.created.time.hour
        $.data.created.time.minute
        byte
        $.data.created.time.nano
        int
        $.data.created.time.second
        byte
        $.data.details
        $.data.details.assignedConfigurationProfile
        The 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.hardwareRevision
        The 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.serialNo
        The serial number as printed on the back of the reader. Dashes are stripped from the serial number.
        string
        (Example: 006-123456)
        $.data.details.terminalIds
        The terminal IDs that have been assigned to the reader. Terminal IDs are used by the clearing institute to identify readers.
        Map
        $.data.status
        Current status of the reader
        { INACTIVE | ACTIVE | DEACTIVATED }
        $.status
        If the request was processed as planned, ok is returned. If the field is set to error, $.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.

  • /events

      • get /v2/events/{eventId}

        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.created
        The date and time in UTC when the event was created.
        Date
        (Example: 2014-03-12 10:40:41)
        $.data.identifier
        Unique identifier of the event.
        UUID
        (Example: 12345678-abcd-1234-abcd-1234567890ab)
        $.data.transaction
        The transaction associated with the event.
        $.data.transaction.alternativePaymentMethodDetails
        Information about the Alternative Payment Method used for the transaction
        Optional
        $.data.transaction.amount
        The amount of the transaction.
        BigDecimal
        (Example: 15.30)
        $.data.transaction.avsDetails
        Information about the Address Verification System.
        Optional
        $.data.transaction.captured
        Indicates whether the transaction was captured successfully.
        Boolean
        $.data.transaction.cardDetails
        $.data.transaction.cardDetails.cardholderName
        The 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.countryCodeNumber
        Issuer country code represented as a 3-digit ISO 3166-1 numeral.
        string
        $.data.transaction.cardDetails.expiryMonth
        Card expiry month.
        Integer
        $.data.transaction.cardDetails.expiryYear
        Card expiry year.
        Integer
        $.data.transaction.cardDetails.fingerprint
        Hash that uniquely identifies the card used in the transaction.
        string
        $.data.transaction.cardDetails.maskedCardNumber
        Masked card account number.
        string
        $.data.transaction.cardDetails.scheme
        Card scheme.
        string
        $.data.transaction.clearingDetails
        Detailed information about the clearing institute.
        $.data.transaction.clearingDetails.authorizationCode
        The authorization code for a successful transaction. Depending on the clearing institute used, this can be a concatenation of the clearing institute and issuer authorization code
        string
        (Example: 123456/123456)
        $.data.transaction.clearingDetails.completed
        The date the transaction was completed in the clearing institutes system
        Date
        (Example: 2014-03-12 10:40:41)
        $.data.transaction.clearingDetails.institute
        Clearing institute name.
        string
        (Example: SIXCARD)
        $.data.transaction.clearingDetails.merchantId
        The merchant ID of the merchant performing the transaction as assigned by the clearing institute
        string
        (Example: 123456789012345)
        $.data.transaction.clearingDetails.originalTransactionIdentifier
        In case of refund transactions, this contains the transaction identifier as assigned by the clearing institute of the origin CHARGE transaction
        string
        (Example: 055954)
        $.data.transaction.clearingDetails.statusText
        A 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 transaction
        string
        $.data.transaction.clearingDetails.terminalId
        The terminal ID of the merchant performing the transaction
        string
        (Example: 12345678)
        $.data.transaction.clearingDetails.transactionIdentifier
        The transaction identifier as assigned by the clearing institute
        string
        (Example: 055953)
        $.data.transaction.created
        The date and time in UTC when the transaction was created.
        LocalDateTime
        (Example: 2014-03-12 10:40:41)
        $.data.transaction.createdTimeZoned
        Optional
        $.data.transaction.currency
        Currency 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.customIdentifier
        Custom identifier of the transaction.
        string
        (Example: My identifier)
        $.data.transaction.dccDetails
        Information about Dynamic Currency Conversion.
        Optional
        $.data.transaction.details
        Additional information about the transaction.
        $.data.transaction.details.applicationFee
        Application fee for stripe transactions.
        BigDecimal
        $.data.transaction.details.includedTipAmount
        Tip included in the transaction. Only available if tip was given.
        BigDecimal
        $.data.transaction.details.metadata
        Metadata for stripe transactions.
        Map
        $.data.transaction.details.tipAdjustStatus
        Tip adjust status. Only available if tip was given.
        { ADJUSTABLE | NOT_ADJUSTABLE | ADJUSTED }
        $.data.transaction.giftCardDetails
        Information about the gift card in case it is an activation response
        Optional
        $.data.transaction.groupIdentifier
        Unique 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.identifier
        Unique identifier of the transaction.
        string
        (Example: 12345678abcd1234abcd1234567890ab)
        $.data.transaction.internalTypeOverride
        { CHARGE | REFUND | CREDIT | PREAUTHORIZE | VERIFICATION | ACTIVATION | BALANCE_INQUIRY | CASHOUT }
        $.data.transaction.locationDetails
        Detailed information about the location where the transaction was performed (if available).
        $.data.transaction.locationDetails.horizontalAccuracy
        The accuracy of the location details in meters.
        string
        (Example: 10)
        $.data.transaction.locationDetails.latitude
        The latitude of the location where the transaction was performed in degrees.
        string
        (Example: 48.133924)
        $.data.transaction.locationDetails.longitude
        The longitude of the location where the transaction was performed in degrees.
        string
        (Example: 11.54934)
        $.data.transaction.merchant
        $.data.transaction.merchant.identifier
        Identifier of the merchant performed the transaction.
        UUID
        $.data.transaction.merchant.name
        Name of the merchant performed the transaction.
        string
        $.data.transaction.mode
        Mode of the transaction.
        { TEST | TEST_CONNECTOR | LIVE }
        $.data.transaction.offlineDetails
        $.data.transaction.offlineDetails.value
        Object
        $.data.transaction.paymentDetails
        Detailed information about the payment of the transaction.
        $.data.transaction.paymentDetails.customerVerification
        $.data.transaction.paymentDetails.customerVerification.type
        Type 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.maskedAccount
        Masked account number.
        string
        (Example: 420000XXXXXX5052)
        $.data.transaction.paymentDetails.maskedTrack2
        Masked track 2 data.
        string
        (Example: 420000XXXXXX5052=15122011143857589)
        $.data.transaction.paymentDetails.scheme
        The 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.source
        The 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.previousTransaction
        TransactionResponseV2
        $.data.transaction.processingDetails
        Detailed information about the processing of the transaction. Relevant for debugging use.
        $.data.transaction.processingDetails.identifier
        Unique ID of the transaction processor. This information is for debugging purposes.
        string
        (Example: h987i654j321k098l765m432n210o987)
        $.data.transaction.processingDetails.sessionCreated
        The 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.sessionIdentifier
        The session ID of the transaction processor. This information is for debugging purposes.
        string
        $.data.transaction.processingDetails.status
        Processing status code, for example 000.000.000 for transaction succeeded. This information is for debugging purposes.
        string
        (Example: 000.000.000)
        $.data.transaction.processingDetails.timestamp
        The 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.processingMode
        Processing mode of the transaction.
        { POS_OFFLINE | POS_ONLINE | ECOMMERCE }
        $.data.transaction.profileUserDetails
        $.data.transaction.profileUserDetails.firstName
        string
        (Example: John)
        $.data.transaction.profileUserDetails.lastName
        string
        (Example: Doe)
        $.data.transaction.profileUserDetails.username
        The username and email of the user.
        string
        (Example: john.doe@example.com)
        $.data.transaction.reader
        The reader used for performing the transaction.
        $.data.transaction.reader.created
        $.data.transaction.reader.created.date
        $.data.transaction.reader.created.date.day
        short
        $.data.transaction.reader.created.date.month
        short
        $.data.transaction.reader.created.date.year
        int
        $.data.transaction.reader.created.time
        $.data.transaction.reader.created.time.hour
        $.data.transaction.reader.created.time.minute
        byte
        $.data.transaction.reader.created.time.nano
        int
        $.data.transaction.reader.created.time.second
        byte
        $.data.transaction.reader.details
        $.data.transaction.reader.details.assignedConfigurationProfile
        The 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.hardwareRevision
        The 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.serialNo
        The 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.terminalIds
        The terminal IDs that have been assigned to the reader. Terminal IDs are used by the clearing institute to identify readers.
        Map
        $.data.transaction.reader.status
        Current status of the reader
        { INACTIVE | ACTIVE | DEACTIVATED }
        $.data.transaction.receiptDetails
        Transaction details that are needed for printing receipts.
        $.data.transaction.receiptDetails.authorizationCode
        The authorization code for a successful transaction.
        string
        (Example: 3030)
        $.data.transaction.receiptDetails.emv
        EMV details of the transaction.
        $.data.transaction.receiptDetails.emv.applicationID
        The application ID of the EMV application used for this transaction.
        string
        (Example: A0000000031010)
        $.data.transaction.receiptDetails.emv.applicationLabel
        A human readable description of the EMV application used for this transaction.
        string
        (Example: VISA)
        $.data.transaction.receiptDetails.emv.terminalVerificationResult
        The terminal verification result. This describes the cardholder verification method and other checks done by the terminal.
        string
        (Example: 0000008000)
        $.data.transaction.receiptDetails.emv.transactionStatusInformation
        The transaction status information indicates the functions performed in a transaction.
        string
        (Example: E800)
        $.data.transaction.referencedTransactionIdentifier
        Identifier of the referenced transaction i.e. for refund it contains identifier of initial debit transaction.
        string
        (Example: 12345678abcd1234abcd1234567890ab)
        $.data.transaction.refundDetails
        Detailed 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 types
        Array[RefundTransactionResponseV2]
        $.data.transaction.refundDetails.refundableAmount
        The amount which can be refunded.
        BigDecimal
        (Example: 15.30)
        $.data.transaction.refundDetails.status
        Type 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.clientId
        The client ID generated by the OS for the installation.
        string
        (Example: E522Z0EC-91B1-4A11-93D5-F3732F0A80C7)
        $.data.transaction.sdkDetails.deviceOs
        The device's Operating System.
        string
        (Example: iPhone OS)
        $.data.transaction.sdkDetails.osVersion
        The device's Operating System version.
        string
        (Example: 9.3.2)
        $.data.transaction.sdkDetails.sdkVersion
        The SDK version.
        string
        (Example: payworks.mpos.ios/2.4.6)
        $.data.transaction.shopperDetails
        $.data.transaction.shopperDetails.email
        Shopper email address. It will be automatically updated every time the shopper uses the receipt API.
        string
        $.data.transaction.shopperDetails.identifier
        Shopper identifier that can be used to gather data related to it, like the cards used by it or the transactions performed.
        string
        $.data.transaction.statementDescriptor
        Statement descriptor of the transaction.
        string
        $.data.transaction.status
        Status of the transaction.
        { INITIALIZED | PENDING | APPROVED | DECLINED | ABORTED | ERROR }
        $.data.transaction.statusDetails
        Detailed status of the transaction.
        $.data.transaction.statusDetails.code
        A code representing the status of the transaction.
        string
        (Example: ABORTED_MERCHANT_ABORTED)
        $.data.transaction.statusDetails.description
        A description of the detailed status of a transaction.
        string
        $.data.transaction.statusDetails.developerDescription
        A description of the detailed status of a transaction intended for developers to give more debugging information.
        string
        $.data.transaction.subject
        Transaction subject.
        string
        $.data.transaction.type
        Type of the transaction.
        { CHARGE | REFUND | CREDIT | PREAUTHORIZE | VERIFICATION | ACTIVATION | BALANCE_INQUIRY | CASHOUT }
        $.data.transaction.typeDetails
        Type details of the transaction.
        $.data.transaction.typeDetails.code
        { REFUND_BEFORE_CLEARING | REFUND_AFTER_CLEARING | PARTIAL_CAPTURE }
        $.data.transaction.verificationResults
        Results of verifications (e.g. cvv, address).
        Map
        $.data.transaction.workflow
        Workflow (e.g. POS, MOTO, ALTERNATIVE_PAYMENT_METHOD)
        Optional
        $.data.type
        Type of the event.
        string
        (Example: transaction.succeeded)
        $.status
        If the request was processed as planned, ok is returned. If the field is set to error, $.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.

  • /merchants

      • post /v2/merchants

        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.details
        Information about the merchant which is used to produce receipts
        $.data.details.additionalInformation
        string
        (Example: VAT Identification Number)
        $.data.details.address
        string
        (Example: Shopping Street 42)
        $.data.details.city
        string
        (Example: Munich)
        $.data.details.contact
        string
        (Example: flower@shop.com)
        $.data.details.country
        string
        (Example: DE)
        $.data.details.publicName
        string
        (Example: Flower shop Inc)
        $.data.details.zip
        string
        (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.identifier
        Unique identifier of the merchant.
        UUID
        (Example: 12345678-abcd-1234-abcd-1234567890ab)
        $.data.name
        The name of the merchant.
        string
        (Example: Flower shop Inc)
        $.data.processingPaths[]
        $.data.processingPaths[].active
        Whether or not the processing path is active.
        boolean
        $.data.processingPaths[].configuration
        $.data.processingPaths[].configuration.allowSkippingStreetNo
        Boolean
        $.data.processingPaths[].configuration.allowSkippingZipCode
        Boolean
        $.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.treatAmexStreetNumberCheckAsPassed
        Boolean
        $.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[].details
        Map
        $.data.processingPaths[].emvConfigurations[]
        $.data.processingPaths[].emvConfigurations[].applications[]
        $.data.processingPaths[].emvConfigurations[].applications[].aid
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contact
        EmvInterfaceConfigurationDto
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[]
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].additionalApplicationVersions[]
        Array[String]
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].applicationVersion
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].autoSelection
        boolean
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].kernelId
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].priority
        Integer
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].refund
        TransactionTypeEmvConfigurationDto
        $.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[].noCvmRequiredLimit
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].programId
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].statusCheck
        boolean
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].transactionLimit
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].zeroAmountAllowed
        boolean
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.noCvmRequiredLimit
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.statusCheck
        Boolean
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.defaultValue
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.denial
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.online
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.transactionLimit
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.transactionLimitCustomerDeviceCvm
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.zeroAmountAllowed
        Boolean
        $.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[].expiryDate
        LocalDate
        $.data.processingPaths[].emvConfigurations[].capkeys[].exponent
        string
        $.data.processingPaths[].emvConfigurations[].capkeys[].index
        string
        $.data.processingPaths[].emvConfigurations[].capkeys[].modulusLength
        string
        $.data.processingPaths[].emvConfigurations[].capkeys[].startDate
        LocalDate
        $.data.processingPaths[].emvConfigurations[].capkeys[].value
        string
        $.data.processingPaths[].emvConfigurations[].rid
        string
        $.data.processingPaths[].identifier
        Unique identifier of the processing path.
        UUID
        (Example: 12345678-abcd-1234-abcd-1234567890ab)
        $.data.processingPaths[].mode
        Mode of processing path.
        { TEST | TEST_CONNECTOR | LIVE }
        $.data.processingPaths[].name
        The name of the processing path.
        string
        (Example: Default processing)
        $.data.processingPaths[].processingDetails
        $.data.processingPaths[].processingDetails.identifier
        Unique ID of the transaction processor. This information is for debugging purposes.
        string
        (Example: h987i654j321k098l765m432n210o987)
        $.data.processingPaths[].processingDetails.sessionCreated
        The 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.sessionIdentifier
        The session ID of the transaction processor. This information is for debugging purposes.
        string
        $.data.processingPaths[].processingDetails.status
        Processing status code, for example 000.000.000 for transaction succeeded. This information is for debugging purposes.
        string
        (Example: 000.000.000)
        $.data.processingPaths[].processingDetails.timestamp
        The 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.day
        short
        $.data.readers[].created.date.month
        short
        $.data.readers[].created.date.year
        int
        $.data.readers[].created.time
        $.data.readers[].created.time.hour
        byte
        $.data.readers[].created.time.minute
        byte
        $.data.readers[].created.time.nano
        int
        $.data.readers[].created.time.second
        byte
        $.data.readers[].details
        $.data.readers[].details.assignedConfigurationProfile
        The 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.hardwareRevision
        The 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.serialNo
        The serial number as printed on the back of the reader. Dashes are stripped from the serial number.
        string
        (Example: 006-123456)
        $.data.readers[].details.terminalIds
        The terminal IDs that have been assigned to the reader. Terminal IDs are used by the clearing institute to identify readers.
        Map
        $.data.readers[].status
        Current status of the reader
        { INACTIVE | ACTIVE | DEACTIVATED }
        $.status
        If the request was processed as planned, ok is returned. If the field is set to error, $.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.

      • get /v2/merchants/{merchantIdentifier}

        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.details
        Information about the merchant which is used to produce receipts
        $.data.details.additionalInformation
        string
        (Example: VAT Identification Number)
        $.data.details.address
        string
        (Example: Shopping Street 42)
        $.data.details.city
        string
        (Example: Munich)
        $.data.details.contact
        string
        (Example: flower@shop.com)
        $.data.details.country
        string
        (Example: DE)
        $.data.details.publicName
        string
        (Example: Flower shop Inc)
        $.data.details.zip
        string
        (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.identifier
        Unique identifier of the merchant.
        UUID
        (Example: 12345678-abcd-1234-abcd-1234567890ab)
        $.data.name
        The name of the merchant.
        string
        (Example: Flower shop Inc)
        $.data.processingPaths[]
        $.data.processingPaths[].active
        Whether or not the processing path is active.
        boolean
        $.data.processingPaths[].configuration
        $.data.processingPaths[].configuration.allowSkippingStreetNo
        Boolean
        $.data.processingPaths[].configuration.allowSkippingZipCode
        Boolean
        $.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.treatAmexStreetNumberCheckAsPassed
        Boolean
        $.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[].details
        Map
        $.data.processingPaths[].emvConfigurations[]
        $.data.processingPaths[].emvConfigurations[].applications[]
        $.data.processingPaths[].emvConfigurations[].applications[].aid
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contact
        EmvInterfaceConfigurationDto
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[]
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].additionalApplicationVersions[]
        Array[String]
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].applicationVersion
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].autoSelection
        boolean
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].kernelId
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].priority
        Integer
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].refund
        TransactionTypeEmvConfigurationDto
        $.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[].noCvmRequiredLimit
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].programId
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].statusCheck
        boolean
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].transactionLimit
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].zeroAmountAllowed
        boolean
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.noCvmRequiredLimit
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.statusCheck
        Boolean
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.defaultValue
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.denial
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.online
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.transactionLimit
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.transactionLimitCustomerDeviceCvm
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.zeroAmountAllowed
        Boolean
        $.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[].expiryDate
        LocalDate
        $.data.processingPaths[].emvConfigurations[].capkeys[].exponent
        string
        $.data.processingPaths[].emvConfigurations[].capkeys[].index
        string
        $.data.processingPaths[].emvConfigurations[].capkeys[].modulusLength
        string
        $.data.processingPaths[].emvConfigurations[].capkeys[].startDate
        LocalDate
        $.data.processingPaths[].emvConfigurations[].capkeys[].value
        string
        $.data.processingPaths[].emvConfigurations[].rid
        string
        $.data.processingPaths[].identifier
        Unique identifier of the processing path.
        UUID
        (Example: 12345678-abcd-1234-abcd-1234567890ab)
        $.data.processingPaths[].mode
        Mode of processing path.
        { TEST | TEST_CONNECTOR | LIVE }
        $.data.processingPaths[].name
        The name of the processing path.
        string
        (Example: Default processing)
        $.data.processingPaths[].processingDetails
        $.data.processingPaths[].processingDetails.identifier
        Unique ID of the transaction processor. This information is for debugging purposes.
        string
        (Example: h987i654j321k098l765m432n210o987)
        $.data.processingPaths[].processingDetails.sessionCreated
        The 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.sessionIdentifier
        The session ID of the transaction processor. This information is for debugging purposes.
        string
        $.data.processingPaths[].processingDetails.status
        Processing status code, for example 000.000.000 for transaction succeeded. This information is for debugging purposes.
        string
        (Example: 000.000.000)
        $.data.processingPaths[].processingDetails.timestamp
        The 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.day
        short
        $.data.readers[].created.date.month
        short
        $.data.readers[].created.date.year
        int
        $.data.readers[].created.time
        $.data.readers[].created.time.hour
        byte
        $.data.readers[].created.time.minute
        byte
        $.data.readers[].created.time.nano
        int
        $.data.readers[].created.time.second
        byte
        $.data.readers[].details
        $.data.readers[].details.assignedConfigurationProfile
        The 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.hardwareRevision
        The 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.serialNo
        The serial number as printed on the back of the reader. Dashes are stripped from the serial number.
        string
        (Example: 006-123456)
        $.data.readers[].details.terminalIds
        The terminal IDs that have been assigned to the reader. Terminal IDs are used by the clearing institute to identify readers.
        Map
        $.data.readers[].status
        Current status of the reader
        { INACTIVE | ACTIVE | DEACTIVATED }
        $.status
        If the request was processed as planned, ok is returned. If the field is set to error, $.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.

      • patch /v2/merchants/{merchantIdentifier}

        Implementation Notes

        Update an existing Merchant in the System.

        Response

        Parameter Data Type
        $.data
        $.data.details
        Information about the merchant which is used to produce receipts
        $.data.details.additionalInformation
        string
        (Example: VAT Identification Number)
        $.data.details.address
        string
        (Example: Shopping Street 42)
        $.data.details.city
        string
        (Example: Munich)
        $.data.details.contact
        string
        (Example: flower@shop.com)
        $.data.details.country
        string
        (Example: DE)
        $.data.details.publicName
        string
        (Example: Flower shop Inc)
        $.data.details.zip
        string
        (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.identifier
        Unique identifier of the merchant.
        UUID
        (Example: 12345678-abcd-1234-abcd-1234567890ab)
        $.data.name
        The name of the merchant.
        string
        (Example: Flower shop Inc)
        $.data.processingPaths[]
        $.data.processingPaths[].active
        Whether or not the processing path is active.
        boolean
        $.data.processingPaths[].configuration
        $.data.processingPaths[].configuration.allowSkippingStreetNo
        Boolean
        $.data.processingPaths[].configuration.allowSkippingZipCode
        Boolean
        $.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.treatAmexStreetNumberCheckAsPassed
        Boolean
        $.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[].details
        Map
        $.data.processingPaths[].emvConfigurations[]
        $.data.processingPaths[].emvConfigurations[].applications[]
        $.data.processingPaths[].emvConfigurations[].applications[].aid
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contact
        EmvInterfaceConfigurationDto
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[]
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].additionalApplicationVersions[]
        Array[String]
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].applicationVersion
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].autoSelection
        boolean
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].kernelId
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].priority
        Integer
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].refund
        TransactionTypeEmvConfigurationDto
        $.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[].noCvmRequiredLimit
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].programId
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].statusCheck
        boolean
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].transactionLimit
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].zeroAmountAllowed
        boolean
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.noCvmRequiredLimit
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.statusCheck
        Boolean
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.defaultValue
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.denial
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.online
        string
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.transactionLimit
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.transactionLimitCustomerDeviceCvm
        BigDecimal
        $.data.processingPaths[].emvConfigurations[].applications[].contactless[].sale.zeroAmountAllowed
        Boolean
        $.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[].expiryDate
        LocalDate
        $.data.processingPaths[].emvConfigurations[].capkeys[].exponent
        string
        $.data.processingPaths[].emvConfigurations[].capkeys[].index
        string
        $.data.processingPaths[].emvConfigurations[].capkeys[].modulusLength
        string
        $.data.processingPaths[].emvConfigurations[].capkeys[].startDate
        LocalDate
        $.data.processingPaths[].emvConfigurations[].capkeys[].value
        string
        $.data.processingPaths[].emvConfigurations[].rid
        string
        $.data.processingPaths[].identifier
        Unique identifier of the processing path.
        UUID
        (Example: 12345678-abcd-1234-abcd-1234567890ab)
        $.data.processingPaths[].mode
        Mode of processing path.
        { TEST | TEST_CONNECTOR | LIVE }
        $.data.processingPaths[].name
        The name of the processing path.
        string
        (Example: Default processing)
        $.data.processingPaths[].processingDetails
        $.data.processingPaths[].processingDetails.identifier
        Unique ID of the transaction processor. This information is for debugging purposes.
        string
        (Example: h987i654j321k098l765m432n210o987)
        $.data.processingPaths[].processingDetails.sessionCreated
        The 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.sessionIdentifier
        The session ID of the transaction processor. This information is for debugging purposes.
        string
        $.data.processingPaths[].processingDetails.status
        Processing status code, for example 000.000.000 for transaction succeeded. This information is for debugging purposes.
        string
        (Example: 000.000.000)
        $.data.processingPaths[].processingDetails.timestamp
        The 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.day
        short
        $.data.readers[].created.date.month
        short
        $.data.readers[].created.date.year
        int
        $.data.readers[].created.time
        $.data.readers[].created.time.hour
        byte
        $.data.readers[].created.time.minute
        byte
        $.data.readers[].created.time.nano
        int
        $.data.readers[].created.time.second
        byte
        $.data.readers[].details
        $.data.readers[].details.assignedConfigurationProfile
        The 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.hardwareRevision
        The 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.serialNo
        The serial number as printed on the back of the reader. Dashes are stripped from the serial number.
        string
        (Example: 006-123456)
        $.data.readers[].details.terminalIds
        The terminal IDs that have been assigned to the reader. Terminal IDs are used by the clearing institute to identify readers.
        Map
        $.data.readers[].status
        Current status of the reader
        { INACTIVE | ACTIVE | DEACTIVATED }
        $.status
        If the request was processed as planned, ok is returned. If the field is set to error, $.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.

      • post /v2/merchants/{merchantIdentifier}/processingPaths

        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.active
        Whether or not the processing path is active.
        boolean
        $.data.configuration
        $.data.configuration.allowSkippingStreetNo
        Boolean
        $.data.configuration.allowSkippingZipCode
        Boolean
        $.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.treatAmexStreetNumberCheckAsPassed
        Boolean
        $.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.details
        Map
        $.data.emvConfigurations[]
        $.data.emvConfigurations[].applications[]
        $.data.emvConfigurations[].applications[].aid
        string
        $.data.emvConfigurations[].applications[].contact
        EmvInterfaceConfigurationDto
        $.data.emvConfigurations[].applications[].contactless[]
        $.data.emvConfigurations[].applications[].contactless[].additionalApplicationVersions[]
        Array[String]
        $.data.emvConfigurations[].applications[].contactless[].applicationVersion
        string
        $.data.emvConfigurations[].applications[].contactless[].autoSelection
        boolean
        $.data.emvConfigurations[].applications[].contactless[].kernelId
        string
        $.data.emvConfigurations[].applications[].contactless[].priority
        Integer
        $.data.emvConfigurations[].applications[].contactless[].refund
        TransactionTypeEmvConfigurationDto
        $.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[].noCvmRequiredLimit
        BigDecimal
        $.data.emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].programId
        string
        $.data.emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].statusCheck
        boolean
        $.data.emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].transactionLimit
        BigDecimal
        $.data.emvConfigurations[].applications[].contactless[].sale.dynamicReaderLimits[].zeroAmountAllowed
        boolean
        $.data.emvConfigurations[].applications[].contactless[].sale.noCvmRequiredLimit
        BigDecimal
        $.data.emvConfigurations[].applications[].contactless[].sale.statusCheck
        Boolean
        $.data.emvConfigurations[].applications[].contactless[].sale.terminalActionCodes
        $.data.emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.defaultValue
        string
        $.data.emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.denial
        string
        $.data.emvConfigurations[].applications[].contactless[].sale.terminalActionCodes.online
        string
        $.data.emvConfigurations[].applications[].contactless[].sale.transactionLimit
        BigDecimal
        $.data.emvConfigurations[].applications[].contactless[].sale.transactionLimitCustomerDeviceCvm
        BigDecimal
        $.data.emvConfigurations[].applications[].contactless[].sale.zeroAmountAllowed
        Boolean
        $.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[].expiryDate
        LocalDate
        $.data.emvConfigurations[].capkeys[].exponent
        string
        $.data.emvConfigurations[].capkeys[].index
        string
        $.data.emvConfigurations[].capkeys[].modulusLength
        string
        $.data.emvConfigurations[].capkeys[].startDate
        LocalDate
        $.data.emvConfigurations[].capkeys[].value
        string
        $.data.emvConfigurations[].rid
        string
        $.data.identifier
        Unique identifier of the processing path.
        UUID
        (Example: 12345678-abcd-1234-abcd-1234567890ab)
        $.data.mode
        Mode of processing path.
        { TEST | TEST_CONNECTOR | LIVE }
        $.data.name
        The name of the processing path.
        string
        (Example: Default processing)
        $.data.processingDetails
        $.data.processingDetails.identifier
        Unique ID of the transaction processor. This information is for debugging purposes.
        string
        (Example: h987i654j321k098l765m432n210o987)
        $.data.processingDetails.sessionCreated
        The 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.day
        short
        $.data.processingDetails.sessionCreated.date.month
        short
        $.data.processingDetails.sessionCreated.date.year
        int
        $.data.processingDetails.sessionCreated.time
        $.data.processingDetails.sessionCreated.time.hour
        byte
        $.data.processingDetails.sessionCreated.time.minute
        byte
        $.data.processingDetails.sessionCreated.time.nano