| URL: | ||
| JWT Token | ||
| Template: | ||
| cURL: |
Version: 1_33 (other versions, change log, ZUMSTEIN_V4.4-SNAPSHOT) Latest frozen version. Base by default all your developments on this one.
SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnseb/external-remoting/com.secutix.service.realtime.externalpayment.v1_33.ExternalPaymentService.webservice?wsdl
REST Demo endpoint (only POST): https://myinstit.ws.secutix.com/tnseb/backend-apis/externalPaymentService/v1_33/{methodName} Replace {methodName} for the desired method name as shown below.
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_33 : web service exposed to external world
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| paymentIds | List of Long |
| WebMethodResult | ||
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| orderId | Long | |
| payments | List of PaymentInfo |
| PaymentInfo | ||
| amount | Long | |
| cardAlias | String | |
| cardExpirationDate | Date | |
| cardMaskedNumber | String | |
| contactReference | String (20) | |
| paymentAdditionalData | Map of StringString | |
| paymentIdentifier | String | |
| paymentMethodId | Long | |
| pspAdditionalReturnedData | String | |
| valueDate | Date | |
| PaymentDetailResult | ||
| paymentDetails | List of PaymentDetail | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| PaymentDetail | ||
| amount | Long | |
| bankCardOwnerName | String | |
| cardAlias | String | |
| cardExpirationDate | Date | |
| cardMaskedNumber | String | |
| cardType | String | |
| catalogCurrency | CurrencyCash | |
| contactId | Long | |
| contactName | String | |
| contactNumber | String (20) | |
| contactStructureName | String | |
| epcTransactionData | EpcTransactionData | |
| externalUrl | String (255) | |
| isInstallment | boolean | |
| orderId | Long | |
| payerContact | boolean | |
| paymentDate | Date | |
| paymentId | Long | |
| paymentIdentifier | String | |
| paymentLastUpdated | Date | |
| paymentMethod | PaymentMethod | |
| paymentStatus | (WAITING|IN_PROGRESS| AUTHORIZED|PAID| CANCELLED_BY_USER|FAILED| ABANDONED| WAITING_MANUAL_VALIDATION| FAILED_REJECTED) | |
| pspAdditionalReturnedData | String | |
| referenceDate | Date | |
| valueDate | Date | |
| voucherPaymentKind | (REUSABLE_VOUCHER| NOT_REUSABLE_VOUCHER) | |
| CurrencyCash | ||
| availableCash | List of Cash | |
| currencyCode | String (8) | |
| fractionDigit | Integer | |
| minAmount | Integer | |
| symbol | String | |
| Cash | ||
| quantity | Integer | |
| type | (COIN|COINS_ROLL|NOTE| NOTES_BUNDLE) | |
| unitAmoung | Integer | |
| EpcTransactionData | ||
| aliasPaymentDetails | List of EpcAliasPaymentDetails | |
| isUsingPaymentWidget | boolean | |
| paymentWidgetUrl | String (255) | |
| postPaymentDetails | EpcPostPaymentDetails | |
| redirectPaymentDetails | List of EpcRedirectPaymentDetails | |
| transactionId | int | |
| EpcAliasPaymentDetails | ||
| cardExpMonth | EpcPaymentField | |
| cardExpYear | EpcPaymentField | |
| cardHolder | EpcPaymentField | |
| cardNumber | EpcPaymentField | |
| cvv | EpcPaymentField | |
| paymentMethod | EpcPaymentMethod | |
| hiddenFields | List of EpcField | |
| url | String (255) | |
| EpcPaymentField | ||
| definedValues | String | |
| editable | boolean | |
| mandatory | boolean | |
| name | String | |
| value | String | |
| EpcPaymentMethod | ||
| cardValidationRegex | String | |
| cvvLength | int | |
| isCvvMandatory | boolean | |
| code | String (8) | |
| description | String | |
| EpcField | ||
| name | String | |
| value | String | |
| EpcPostPaymentDetails | ||
| cardExpMonth | EpcPaymentField | |
| cardExpYear | EpcPaymentField | |
| cardHolder | EpcPaymentField | |
| cardNumber | EpcPaymentField | |
| cardType | EpcPaymentField | |
| cvv | EpcPaymentField | |
| isUsingPaymentWidget | boolean | |
| javascriptLibDetails | List of EpcJavascriptLibDetail | |
| paymentMethods | List of EpcPaymentMethod | |
| paymentWidgetUrl | String (255) | |
| storeAlias | EpcPaymentField | |
| transactionId | Integer | |
| hiddenFields | List of EpcField | |
| url | String (255) | |
| EpcJavascriptLibDetail | ||
| id | String | |
| url | String (255) | |
| EpcRedirectPaymentDetails | ||
| paymentMethod | EpcPaymentMethod | |
| hiddenFields | List of EpcField | |
| url | String (255) | |
| PaymentMethod | ||
| authorizationMode | (NONE|CONTACT_MANDATE) | |
| changeReturnAllowed | Boolean | |
| code | String (8) | |
| defaultPaymentMethodId | Long | |
| externalDescription | ExternalName | 2000 characters max for each translation |
| externalName | ExternalName | 60 characters max for each translation |
| forPayment | Boolean | |
| forReimbursement | Boolean | |
| id | Long | |
| immediateFollowupPayment | Boolean | |
| inSplitPaymentAllowed | Boolean | |
| internetCode | String (8) | Comma separated list of allowed cards (VISA,AMEX...) |
| manualValidation | Boolean | |
| maxOrderAmount | Long | |
| minOrderAmount | Long | |
| paymentType | (NUM|CHEQ|CHEQCANCEL|CB| CBCANCEL|PREPAY|VIR|AVR| COUPON|VOUCHER|CTRM|EXT| CA|BVR|INV|CANOAUTH| DEPOSIT|SAPBTRANSF| FIDELITY_POINT|DISCOUNT| CB_WITH_VALIDATION| DIRECT_DEBIT|PREPAYMENT| DIRECT_DEBIT_WITHOUT_INST) | |
| rank | Integer | |
| subPaymentMethods | List of SubPaymentMethod | |
| tooMuchPerceivedAllowed | Boolean | |
| withFollowUp | Boolean | |
| ExternalName | ||
| translations | List of Translation | |
| Translation | ||
| locale | String (2) | |
| value | String | |
| SubPaymentMethod | ||
| brand | String | |
| image | Image | |
| internetCode | String (8) | |
| rank | Integer | |
| Image | ||
| large | String | |
| medium | String | |
| small | String | |
| xlarge | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| pointOfSalesId | Long | |
| contactNumber | String (20) | |
| redirectionUrl | String (255) |
| CreateAliasResult | ||
| epcPostPaymentDetails | EpcPostPaymentDetails | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
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.
| requestId | Integer | |
| orderId | Long | |
| payments | List of PaymentInfo | |
| paymentParams | PaymentParameters |
| PaymentParameters | ||
| contactId | Long | |
| contactNumber | String (20) | |
| creditCreditNotePayment | boolean | |
| creditWaitingAccountPayment | boolean | |
| operationIds | List of Long | |
| orderId | Long | |
| paymentParametersMap | Map of (RETURN_URL| ORDER_IDENTIFIER| CONTACT_EMAIL), String | |
| pointOfSalesId | Long | |
| remark | String | |
| totalAmount | Long | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
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
| requestId | Integer | |
| paymentId | Long | |
| orderId | Long | |
| operationIds | List of Long |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| orderIds | List of Long | |
| contactNumbers | List of String |
| PossiblePayerContactsResult | ||
| contacts | List of ContactData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| ContactData | ||
Class containing the beneficiary data :
| ||
| answerQuestionnaire | AnswerQuestionnaire | |
| birthPlace | String | |
| birthRegion | String | |
| birthday | Date | |
| contactId | Long | |
| contactReference | String (20) | |
| countryCode | String (8) | |
| String | ||
| firstAddressLine | String | |
| firstName | String | |
| firstNamePhonetic | String | |
| idNumber | String | |
| invoiceAddressId | Long | |
| lastName | String | |
| lastNamePhonetic | String | |
| locality | String | |
| mobilePhone | String | |
| phone | String | |
| secondAddressLine | String | |
| structureOfficialName | String | |
| thirdAddressLine | String | |
| zipCode | String (8) | |
| AnswerQuestionnaire | ||
| answerQuestions | List of AnswerQuestion | |
| ticketId | Long | |
| AnswerQuestion | ||
| answerCodes | List of String | |
| questionCode | String (8) | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| orderId | Long | |
| pointOfSalesId | Long |
| PaymentMethodResult | ||
| paymentMethods | List of PaymentMethod | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
validate network connection and login/password
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| pointOfSalesId | Long | |
| contactNumber | String (20) |
| LoadAliasResult | ||
| epcAliasPaymentDetails | List of EpcAliasPaymentDetails | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| paymentId | Long | |
| maxWaitingTime | Long |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Process request for refunding the credit balance by bank transfer
| requestId | Integer | -- (Optional) the requestId |
| creditBalanceRefund | CreditBalanceRefund | Mandatory -- (Mandatory) contain credit balance refund request info |
| CreditBalanceRefund | ||
| amountDue | Long | |
| bicNumber | String | |
| dueDate | Date | |
| ibanNumber | String | |
| paymentMethodId | Long | |
| pointOfSalesId | Long | |
| refundedContactNumber | String (20) | |
| transferReason | String | |
| withSummaryDocument | boolean | |
| CreditBalanceRefundResult | ||
| documentId | Long | |
| shipmentId | Long | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| pointOfSalesId | Long | |
| aliasId | String | |
| contactNumber | String (20) | |
| redirectionUrl | String (255) |
| RemoveAliasResult | ||
| epcRemoveAliasData | EpcRemoveAliasData | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| EpcRemoveAliasData | ||
| hiddenFields | List of EpcField | |
| postUrl | String (255) | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
Allows to search payments according to a criteria.
| requestId | Integer | |
| searchPaymentsCriteria | SearchPaymentsCriteria | a criteria must be defined, containing at least paymentIds, orderIds or contactReferences. |
| minIndex | Integer | optional, default : 0 |
| nbMaxResults | Integer | optional, default 10. Max value : 1000 |
| SearchPaymentsCriteria | ||
| contactReferences | List of String | |
| orderIds | List of Long | |
| paymentCreationDateFrom | Date | |
| paymentCreationDateTo | Date | |
| paymentIds | List of Long | |
| paymentMethodIds | List of Long | |
| paymentStates | List of (WAITING|IN_PROGRESS| AUTHORIZED|PAID| CANCELLED_BY_USER|FAILED| ABANDONED| WAITING_MANUAL_VALIDATION| FAILED_REJECTED) | |
| paymentTypes | List of (NUM|CHEQ|CHEQCANCEL|CB| CBCANCEL|PREPAY|VIR|AVR| COUPON|VOUCHER|CTRM|EXT| CA|BVR|INV|CANOAUTH| DEPOSIT|SAPBTRANSF| FIDELITY_POINT|DISCOUNT| CB_WITH_VALIDATION| DIRECT_DEBIT|PREPAYMENT| DIRECT_DEBIT_WITHOUT_INST) | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| pointOfSalesId | Long | |
| aliasId | String | |
| contactNumber | String (20) | |
| epcAdditionalData | List of EpcField | |
| redirectionUrl | String (255) |
| UpdateAliasResult | ||
| epcAliasPaymentDetails | EpcAliasPaymentDetails | |
| requestId | Integer | |
| statusCode | String (8) | |
| statusDetail | String | |
| REST_RPC | MOSA | CUBE | PLAY |
| SOAP | MOSA | CUBE | PLAY |
| requestId | Integer | |
| orderId | Long | |
| payments | List of PaymentDetail |