Package com.onlinepayments.domain

Class OrderReferences

java.lang.Object
com.onlinepayments.domain.OrderReferences
public class OrderReferences extends Object

  • Constructor Summary

    Constructors
    Constructor
    Description
    OrderReferences()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescriptor()
    Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer.
    String
    getMerchantParameters()
    It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications.
    String
    getMerchantReference()
    Your unique reference of the transaction that is also returned in our report files.
    void
    setDescriptor(String value)
    Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer.
    void
    setMerchantParameters(String value)
    It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications.
    void
    setMerchantReference(String value)
    Your unique reference of the transaction that is also returned in our report files.
    OrderReferences
    withDescriptor(String value)
    Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer.
    OrderReferences
    withMerchantParameters(String value)
    It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications.
    OrderReferences
    withMerchantReference(String value)
    Your unique reference of the transaction that is also returned in our report files.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • OrderReferences

      public OrderReferences()

  • Method Details

    • getDescriptor

      public String getDescriptor()
      Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor. The maximum allowed length varies per card acquirer:
      • AIB - 22 characters
      • American Express - 25 characters
      • Atos Origin BNP - 15 characters
      • Barclays - 25 characters
      • Catella - 22 characters
      • CBA - 20 characters
      • Elavon - 25 characters
      • First Data - 25 characters
      • INICIS (INIPAY) - 22-30 characters
      • JCB - 25 characters
      • Merchant Solutions - 22-25 characters
      • Payvision (EU & HK) - 25 characters
      • SEB Euroline - 22 characters
      • Sub1 Argentina - 15 characters
      • Wells Fargo - 25 characters Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers will start to truncate. We currently also only allow per API call overrides for AIB and Barclays For alternative payment products the maximum allowed length varies per payment product:
      • 402 e-Przelewy - 30 characters
      • 404 INICIS - 80 characters
      • 802 Nordea ePayment Finland - 234 characters
      • 809 iDeal - 32 characters
      • 836 SOFORT - 42 characters
      • 840 PayPal - 127 characters
      • 841 WebMoney - 175 characters
      • 849 Yandex - 64 characters
      • 861 Alipay - 256 characters
      • 863 WeChat Pay - 32 characters
      • 880 BOKU - 20 characters
      • 8580 Qiwi - 255 characters
      • 1504 Konbini - 80 characters All other payment products do not support a descriptor.

    • setDescriptor

      public void setDescriptor(String value)
      Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor. The maximum allowed length varies per card acquirer:
      • AIB - 22 characters
      • American Express - 25 characters
      • Atos Origin BNP - 15 characters
      • Barclays - 25 characters
      • Catella - 22 characters
      • CBA - 20 characters
      • Elavon - 25 characters
      • First Data - 25 characters
      • INICIS (INIPAY) - 22-30 characters
      • JCB - 25 characters
      • Merchant Solutions - 22-25 characters
      • Payvision (EU & HK) - 25 characters
      • SEB Euroline - 22 characters
      • Sub1 Argentina - 15 characters
      • Wells Fargo - 25 characters Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers will start to truncate. We currently also only allow per API call overrides for AIB and Barclays For alternative payment products the maximum allowed length varies per payment product:
      • 402 e-Przelewy - 30 characters
      • 404 INICIS - 80 characters
      • 802 Nordea ePayment Finland - 234 characters
      • 809 iDeal - 32 characters
      • 836 SOFORT - 42 characters
      • 840 PayPal - 127 characters
      • 841 WebMoney - 175 characters
      • 849 Yandex - 64 characters
      • 861 Alipay - 256 characters
      • 863 WeChat Pay - 32 characters
      • 880 BOKU - 20 characters
      • 8580 Qiwi - 255 characters
      • 1504 Konbini - 80 characters All other payment products do not support a descriptor.

    • withDescriptor

      public OrderReferences withDescriptor(String value)
      Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor. The maximum allowed length varies per card acquirer:
      • AIB - 22 characters
      • American Express - 25 characters
      • Atos Origin BNP - 15 characters
      • Barclays - 25 characters
      • Catella - 22 characters
      • CBA - 20 characters
      • Elavon - 25 characters
      • First Data - 25 characters
      • INICIS (INIPAY) - 22-30 characters
      • JCB - 25 characters
      • Merchant Solutions - 22-25 characters
      • Payvision (EU & HK) - 25 characters
      • SEB Euroline - 22 characters
      • Sub1 Argentina - 15 characters
      • Wells Fargo - 25 characters Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers will start to truncate. We currently also only allow per API call overrides for AIB and Barclays For alternative payment products the maximum allowed length varies per payment product:
      • 402 e-Przelewy - 30 characters
      • 404 INICIS - 80 characters
      • 802 Nordea ePayment Finland - 234 characters
      • 809 iDeal - 32 characters
      • 836 SOFORT - 42 characters
      • 840 PayPal - 127 characters
      • 841 WebMoney - 175 characters
      • 849 Yandex - 64 characters
      • 861 Alipay - 256 characters
      • 863 WeChat Pay - 32 characters
      • 880 BOKU - 20 characters
      • 8580 Qiwi - 255 characters
      • 1504 Konbini - 80 characters All other payment products do not support a descriptor.

    • getMerchantParameters

      public String getMerchantParameters()
      It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications. This field must not contain any personal data.

    • setMerchantParameters

      public void setMerchantParameters(String value)
      It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications. This field must not contain any personal data.

    • withMerchantParameters

      public OrderReferences withMerchantParameters(String value)
      It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications. This field must not contain any personal data.

    • getMerchantReference

      public String getMerchantReference()
      Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files. It is highly recommended to provide a single MerchantReference per unique order on your side

    • setMerchantReference

      public void setMerchantReference(String value)
      Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files. It is highly recommended to provide a single MerchantReference per unique order on your side

    • withMerchantReference

      public OrderReferences withMerchantReference(String value)
      Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files. It is highly recommended to provide a single MerchantReference per unique order on your side