Skip to main content

Payout

POST 
/transaction/:apiKey/payout

A payout transaction credits the customer's account with the given amount.

Depending on the connector, either referenceUuid or transactionToken will be required.

note

This transaction method is only available for certain connectors and must be explicitly enabled by your integration engineer.

Request​

Path Parameters

    apiKey stringrequired

    Possible values: <= 50 characters

    API Key of Connector

Body

required

Data which is required to process a payout

    merchantTransactionId MerchantTransactionId (string)required

    A unique identifier supplied by the merchant to track transactions within their own systems.

    This field links the platform’s transaction back to the merchant’s system, allowing for easy tracking and reconciliation. Note that while this ID is used within the platform, there is no guarantee that it will be forwarded to the Payment Service Provider (PSP).

    Possible values: non-empty and <= 50 characters

    Example: c5f2accd-2c37-4b2c-bb03-22d168c25a74
    additionalId1 AdditionalId1 (string)

    A supplementary identifier dependent on the used adapter.

    This field provides additional information that can be used based on the specific adapter and their field mappings. The usage of additionalId1 is contingent upon the support provided by the PSP, which is detailed in the adapter-specific documentation. If this field is supported, its proper usage will be outlined there. If it is not mentioned, it should not be used to avoid integration issues. Always refer to the adapter-specific documentation for guidance on using this additional identifier correctly.

    Possible values: non-empty and <= 50 characters

    additionalId2 AdditionalId2 (string)

    A supplementary identifier dependent on the used adapter.

    This field provides additional information that can be used based on the specific adapter and their field mappings. The usage of additionalId2 is contingent upon the support provided by the PSP, which is detailed in the adapter-specific documentation. If this field is supported, its proper usage will be outlined there. If it is not mentioned, it should not be used to avoid integration issues. Always refer to the adapter-specific documentation for guidance on using this additional identifier correctly.

    Possible values: non-empty and <= 50 characters

    extraData

    object

    Object containing key-value pairs (string-to-string), to be used by either the upstream Adapter, the Risk Engine etc.

    Possible values: <= 64.
    Property name: <= 64 characters.
    Property value: <= 8192 characters.

    property name* string

    pspPassthroughData

    object

    Object containing key-value pars (string-to-string) to be passed to the PSP.

    Possible values: <= 64.
    Property name: <= 64 characters.
    Property value: <= 8192 characters.

    property name* string
    merchantMetaData string

    Possible values: <= 255 characters

    referenceUuid string

    Possible values: non-empty and <= 50 characters

    amount Amount (string)required

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    currency Currency (string)required

    ISO 4217 three-letter currency code.

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Example: EUR
    successUrl uri

    Possible values: <= 4096 characters

    cancelUrl uri

    Possible values: <= 4096 characters

    errorUrl uri

    Possible values: <= 4096 characters

    callbackUrl uri

    Possible values: <= 4096 characters

    transactionToken string

    Possible values: <= 8192 characters

    description string

    Possible values: <= 255 characters

    items

    object[]

    List of items sold.

    Maximum JSON size: <= 32768 bytes.

    Possible values: <= 128

  • Array [

    • identification string

    Possible values: <= 128 characters

    name string

    Possible values: <= 256 characters

    description string

    Possible values: <= 2048 characters

    quantity integer

    Possible values: >= 1

    price integer

    Possible values: >= 1

    currency Currency (string)

    ISO 4217 three-letter currency code.

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Example: EUR

    l2l3Data

    object

    type string

    Possible values: <= 32 characters

    unit string

    Possible values: <= 16 characters

    unitPrice Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    discount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    shippingAmount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    taxAmount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    taxRate Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    commodityCode string

    Possible values: <= 64 characters

    taxDetails

    object[]

    Possible values: <= 10

  • Array [

    • type string

    Possible values: <= 255 characters

    amount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    rate Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    code string

    Possible values: <= 255 characters

    taxId string

    Possible values: <= 255 characters

    applied string

    Possible values: <= 255 characters

    exemptionCode string

    Possible values: <= 255 characters

  • ]

    • extraData

    object

    Object containing key-value pairs (string-to-string), to be used by either the upstream Adapter, the Risk Engine etc.

    Possible values: <= 64.
    Property name: <= 64 characters.
    Property value: <= 8192 characters.

    property name* string

  • ]

    • splits

    object[]

    Possible values: <= 10

  • Array [

    • identification string

    Possible values: <= 11 characters

    amount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    currency Currency (string)

    ISO 4217 three-letter currency code.

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Example: EUR
    sellerMerchantGuid string

    Possible values: <= 11 characters

    sellerMerchantExternalId string

    Possible values: <= 128 characters

    commissionFee

    object

    amount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    currency Currency (string)

    ISO 4217 three-letter currency code.

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Example: EUR

  • ]

    • customer

    object

    Information on the customer making a payment.

    Strive to include as much information as possible. This reduces friction and provides the most benefit for risk checks, 3D-secure authentication and other validations.

    identification string

    Possible values: <= 36 characters

    firstName string

    First name of the customer.

    Possible values: <= 50 characters

    lastName string

    Last name of the customer.

    Possible values: <= 50 characters

    birthDate date (string)

    RFC 3339 Internet Date/Time Format full-date.

    Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))$

    Example: 2001-02-03
    gender string

    Gender of the customer.

    Possible values: [M, F]

    billingAddress1 string

    Line one of the customer's billing address.

    Possible values: <= 50 characters

    billingAddress2 string

    Line two of the customer's billing address.

    Possible values: <= 50 characters

    billingCity string

    City of the customer's billing address.

    Possible values: <= 50 characters

    billingPostcode string

    Postal code of the customer's billing address.

    Possible values: <= 16 characters

    billingState string

    State of the customer's billing address.

    Possible values: <= 30 characters

    billingCountry Country (string)

    ISO 3166-1 alpha-2 country code.

    Possible values: Value must match regular expression ^[A-Z]{2}$

    Example: AT
    billingPhone string

    Possible values: <= 20 characters

    Example: +XX 1234567890
    shippingFirstName string

    Possible values: <= 50 characters

    shippingLastName string

    Possible values: <= 50 characters

    shippingCompany string

    Possible values: <= 50 characters

    shippingAddress1 string

    Possible values: <= 50 characters

    shippingAddress2 string

    Possible values: <= 50 characters

    shippingCity string

    Possible values: <= 50 characters

    shippingPostcode string

    Possible values: <= 16 characters

    shippingState string

    Possible values: <= 30 characters

    shippingCountry Country (string)

    ISO 3166-1 alpha-2 country code.

    Possible values: Value must match regular expression ^[A-Z]{2}$

    Example: AT
    shippingPhone string

    Possible values: <= 20 characters

    Example: +XX 1234567890
    company string

    Possible values: <= 50 characters

    email string

    Possible values: <= 255 characters

    emailVerified boolean
    ipAddress string

    Possible values: <= 50 characters

    nationalId string

    Possible values: <= 20 characters

    extraData

    object

    Object containing key-value pairs (string-to-string), to be used by either the upstream Adapter, the Risk Engine etc.

    Possible values: <= 64.
    Property name: <= 64 characters.
    Property value: <= 8192 characters.

    property name* string

    paymentData

    object

    oneOf

    ibanData

    object

    iban string

    Possible values: <= 34 characters

    bic string

    Possible values: <= 11 characters

    mandateId string

    Possible values: <= 50 characters

    mandateDate date (string)

    RFC 3339 Internet Date/Time Format full-date.

    Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))$

    Example: 2001-02-03

    payByLink

    object

    Enable generating a link that can be sent to a customer to complete a purchase.

    sendByEmail booleanrequired

    If true send the generated payment link to the customer via email.

    The email specified in customer.email is used as recipient.

    expirationInMinute int32

    The generated payment link will expire after the duration specified via this field.

    Possible values: >= 1

    Example: 1441
    language string

    Possible values: >= 2 characters and <= 2 characters

    transactionIndicator string

    Possible values: [SINGLE, INITIAL, RECURRING, CARDONFILE, CARDONFILE-MERCHANT-INITIATED, MOTO]

    l2l3Data

    object

    Level 2 & level 3 data.

    taxAmount string

    Possible values: <= 15 characters

    vatRegistrationNumber string

    Possible values: <= 255 characters

    nationalTaxIncluded string

    Possible values: <= 5 characters

    discountAmount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    commodityCode string

    Possible values: <= 255 characters

    freightAmount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    freightTaxAmount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    dutyAmount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99

    taxDetails

    object[]

    Possible values: <= 10

  • Array [

    • type string

    Possible values: <= 255 characters

    amount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    rate Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    code string

    Possible values: <= 255 characters

    taxId string

    Possible values: <= 255 characters

    applied string

    Possible values: <= 255 characters

    exemptionCode string

    Possible values: <= 255 characters

  • ]

Responses​

Transaction response

Schema

    success

    string

    required

    Returns true or false depending on whether the request was successful.

    Possible values: [true, false]

    success booleanrequired

    Returns true or false depending on whether the request was successful.

    uuid string

    UUID of the transaction.

    purchaseId string

    Purchase ID of the transaction.

    returnType string

    Depending on the returnType a transaction is finished, intermediate, or failed.

    • FINISHED

      The transaction completed and was processed successfully. You can deliver the ordered goods.

    • ERROR

      The transaction failed or was declined. See the error code and message for further details.

      You will find the native error message and code from the payment provider/acquiring bank in the fields adapterMessage and adapterCode.

      Note: Merchant Advice Code

      When supported by an adapter implementation, a merchant advice code can be returned with the ReturnData.

      This code is piped through as received by the gateway.

      If a merchant advice code indicating a hard "do not retry" is returned, the value "doNotResubmit": true will additionally be returned with the error response extra data.

    • REDIRECT

      You must redirect the user to the URL defined in redirectUrl to proceed with the transaction. Afterwards the user will be back redirected to your website (one of the URLs you defined in the API call in successUrl, cancelUrl or errorUrl). In parallel the sends a status notification to you callbackUrl with the final result.

      Note:

      For the final result you should only trust the notification, NOT the back redirection!

    • PENDING

      The transaction was accepted for processing, but is not yet completed. You will receive a status notification to the URL you defined in callbackUrl once it reaches a final state.

      Depending on the payment method, this can take from seconds up to several days.

    Possible values: [FINISHED, REDIRECT, HTML, PENDING, ERROR, PENDING_DCC]

    redirectType string

    Depending on the redirectType the URL from redirectUrl should be displayed either in an <iframe>, in a full page (e.g. via a HTTP 302 redirect with a Location header).

    Possible values: [iframe, fullpage]

    redirectUrl uri

    URL the customer must be redirected to, only set if "returnType": "REDIRECT".

    Possible values: <= 255 characters

    redirectQRCode string

    QR Code with redirectUrl base64 encoded.

    htmlContent string

    HTML content the customer must be shown, only set if "returnType": "HTML".

    paymentDescriptor string
    paymentMethod string

    Payment method used - if it has already been determined.

    returnData

    object

    _TYPE

    string

    required

    Possible values: [cardData, phoneData, ibanData, walletData, achData]

    type string

    Type of credit card

    firstName string
    lastName string
    country Country (string)

    ISO 3166-1 alpha-2 country code.

    Possible values: Value must match regular expression ^[A-Z]{2}$

    Example: AT
    cardHolder string
    expiryMonth string

    Possible values: Value must match regular expression ^((0[1-9])|(1[0-2]))$

    expiryYear string

    Possible values: Value must match regular expression ^[0-9]{4}$

    binDigits string

    Possible values: Value must match regular expression ^[0-9]{6-8}$

    firstSixDigits string

    Possible values: Value must match regular expression ^[0-9]{6}$

    lastFourDigits string

    Possible values: Value must match regular expression ^[0-9]{4}$

    fingerprint string
    binBrand string
    binBank string
    binType string
    binLevel string
    binCountry string
    threeDSecure ThreeDSecureType (string)

    Triggers the 3D Secure authentication for this transaction.

    Possible values: [OFF, OPTIONAL, MANDATORY]

    eci string
    merchantAdviceCode string

    Pipes through the merchant advice code for failed transactions if supported by the adapter.

    parsedMerchantAdviceCode string

    Merchant advice code for failed transactions if supported by the adapter.

    • 01 - Additional information needed.
    • 02 - Try again later.
    • 03 - Do not try again.

    Possible values: [01, 02, 03]

    schemeTransactionIdentifier string

    The schemeTransactionIdentifier, is a unique reference generated by a card scheme. It serves the purpose of traceability back to the initial transaction.

    It is also referred to as the 'scheme reference ID,' 'scheme transaction ID,' 'trace ID' (for Mastercard), or 'transaction ID' (for VISA).

    cardUpdateStatus stringnullable

    Status of the last account updater run.

    Only non-null if the account updater is enabled and has run at least once.

    Possible values: [updated, contact, new-expiry, closed]

    cardUpdatedAt date (string)nullable

    Last run of the account updater.

    Only non-null if the account updater is enabled and has run at least once. RFC 3339 Internet Date/Time Format full-date.

    Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))$

    Example: 2001-02-03

    scheduleData

    object

    scheduleId string

    ID of schedule which was started with the transaction.

    scheduleStatus ScheduleStatus (string)

    Status of the schedule.

    Possible values: [ACTIVE, PAUSED, CANCELLED, ERROR, CREATE-PENDING, NON-EXISTING]

    scheduledAt date-time

    RFC 3339 Internet Date/Time Format date-time

    Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$

    Example: 2001-02-03T04:05:06+02:00
    merchantMetaData string
    property name* any

    customerProfileData

    object

    profileGuid string

    The unique customer profile identifier generated by the platform.

    customerIdentification string

    The customer profile identifier provided by you when creating the customer profile. Unique within one customer profile container.

    paymentToken string

    The created payment instrument for the customer profile, use with transactionToken when creating new transactions.

    markAsPreferred boolean

    Whether this payment instrument was marked as preferred for the customer.

    property name* any

    riskCheckData

    object

    riskCheckResult string

    Possible values: [APPROVED, DECLINED, REVIEW]

    riskScore number
    threeDSecureRequired boolean
    property name* any

    errors

    object[]

  • Array [

    • errorMessage string

    Error message.

    While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage.

    errorCode int32

    Error code.

    For a complete list of error codes and their meanings, please see the appendix on Error codes.

    adapterMessage stringnullable

    Adapter specific error message, passed verbatim from the upstream Adapter.

    adapterCode stringnullable

    Adapter specific error code, passed verbatim from the upstream Adapter.

  • ]

    • adapterMessage string
    adapterCode string

    extraData

    object

    Object containing key-value pairs (string-to-string), to be used by either the upstream Adapter, the Risk Engine etc.

    Possible values: <= 64.
    Property name: <= 64 characters.
    Property value: <= 8192 characters.

    property name* string

    dccData

    object

    uuid string
    originalAmount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    originalCurrency Currency (string)

    ISO 4217 three-letter currency code.

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Example: EUR
    convertedAmount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    convertedCurrency Currency (string)

    ISO 4217 three-letter currency code.

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Example: EUR
    conversionRate number
    disclaimer string
    property name* any

    payByLinkData

    object

    payByLink booleandeprecated

    true if this transaction was a Pay-by-Link transaction.

    sendViaEmail boolean

    true if this Pay-by-Link was sent to the transaction customer via email.

    cancelUrl uri

    Endpoint to call to cancel a Pay-by-Link transaction.

    For details, see Pay-by-Link API reference.

    expiresAt date-time

    Indicates at what date time the Pay-by-Link transaction expires.

    property name* any
    property name* any

Callbacks​

POST 
{$request.body#/callbackUrl}

Receive status updates about transactions.

Status changes are posted as callbacks to the callbackUrl defined in the request. See the Callbacks reference for further information about callbacks.

Body

required

The current state of the transaction.

    uuid string

    UUID of the transaction.

    merchantTransactionId MerchantTransactionId (string)

    A unique identifier supplied by the merchant to track transactions within their own systems.

    This field links the platform’s transaction back to the merchant’s system, allowing for easy tracking and reconciliation. Note that while this ID is used within the platform, there is no guarantee that it will be forwarded to the Payment Service Provider (PSP).

    Possible values: non-empty and <= 50 characters

    Example: c5f2accd-2c37-4b2c-bb03-22d168c25a74
    purchaseId string

    Purchase ID of the transaction.

    Possible values: <= 50 characters

    transactionType TransactionType (string)

    Possible values: [DEBIT, CAPTURE, DEREGISTER, PREAUTHORIZE, REFUND, REGISTER, VOID, CHARGEBACK, CHARGEBACK-REVERSAL, PAYOUT, INCREMENTAL-AUTHORIZATION]

    transactionSubType TransactionSubType (string)

    Only present if transaction has a subType.

    Possible values: [cb-resolved, cb-reversal-resolved]

    paymentMethod string

    Payment method.

    amount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    currency Currency (string)

    ISO 4217 three-letter currency code.

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Example: EUR
    surchargeAmount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    totalAmount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99

    dccData

    object

    remoteIdentifier string

    Possible values: <= 128 characters

    originalAmount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    originalCurrency Currency (string)

    ISO 4217 three-letter currency code.

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Example: EUR
    convertedAmount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    convertedCurrency Currency (string)

    ISO 4217 three-letter currency code.

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Example: EUR
    conversionRate number
    selectedCurrency string

    Possible values: <= 32 characters

    markUp number
    referenceUuid string

    Possible values: non-empty and <= 50 characters

    errors

    object[]

  • Array [

    • message string

    Error message.

    While the message field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the code field, not the message.

    code string

    Error code.

    For a complete list of error codes and their meanings, please see the appendix on Error codes.

    adapterMessage stringnullable

    Adapter specific error message, passed verbatim from the upstream Adapter.

    adapterCode stringnullable

    Adapter specific error code, passed verbatim from the upstream Adapter.

  • ]

    • chargebackData

    object

    When transactionType is CHARGEBACK this field contains information on the chargeback.

    originalUuid string
    originalMerchantTransactionId string

    Possible values: non-empty and <= 50 characters

    amount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    currency Currency (string)

    ISO 4217 three-letter currency code.

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Example: EUR
    reason string
    chargebackDateTime date-time

    RFC 3339 Internet Date/Time Format date-time

    Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$

    Example: 2001-02-03T04:05:06+02:00
    property name* any

    When transactionType is CHARGEBACK this field contains information on the chargeback.

    chargebackReversalData

    object

    When transactionType is CHARGEBACK-REVERSAL this field contains information on the chargeback-reversal.

    originalUuid string
    originalMerchantTransactionId string

    Possible values: non-empty and <= 50 characters

    chargebackUuid string
    amount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    currency Currency (string)

    ISO 4217 three-letter currency code.

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Example: EUR
    reason string
    reversalDateTime date-time

    RFC 3339 Internet Date/Time Format date-time

    Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$

    Example: 2001-02-03T04:05:06+02:00
    property name* any

    When transactionType is CHARGEBACK-REVERSAL this field contains information on the chargeback-reversal.

    extraData

    object

    Object containing key-value pairs (string-to-string), to be used by either the upstream Adapter, the Risk Engine etc.

    Possible values: <= 64.
    Property name: <= 64 characters.
    Property value: <= 8192 characters.

    property name* string
    merchantMetaData string

    returnData

    object

    _TYPE

    string

    required

    Possible values: [cardData, phoneData, ibanData, walletData, achData]

    type string

    Type of credit card

    firstName string
    lastName string
    country Country (string)

    ISO 3166-1 alpha-2 country code.

    Possible values: Value must match regular expression ^[A-Z]{2}$

    Example: AT
    cardHolder string
    expiryMonth string

    Possible values: Value must match regular expression ^((0[1-9])|(1[0-2]))$

    expiryYear string

    Possible values: Value must match regular expression ^[0-9]{4}$

    binDigits string

    Possible values: Value must match regular expression ^[0-9]{6-8}$

    firstSixDigits string

    Possible values: Value must match regular expression ^[0-9]{6}$

    lastFourDigits string

    Possible values: Value must match regular expression ^[0-9]{4}$

    fingerprint string
    binBrand string
    binBank string
    binType string
    binLevel string
    binCountry string
    threeDSecure ThreeDSecureType (string)

    Triggers the 3D Secure authentication for this transaction.

    Possible values: [OFF, OPTIONAL, MANDATORY]

    eci string
    merchantAdviceCode string

    Pipes through the merchant advice code for failed transactions if supported by the adapter.

    parsedMerchantAdviceCode string

    Merchant advice code for failed transactions if supported by the adapter.

    • 01 - Additional information needed.
    • 02 - Try again later.
    • 03 - Do not try again.

    Possible values: [01, 02, 03]

    schemeTransactionIdentifier string

    The schemeTransactionIdentifier, is a unique reference generated by a card scheme. It serves the purpose of traceability back to the initial transaction.

    It is also referred to as the 'scheme reference ID,' 'scheme transaction ID,' 'trace ID' (for Mastercard), or 'transaction ID' (for VISA).

    cardUpdateStatus stringnullable

    Status of the last account updater run.

    Only non-null if the account updater is enabled and has run at least once.

    Possible values: [updated, contact, new-expiry, closed]

    cardUpdatedAt date (string)nullable

    Last run of the account updater.

    Only non-null if the account updater is enabled and has run at least once. RFC 3339 Internet Date/Time Format full-date.

    Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))$

    Example: 2001-02-03

    payByLinkData

    object

    payByLink booleandeprecated

    true if this transaction was a Pay-by-Link transaction.

    sendViaEmail boolean

    true if this Pay-by-Link was sent to the transaction customer via email.

    cancelUrl uri

    Endpoint to call to cancel a Pay-by-Link transaction.

    For details, see Pay-by-Link API reference.

    expiresAt date-time

    Indicates at what date time the Pay-by-Link transaction expires.

    property name* any

    customer

    object

    identification string

    Possible values: <= 36 characters

    firstName string

    Possible values: <= 50 characters

    lastName string

    Possible values: <= 50 characters

    birthDate date (string)

    RFC 3339 Internet Date/Time Format full-date.

    Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))$

    Example: 2001-02-03
    gender string

    Possible values: [M, F]

    billingAddress1 string

    Possible values: <= 50 characters

    billingAddress2 string

    Possible values: <= 50 characters

    billingCity string

    Possible values: <= 50 characters

    billingPostcode string

    Possible values: <= 16 characters

    billingState string

    Possible values: <= 30 characters

    billingCountry Country (string)

    ISO 3166-1 alpha-2 country code.

    Possible values: Value must match regular expression ^[A-Z]{2}$

    Example: AT
    billingPhone string

    Possible values: <= 20 characters

    Example: +XX 1234567890
    shippingFirstName string

    Possible values: <= 50 characters

    shippingLastName string

    Possible values: <= 50 characters

    shippingCompany string

    Possible values: <= 50 characters

    shippingAddress1 string

    Possible values: <= 50 characters

    shippingAddress2 string

    Possible values: <= 50 characters

    shippingCity string

    Possible values: <= 50 characters

    shippingPostcode string

    Possible values: <= 16 characters

    shippingState string

    Possible values: <= 30 characters

    shippingCountry Country (string)

    ISO 3166-1 alpha-2 country code.

    Possible values: Value must match regular expression ^[A-Z]{2}$

    Example: AT
    shippingPhone string

    Possible values: <= 20 characters

    Example: +XX 1234567890
    company string

    Possible values: <= 50 characters

    email string

    Possible values: <= 255 characters

    emailVerified boolean
    ipAddress string

    Possible values: <= 50 characters

    nationalId string

    Possible values: <= 20 characters

    extraData

    object

    Object containing key-value pairs (string-to-string), to be used by either the upstream Adapter, the Risk Engine etc.

    Possible values: <= 64.
    Property name: <= 64 characters.
    Property value: <= 8192 characters.

    property name* string

    paymentData

    object

    oneOf

    ibanData

    object

    iban string

    Possible values: <= 34 characters

    bic string

    Possible values: <= 11 characters

    mandateId string

    Possible values: <= 50 characters

    mandateDate date (string)

    RFC 3339 Internet Date/Time Format full-date.

    Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))$

    Example: 2001-02-03
    property name* any

    customerProfileData

    object

    profileGuid string

    The unique customer profile identifier generated by the platform.

    customerIdentification string

    The customer profile identifier provided by you when creating the customer profile. Unique within one customer profile container.

    paymentToken string

    The created payment instrument for the customer profile, use with transactionToken when creating new transactions.

    markAsPreferred boolean

    Whether this payment instrument was marked as preferred for the customer.

    property name* any

    splits

    object[]

    Possible values: <= 10

  • Array [

    • identification string

    Possible values: <= 11 characters

    amount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    currency Currency (string)

    ISO 4217 three-letter currency code.

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Example: EUR
    sellerMerchantGuid string

    Possible values: <= 11 characters

    sellerMerchantExternalId string

    Possible values: <= 128 characters

    commissionFee

    object

    amount Amount (string)

    Decimal amount separated by ., maximum of 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    Example: 9.99
    currency Currency (string)

    ISO 4217 three-letter currency code.

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Example: EUR
    property name* any

  • ]

    • message string

    Error message.

    While the message field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the code field, not the message.

    code string

    Error code.

    For a complete list of error codes and their meanings, please see the appendix on Error codes.

    adapterMessage stringnullable

    Adapter specific error message, passed verbatim from the upstream Adapter.

    adapterCode stringnullable

    Adapter specific error code, passed verbatim from the upstream Adapter.

    result string

    Possible values: [OK, PENDING, ERROR]

    scheduleData

    object[]

  • Array [

    • scheduleId string

    ID of schedule which was started with the transaction.

    scheduleStatus ScheduleStatus (string)

    Status of the schedule.

    Possible values: [ACTIVE, PAUSED, CANCELLED, ERROR, CREATE-PENDING, NON-EXISTING]

    scheduledAt date-time

    RFC 3339 Internet Date/Time Format date-time

    Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$

    Example: 2001-02-03T04:05:06+02:00
    merchantMetaData string

  • ]

    • notificationSource string

    In case the transaction status, amount or currency has been changed after reconciliation the parameter can have the following value: reconciliation, settlement.

    Possible values: [reconciliation, settlement]

    originalAmount string

    In case the transaction amount has been changed after reconciliation the is parameter will contain the original amount. Decimals separated by ., max. 3 decimals.

    Possible values: Value must match regular expression ^(([0-9]{1,10})|([0-9]{1,10}\.[0-9]{1,3}))$

    originalCurrency string

    In case the transaction currency has been changed after reconciliation the is parameter will contain the original currency.

    ISO 4217 three-letter currency code.

    Possible values: Value must match regular expression ^[A-Z]{3}$

    Example: EUR

Callbacks Responses​

Reply with status 200 and body OK if you have received the callback successfully.

Schema

    string

    Possible values: [OK]

Loading...
Last updated on