PaymentMethodDto Data Type

The PaymentMethod Dto.

Subtypes
CardPaymentMethodDto
Implemented Interfaces
Serializable
Properties
name data type constraints description
paymentMethodType PaymentMethodEnum required PaymentMethod type.
id number   Entity id.
disabled boolean   Is payment method disabled.
alias string   Alias.
preferred boolean   Is it a preferred payment method
customerAccountCode string   Customer account code.
info1 string   Additional info1.
info2 string   Additional info2.
info3 string   Additional info3.
info4 string   Additional info4.
info5 string   Additional info5.
bankCoordinates BankCoordinatesDto   Bank account information.
mandateIdentification string   Mandate identification for SEPA.
mandateDate number   Mandate date for SEPA.
cardType CreditCardTypeEnum   Card type.
owner string   Cardholder: first and last name.
monthExpiration number   Card expiration: month.
yearExpiration number   Card expiration: year.
tokenId string   Token ID in a payment gateway.
cardNumber string   Card number: full number , with first 12 digits hiding in read operation.
issueNumber string   Issue number.
userId string   User identifier.
email string   Email.
referenceDocumentCode string   Document.
customFields CustomFieldsDto  

Example

{
  "paymentMethodType" : "CHECK",
  "id" : 12345,
  "disabled" : true,
  "alias" : "...",
  "preferred" : true,
  "customerAccountCode" : "...",
  "info1" : "...",
  "info2" : "...",
  "info3" : "...",
  "info4" : "...",
  "info5" : "...",
  "bankCoordinates" : {
    "bankCode" : "...",
    "branchCode" : "...",
    "accountNumber" : "...",
    "key" : "...",
    "iban" : "...",
    "bic" : "...",
    "accountOwner" : "...",
    "bankName" : "...",
    "bankId" : "...",
    "issuerNumber" : "...",
    "issuerName" : "...",
    "ics" : "..."
  },
  "mandateIdentification" : "...",
  "mandateDate" : 12345,
  "cardType" : "AMERICAN_EXPRESS",
  "owner" : "...",
  "monthExpiration" : 12345,
  "yearExpiration" : 12345,
  "tokenId" : "...",
  "cardNumber" : "...",
  "issueNumber" : "...",
  "userId" : "...",
  "email" : "...",
  "referenceDocumentCode" : "...",
  "customFields" : {
    "customField" : [ {
      "code" : "...",
      "description" : "...",
      "fieldType" : "BOOLEAN",
      "languageDescriptions" : [ { }, { } ],
      "valueDate" : 12345,
      "valuePeriodStartDate" : 12345,
      "valuePeriodEndDate" : 12345,
      "valuePeriodPriority" : 12345,
      "stringValue" : "...",
      "dateValue" : 12345,
      "longValue" : 12345,
      "doubleValue" : 12345.0,
      "booleanValue" : true,
      "value" : [ { }, { } ],
      "mapValue" : {
        "property1" : { },
        "property2" : { }
      },
      "entityReferenceValue" : { },
      "indexType" : "STORE_ONLY",
      "fileValue" : "...",
      "formattedValue" : { },
      "urlReferenceValue" : { },
      "guiPosition" : "...",
      "customTableCode" : "...",
      "dataFilter" : "...",
      "fields" : "..."
    }, {
      "code" : "...",
      "description" : "...",
      "fieldType" : "LIST",
      "languageDescriptions" : [ { }, { } ],
      "valueDate" : 12345,
      "valuePeriodStartDate" : 12345,
      "valuePeriodEndDate" : 12345,
      "valuePeriodPriority" : 12345,
      "stringValue" : "...",
      "dateValue" : 12345,
      "longValue" : 12345,
      "doubleValue" : 12345.0,
      "booleanValue" : true,
      "value" : [ { }, { } ],
      "mapValue" : {
        "property1" : { },
        "property2" : { }
      },
      "entityReferenceValue" : { },
      "indexType" : "STORE_ONLY",
      "fileValue" : "...",
      "formattedValue" : { },
      "urlReferenceValue" : { },
      "guiPosition" : "...",
      "customTableCode" : "...",
      "dataFilter" : "...",
      "fields" : "..."
    } ],
    "inheritedCustomField" : [ {
      "code" : "...",
      "description" : "...",
      "fieldType" : "MULTI_VALUE",
      "languageDescriptions" : [ { }, { } ],
      "valueDate" : 12345,
      "valuePeriodStartDate" : 12345,
      "valuePeriodEndDate" : 12345,
      "valuePeriodPriority" : 12345,
      "stringValue" : "...",
      "dateValue" : 12345,
      "longValue" : 12345,
      "doubleValue" : 12345.0,
      "booleanValue" : true,
      "value" : [ { }, { } ],
      "mapValue" : {
        "property1" : { },
        "property2" : { }
      },
      "entityReferenceValue" : { },
      "indexType" : "INDEX",
      "fileValue" : "...",
      "formattedValue" : { },
      "urlReferenceValue" : { },
      "guiPosition" : "...",
      "customTableCode" : "...",
      "dataFilter" : "...",
      "fields" : "..."
    }, {
      "code" : "...",
      "description" : "...",
      "fieldType" : "URL",
      "languageDescriptions" : [ { }, { } ],
      "valueDate" : 12345,
      "valuePeriodStartDate" : 12345,
      "valuePeriodEndDate" : 12345,
      "valuePeriodPriority" : 12345,
      "stringValue" : "...",
      "dateValue" : 12345,
      "longValue" : 12345,
      "doubleValue" : 12345.0,
      "booleanValue" : true,
      "value" : [ { }, { } ],
      "mapValue" : {
        "property1" : { },
        "property2" : { }
      },
      "entityReferenceValue" : { },
      "indexType" : "INDEX_NOT_ANALYZE",
      "fileValue" : "...",
      "formattedValue" : { },
      "urlReferenceValue" : { },
      "guiPosition" : "...",
      "customTableCode" : "...",
      "dataFilter" : "...",
      "fields" : "..."
    } ]
  }
}