Service: ExternalPaymentService

Version: 1_11 (other versions, change log, ZUMSTEIN_V4.4-SNAPSHOT) END OF LIFE. Please consider switching to the latest version of the webservices, because this version may be removed anytime from support.

SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnseb/external-remoting/com.secutix.service.realtime.externalpayment.v1_11.ExternalPaymentService.webservice?wsdl

To get the endpoint for your own institution, replace "myinstit" (just after https://) in the url by your own institution code.

For further documentation and examples, please check in Platform Website.external payment service interface v1_11 : web service exposed to external world

Methods:

cancelPayment

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

Parameters

requestIdInteger     
paymentIdLong     

Return value

WebMethodResult
requestIdInteger     
statusCodeString (8)     
statusDetailString     

checkPayment

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

Parameters

requestIdInteger     
orderIdLong     
paymentsList of PaymentInfo     

PaymentInfo
amountLong     
cardAliasString     
cardExpirationDateDate     
cardMaskedNumberString     
contactReferenceString (20)     
paymentIdentifierString     
paymentMethodIdLong     
pspAdditionalReturnedDataString     
valueDateDate     

Return value

PaymentDetailResult
paymentDetailsList of PaymentDetail     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

PaymentDetail
amountLong     
cardTypeString     
epcTransactionDataEpcTransactionData     
externalUrlString (255)     
paymentDateDate     
paymentIdLong     
paymentIdentifierString     
paymentMethodPaymentMethod     
paymentStatus(WAITING|IN_PROGRESS|
AUTHORIZED|PAID|
CANCELLED_BY_USER|FAILED|
ABANDONED)
     

EpcTransactionData
paymentTypesList of EpcPaymentType     
transactionIdint     

EpcPaymentType
cardNumberString     
cvvCodeString (8)     
expMonthString     
expYearString     
hiddenFieldsMap of StringString     
holderString     
paymentMethodsList of EpcPaymentMethod     
postUrlString (255)     

EpcPaymentMethod
cardValidationRegexString     
codeString (8)     
cvvLegnthint     
isCvvMandatoryboolean     

PaymentMethod
changeReturnAllowedBoolean     
codeString (8)     
externalNameExternalName60 characters max for each translation
idLong     
inSplitPaymentAllowedBoolean     
internetCodeString (8)     
paymentType(NUM|CHEQ|CHEQCANCEL|CB|
CBCANCEL|PREPAY|VIR|AVR|
COUPON|VOUCHER|CTRM|EXT|
CA|BVR|INV|CANOAUTH|
DEPOSIT|SAPBTRANSF|
FIDELITY_POINT)
     
tooMuchPerceivedAllowedBoolean     
withFollowUpBoolean     

ExternalName
translationsList of Translation     

Translation
localeString (2)     
valueString     

createPayment

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

Creates a payments from the given payment info and parameters. Payment parameters clarifications: either the contactId or the contactNumber must be provided. If the contactId field is given, it will be used. Else the contactNumber field will be used. Either a list of operationIds must be provided or an orderId. If the operationIds list is given, those operations will be used. Otherwise all the operations of the order with the given orderId will be used.

Parameters

requestIdInteger     
orderIdLong     
paymentsList of PaymentInfo     
paymentParamsPaymentParameters     

PaymentParameters
contactIdLong     
contactNumberString (20)     
creditWaitingAccountPaymentboolean     
operationIdsList of Long     
orderIdLong     
paymentParametersMapMap of (RETURN_URL|
ORDER_IDENTIFIER), String
     
pointOfSalesIdLong     
remarkString     
totalAmountLong     

Return value

PaymentDetailResult

getPaymentDetails

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

Get payment details for payments with the given payment id and/or payments linked to the given order id, or linked to the given operation ids

Parameters

requestIdInteger     
paymentIdLong     
orderIdLong     
operationIdsList of Long     

Return value

PaymentDetailResult

getPossiblePayerContacts

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

Parameters

requestIdInteger     
orderIdsList of Long     
contactNumbersList of String     

Return value

PossiblePayerContactsResult
contactsList of ContactData     
requestIdInteger     
statusCodeString (8)     
statusDetailString     

ContactData
Class containing the beneficiary data :
  • contactReference, optional: the secutix contact number
  • firstName, optional: beneficiary first name
  • lastName, optional: beneficiary last name
  • email, optional: beneficiary email
  • birthday, optional: beneficiary birthday
  • firstAddressLine, optional: first address line
  • secondAddressLine, optional: second address line
  • thirdAddressLine, optional: third address line
  • zipCode, optional: address zip code
  • locality, optional: address locality
  • countryCode, optional: address country code
  • phone, optional: beneficary phone number
  • mobilePhone, optional: beneficary mobile phone number
  • contactId, optional: the contact internal id
  • invoiceAddressId, optional: the contact address internal id
  • idNumber, optional: To store beneficiary id number like passport number.
answerQuestionnaireAnswerQuestionnaire     
birthdayDate     
contactIdLong     
contactReferenceString (20)     
countryCodeString (8)     
emailString     
firstAddressLineString     
firstNameString     
idNumberString     
invoiceAddressIdLong     
lastNameString     
localityString     
mobilePhoneString     
phoneString     
secondAddressLineString     
structureOfficialNameString     
thirdAddressLineString     
zipCodeString (8)     

AnswerQuestionnaire
answerQuestionsList of AnswerQuestion     
ticketIdLong     

AnswerQuestion
answerCodesList of String     
questionCodeString (8)     

isExternalPaymentServiceAlive

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

validate network connection and login/password

Parameters

Return value

WebMethodResult

notifyPayment

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

Parameters

requestIdInteger     
paymentIdLong     
maxWaitingTimeLong     

Return value

WebMethodResult

updatePayments

REST_RPCMOSACUBEPLAY
SOAPMOSACUBEPLAY

Parameters

requestIdInteger     
orderIdLong     
paymentsList of PaymentDetail     

Return value

PaymentDetailResult