ActionEvent
Examples
CreditApplicationClient client = new CreditApplicationClient();
GeneralResult result = client.ActionEvent(
"UNKNOWN",
"undefined",
1,
2,
"someArgument1",
"someArgument2",
true
);
Sample soap request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
<urn:ActionEvent>
<urn:Argument1>someArgument1.</urn:Argument1>
<urn:Argument2>someArgument2.</urn:Argument2>
<urn:BaseExtraLinkId>2.</urn:BaseExtraLinkId>
<urn:BaseId>1</urn:BaseId>
<urn:BaseType>undefined</urn:BaseType>
<urn:EventType>UNKNOWN</urn:EventType>
<urn:ProcessImmediately>true</urn:ProcessImmediately>
</urn:ActionEvent>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectActionEventActionEvent-
Argument1
Value corresponding to event argument in action package handling.string -
Argument2
Value corresponding to event argument in action package handling.string -
BaseExtraLinkId
Value corresponding to action event BaseExtraLinkID.int -
BaseId
Value corresponding to action event baseID.int -
BaseType
Value corresponding to action event base type.EnumActionBaseTypeActionBaseType.-
UndefinedUndefined. -
CollectionAccountCollectionAccount. -
PaymentPlanPaymentPlan. -
LegalLegal. -
OfferOffer. -
BankruptcyBankruptcy. -
DeceasedDeceased. -
DebtReliefDebtRelief. -
CompanyReorganisationCompanyReorganisation. -
DebtorDebtor. -
LedgerAccountLedgerAccount. -
LedgerAccountGroupLedgerAccountGroup. -
TicketTicket. -
CollectionAccountGroupCollectionAccountGroup.
-
-
EventType
Value corresponding to event type code in action events.EnumActionEventTypeActionEventType.-
STARTUPSTARTUP. -
TIMEOUTTIMEOUT. -
USER_ALTERNATIVEUSER_ALTERNATIVE. -
TIMERTIMER. -
DECISIONDECISION. -
UNKNOWNUNKNOWN. -
PAYMENTPAYMENT. -
PAYMENT_AUTHORITYPAYMENT_AUTHORITY. -
CUSTOMCUSTOM. -
VERIFICATIONVERIFICATION. -
MESSAGE_SENTMESSAGE_SENT. -
AMOUNTADJUSTMENTAMOUNTADJUSTMENT. -
NEWINVOICEADDEDNEWINVOICEADDED. -
NEWDEBTORADDEDNEWDEBTORADDED. -
FULLPAYMENTFULLPAYMENT. -
CLOSURECLOSURE. -
NEWACCOUNTADDEDNEWACCOUNTADDED. -
MESSAGE_CONFIRMEDMESSAGE_CONFIRMED. -
MESSAGE_CONFIRM_FAILEDMESSAGE_CONFIRM_FAILED. -
PROCESSINGERRORPROCESSINGERROR. -
OBJECTIONOBJECTION. -
CREDIT_ANSWERCREDIT_ANSWER. -
ACTIONGROUPING_IGNOREDACTIONGROUPING_IGNORED. -
DEBTOR_NEW_ADDRESSDEBTOR_NEW_ADDRESS. -
DEBTOR_ADDRESS_NOTVALIDDEBTOR_ADDRESS_NOTVALID. -
DEBTOR_UPDATEDEBTOR_UPDATE. -
PP_FIRST_PAYMENT_ADVICEPP_FIRST_PAYMENT_ADVICE. -
PP_PAYMENT_ADVICEPP_PAYMENT_ADVICE. -
PP_LAST_PAYMENT_ADVICEPP_LAST_PAYMENT_ADVICE. -
PP_MISSED_PAYMENTPP_MISSED_PAYMENT. -
PP_BROKEN_AGREEMENTPP_BROKEN_AGREEMENT. -
PP_REMINDERPP_REMINDER. -
PP_PAYMENTPP_PAYMENT. -
PP_PARTPAYMENTPP_PARTPAYMENT. -
PP_EXTERNAL_PAYMENTPP_EXTERNAL_PAYMENT. -
PP_EXTERNAL_ADJUSTMENTPP_EXTERNAL_ADJUSTMENT. -
PP_FIRSTPAYMENTPP_FIRSTPAYMENT. -
PP_COMPLETEDPP_COMPLETED. -
PP_LATE_PAYMENT_ADVICEPP_LATE_PAYMENT_ADVICE. -
PP_REMINDER_AND_ADVICEPP_REMINDER_AND_ADVICE. -
PP_STOPPEDPP_STOPPED. -
PP_REPLACEDPP_REPLACED. -
PP_ACTIVATEDPP_ACTIVATED. -
LEGAL_VERDICTLEGAL_VERDICT. -
LEGAL_RENEWALLEGAL_RENEWAL. -
LEGAL_CASEINFOLEGAL_CASEINFO. -
LEGAL_REPORTLEGAL_REPORT. -
LEGAL_LEXLEGAL_LEX. -
LEGAL_BECOMINGFINALLEGAL_BECOMINGFINAL. -
LEGAL_FINALPAYMENTLEGAL_FINALPAYMENT. -
LEGAL_NEWLEGALDOCUMENTLEGAL_NEWLEGALDOCUMENT. -
LEGAL_FI_SUMMONS_ERRORLEGAL_FI_SUMMONS_ERROR. -
CUSTOMER_UPDATECUSTOMER_UPDATE. -
CUSTOMER_ADDRESS_NOTVALIDCUSTOMER_ADDRESS_NOTVALID. -
BANKRUPTCY_ADDEDBANKRUPTCY_ADDED. -
DECEASED_ADDEDDECEASED_ADDED. -
DEBTRELIEF_ADDEDDEBTRELIEF_ADDED. -
DEBTRELIEF_UPDATEDDEBTRELIEF_UPDATED. -
COMPANYREORGANISATION_ADDEDCOMPANYREORGANISATION_ADDED. -
TRANSACTION_IMPORTEDTRANSACTION_IMPORTED. -
PRINTLETTER_CONDITION_FALSEPRINTLETTER_CONDITION_FALSE. -
INTEREST_INVOICING_INFO_CREATEDINTEREST_INVOICING_INFO_CREATED. -
INTEREST_INVOICING_INFO_DELETEDINTEREST_INVOICING_INFO_DELETED. -
DUE_DATE_CHANGEDDUE_DATE_CHANGED. -
AUTOTRANSFER_EVENTAUTOTRANSFER_EVENT. -
OFFER_PAID_IN_FULLOFFER_PAID_IN_FULL. -
USER_QUESTION_ANSWERUSER_QUESTION_ANSWER. -
CUSTOMERACCOUNT_FIRST_SETTLEMENTCUSTOMERACCOUNT_FIRST_SETTLEMENT. -
CUSTOMERACCOUNT_SETTLEMENTCUSTOMERACCOUNT_SETTLEMENT. -
CUSTOMERACCOUNT_LAST_SETTLEMENTCUSTOMERACCOUNT_LAST_SETTLEMENT. -
CUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAYCUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAY. -
CUSTOMERACCOUNT_BROKEN_SETTLEMENTCUSTOMERACCOUNT_BROKEN_SETTLEMENT. -
CUSTOMERACCOUNT_REMINDERCUSTOMERACCOUNT_REMINDER. -
CUSTOMERACCOUNT_PAYMENTCUSTOMERACCOUNT_PAYMENT. -
CUSTOMERACCOUNT_PARTPAYMENTCUSTOMERACCOUNT_PARTPAYMENT. -
CUSTOMERACCOUNT_PAYMENTFREE_SETTLEMENTCUSTOMERACCOUNT_PAYMENTFREE_SETTLEMENT. -
CUSTOMERACCOUNT_DEBTCOLLECTIONCUSTOMERACCOUNT_DEBTCOLLECTION. -
CUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAY_INCLUDING_CAMPAIGNCUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAY_INCLUDING_CAMPAIGN. -
CUSTOMERACCOUNT_STATEMENTOFACCOUNTccCUSTOMERACCOUNT_STATEMENTOFACCOUNT. -
CUSTOMERACCOUNT_CREDITSTOPCAUSE_ADDEDCUSTOMERACCOUNT_CREDITSTOPCAUSE_ADDED. -
CUSTOMERACCOUNT_CREDITSTOPCAUSE_REMOVEDCUSTOMERACCOUNT_CREDITSTOPCAUSE_REMOVED. -
CUSTOMERACCOUNT_CAMPAIGNEVENTCUSTOMERACCOUNT_CAMPAIGNEVENT. -
CUSTOMERACCOUNT_CAMPAIGN_CREATED_RETROACTIVELYCUSTOMERACCOUNT_CAMPAIGN_CREATED_RETROACTIVELY. -
CUSTOMERACCOUNT_CAMPAIGN_ACTIVATEDCUSTOMERACCOUNT_CAMPAIGN_ACTIVATED. -
CUSTOMERACCOUNT_LOAN_LETTER_FLOATINGCUSTOMERACCOUNT_LOAN_LETTER_FLOATING. -
CUSTOMERACCOUNT_LOAN_LETTER_NEWFIXEDINTERESTTERMCUSTOMERACCOUNT_LOAN_LETTER_NEWFIXEDINTERESTTERM. -
CUSTOMERACCOUNT_LOAN_LETTER_INFIXEDINTERESTTERMCUSTOMERACCOUNT_LOAN_LETTER_INFIXEDINTERESTTERM. -
CUSTOMERACCOUNT_LOAN_LETTER_REMINDERCUSTOMERACCOUNT_LOAN_LETTER_REMINDER. -
CUSTOMERACCOUNT_LOAN_TERMINATIONCUSTOMERACCOUNT_LOAN_TERMINATION. -
CUSTOMERACCOUNT_LOAN_PRETERMINATIONCUSTOMERACCOUNT_LOAN_PRETERMINATION. -
CUSTOMERACCOUNT_LOAN_REVERSETERMINATIONCUSTOMERACCOUNT_LOAN_REVERSETERMINATION. -
CUSTOMERACCOUNT_VIRT_INSTALMENT_INVOICINGCUSTOMERACCOUNT_VIRT_INSTALMENT_INVOICING. -
CUSTOMERACCOUNT_VIRT_REMINDERCUSTOMERACCOUNT_VIRT_REMINDER. -
CUSTOMERACCOUNT_VIRT_TERMINATIONCUSTOMERACCOUNT_VIRT_TERMINATION. -
CUSTOMERACCOUNT_INCREASED_AMOUNT_TO_PAYCUSTOMERACCOUNT_INCREASED_AMOUNT_TO_PAY. -
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_ADDEDCUSTOMERACCOUNT_CREDITDEBTINSURANCE_ADDED. -
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_UPDATEDCUSTOMERACCOUNT_CREDITDEBTINSURANCE_UPDATED. -
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_DELETEDCUSTOMERACCOUNT_CREDITDEBTINSURANCE_DELETED. -
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_STATUSCHANGEDCUSTOMERACCOUNT_CREDITDEBTINSURANCE_STATUSCHANGED. -
CUSTOMERACCOUNT_USED_RIGHT_TO_WITHDRAWCUSTOMERACCOUNT_USED_RIGHT_TO_WITHDRAW. -
CUSTOMERACCOUNT_ACCOUNT_TRANSFERCUSTOMERACCOUNT_ACCOUNT_TRANSFER. -
LEDGER_RETURNLEDGER_RETURN. -
LEDGERACCOUNT_EVENTLEDGERACCOUNT_EVENT. -
COLLECTIONACCOUNTGROUP_CASE_ADDEDCOLLECTIONACCOUNTGROUP_CASE_ADDED. -
COLLECTIONACCOUNTGROUP_CASE_REMOVEDCOLLECTIONACCOUNTGROUP_CASE_REMOVED. -
COLLECTIONACCOUNT_AUTO_CASE_REVOKECOLLECTIONACCOUNT_AUTO_CASE_REVOKE. -
AUTHSIGN_APPROVEDAUTHSIGN_APPROVED. -
AUTHSIGN_TIMEOUTAUTHSIGN_TIMEOUT. -
AUTHSIGN_REJECTEDAUTHSIGN_REJECTED. -
NEWDOCUMENTNEWDOCUMENT. -
LEDGERACCOUNT_MERGELEDGERACCOUNT_MERGE. -
LEDGERACCOUNT_REWRITELEDGERACCOUNT_REWRITE. -
BAILIFF_CANCELLATIONInformation on cancellation reported by the bailiff. -
BAILIFF_LIMITATION_CREDITORInformation on the creditor’s liability to interrupt limitation. -
BAILIFF_FINAL_REMITTANCEInformation on final remittance by the bailiff. -
BAILIFF_OBSTACLE_LACKOFFUNDSObstacle: debtor lacks funds. -
BAILIFF_OBSTACLE_LACKOFFUNDS_UNKNOWNObstacle: debtor lacks funds and is unknown. -
BAILIFF_OBSTACLE_OTHERObstacle: other. -
BAILIFF_OBSTACLE_LIMITEDENFORCEMENTObstacle: limited enforcement. -
BAILIFF_OBSTACLE_LIMITEDENFORCEMENT_UNKNOWNObstacle: limited enforcement and unknown. -
BAILIFF_DEBTOR_STATUS_UPDATEDebtor: status update. -
BAILIFF_BALANCEDebtor: balance inquiry.. -
OBJECT_UPDATEOBJECT_UPDATE.
-
-
ProcessImmediately
Process action event immediately.bool
-
Output
0 if event is triggered.
ActionEventResponse
-
ActionEventResult
Result of ActionEvent.ObjectGeneralResultA general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.int -
ResultText Mandatory
Text information of the result. Usually contains a warning or error message when result code is indicating other than success.string
-
-
CustomAction
Examples
CreditApplicationClient client = new CreditApplicationClient();
CustomActionResult result = client.CustomAction(new InvokeServiceDefinitionRequest
{
AsyncCall = false,
InputXml = @"<?xml version=""1.0"" encoding=""ISO-8859-1"" standalone=""no"" ?>
<data>
<value>12</value>
</data>",
ServiceDefinitionName = "your_service_definition"
});
Sample soap request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
<urn:CustomAction>
<urn:ServiceDefinition>
<urn:AsyncCall>false</urn:AsyncCall>
<urn:InputXml><![CDATA[
<?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?>
<data>
<value>12</value>
</data>
]]></urn:InputXml>
<urn:ServiceDefinitionName>your_service_definition</urn:ServiceDefinitionName>
</urn:ServiceDefinition>
</urn:CustomAction>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectCustomActionCustomAction-
ServiceDefinition
The invoke service definition request.ObjectInvokeServiceDefinitionRequestA request for invoking a service definition.-
AsyncCall
Whether service definition invocation is asynchronous or not, i.e. fire and forget. When true the result CData is not collected. Default value is false.bool -
Input
An XML structure used for input into service definition call.XmlElement -
InputXml
An XML string used for input into service definition call.string -
ServiceDefinitionName Mandatory
Name of the service definition to invoke.string
-
-
Output
CData.
Error codes:
- 30601: General service definition error
- 30602: Service definition does not exist
- 30603: Service definition input values error
- 30604: Custom error
CustomActionResponse
-
CustomActionResult
Result of CustomActionObjectCustomActionResultThe result for a custom action, i.e. a service definition call.-
CData
Raw CData from service definition response.XmlElement -
Result
The result of the request. Indicating success or error.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.int -
ResultText Mandatory
Text information of the result. Usually contains a warning or error message when result code is indicating other than success.string
-
-
GetApplicantActionHistory
Examples
CreditApplicationClient client = new CreditApplicationClient();
GetApplicantActionHistoryResult result = client.GetApplicantActionHistory(new GetApplicantActionHistoryRequest()
{
CustomerLookup = new CustomerLookup
{
CustomerIdentification = CustomerIdentificationType.CustomerSESSNOrCompanyNo,
CustomerIdentificationValue = "770714-2308",
}
});
Sample soap request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
<urn:GetApplicantActionHistory>
<urn:getApplicantActionHistoryRequest>
<urn:CustomerLookup>
<urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
<urn:CustomerIdentificationValue>470105-3151</urn:CustomerIdentificationValue>
</urn:CustomerLookup>
</urn:getApplicantActionHistoryRequest>
</urn:GetApplicantActionHistory>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectGetApplicantActionHistoryGetApplicationHistory-
getApplicantActionHistoryRequest
Get credit application request parameters.ObjectGetApplicantActionHistoryRequestThe GetApplicantActionHistory request parameters.-
ActionGroup
History action group.EnumActionGroupAction group.-
NoneNone. -
RespiteAn action (e.g. letter) to be sent as a confirmation of a given respite. -
Legal_SE_SUPRO_reduceAn export or letter action to handle reduction of a claim in Swedish injunction to pay process. -
Legal_SE_SUPRO_recallAn export or letter action to handle a recall of a claim from the Swedish injunction to pay process. -
Legal_SE_enforcement_reduceAn export or letter action to handle reduction of a claim in Swedish enforcement process. -
Legal_SE_enforcement_recallAn export or letter action to handle a recall of a claim from the Swedish enforcement process. -
InvoiceAn action (e.g. letter) that is the actual invoice. -
ReminderAn action (e.g. letter) that is a reminder of an unpaid invoice. -
CollectionAn action (e.g. export) that is the start of the debcollection process. -
Legal_SE_enforcement_applicationAn export or letter action to handle an application for a Swedish enforcement process. -
Legal_SE_enforcement_renewAn export or letter action to handle a yearly renewal in a Swedish enforcement process. -
Legal_SE_enforcement_respiteAn export or letter action to to give the debtor a respite in a Swedish enforcement process. -
PP_AviMonthly payment notice in a payment (instalment) plan. -
Legal_SE_enforcement_messageAn export or letter action to handle a message to the bailiff in a Swedish enforcement process. -
Legal_SE_enforcement_changeAn export or letter action to handle an update to a case in a Swedish enforcement process. -
PP_ReminderReminder of a monthly payment notice in a payment (instalment) plan. -
Legal_SE_SUPRO_applicationAn export or letter action to handle application of a Swedish injunction to pay process. -
BOFA letter action for Norwegian debt collection notice. -
VarselNorwegian reminder letter. -
IKVARNorwegian reminder and debt collection warning letter. -
Bankruptcy_applicationA letter action with application for bankruptcy. -
XFR_applicationAn export action for Swedish credit information at Kronofogden (XFR). -
NoticeAction for monthly invoice of an account/loan. -
Promissory_NoteAction for promissory note of an account/loan. -
BOFVarselA letter action for Norwegian debt collection notice. -
TungInkassoAn action for initiating double charge of the debtor in a Norwegian collection case. -
Legal_NO_SI_application_ForlikNorwegian action for application of simplified summons. -
Legal_NO_Forlik_reduceAn export or letter action to handle reduction of a claim in Norwegian simplified summons process. -
Legal_NO_Forlik_recallAn export or letter action to handle a recall of a claim in Norwegian simplified summons process. -
Legal_NO_DirekteUtlegg_reduceAn export or letter action to handle reduction of a claim in Norwegian direct enforcement process. -
Legal_NO_DirekteUtlegg_recallAn export or letter action to handle a recall of a claim in Norwegian direct enforcement process. -
Legal_NO_Utlegg_reduceAn export or letter action to handle reduction of a claim in Norwegian enforcement process. -
Legal_NO_Utlegg_recallAn export or letter action to handle a recall of a claim in Norwegian enforcement process. -
Legal_NO_SI_application_UtleggNorwegian action for application of enforcement. -
Legal_NO_SI_application_DirekteUtleggNorwegian action for application of direct enforcement (without prior summons). -
NL_WIKA letter action for Dutch debt collection notice. -
Legal_FI_Summons_reduceAn export or letter action to handle reduction of a claim in Finnish summons process. -
Legal_FI_Summons_recallAn export or letter action to handle a recall of a claim in Finnish summons process. -
Legal_FI_Enforcement_reduceAn export or letter action to handle reduction of a claim in Finnish enforcement process. -
Legal_FI_Enforcement_recallAn export or letter action to handle a recall of a claim in Finnish enforcement process. -
Legal_NL_WritOfSummonsA letter action for Dutch writ of summons. -
Legal_NL_LegalDocumentA letter action for Dutch document that needs to be sent to the bailiff. -
Legal_NL_BailiffExportAn export action for exporting writ of summons or legal documents to the Dutch bailiff. -
SamlingsaviseringAction for monthly invoice of a revolving account. -
Samlingsavisering_Reminder_1Action for first reminder of a revolving account. -
Samlingsavisering_Reminder_2Action for second reminder of a revolving account. -
SECCIA letter action for the Standard European Consumer Credit Information. -
PersonalDataReportA letter action for presenting a personal data report to the customer/debtor. -
Legal_FI_SummonsFinnish action for writ of summons. -
Legal_FI_EnforcementFinnish action for application of enforcement. -
DemPayment remark revoke. -
Legal_FI_Enforcement_NotificationFinnish Enforcement notification -
Legal_FI_Balance_Inquiry_ResponseFinnish Bailiff balance inquiry response -
Legal_FI_DebtrecallUljas, debt recall (FI) -
Back_To_BillingBack to billing
-
-
ActionType
History action type.EnumActionTypeAction type.-
UndefinedUndefined. -
LetterLetter. -
WordLetterWord letter. -
ExportDataExport data. -
ManualManual collection. -
PhonePhone. -
ManualSystemManual collection (System). -
InsertLegalRegistration legal information. -
ChangeServiceChange service. -
NoOpWait. -
InsertOfferRegistration offer. -
ReturnToPreviousReturn to previous. -
EmailE-mail. -
UserQuestionQuestion to user. -
InsertPurchasePurchase of claim. -
SmsSMS message (text). -
EndorsementEndorsement. -
ReendorsementReendorsement. -
ListList. -
UpdateDataUpdate data. -
ServiceService call. -
UpdatePaymentPlanUpdate payment plan. -
NewInvoiceConfirmMerge new invoice. -
GroupingGrouping. -
VoicemailVoicemail. -
DecisionDecsicion. -
UserQuestionListQuestion list. -
CaseTransferCase transfer. -
AccountTransferAccount transfer. -
AuthSignAuthentication/signing. -
RegisterVerdictRegister Verdict.
-
-
CustomerAccountNumber
Customer account number.string -
CustomerLookup Mandatory
A lookup for customer.ObjectCustomerLookupA lookup for customer.-
CustomerIdentification Mandatory
Type of customer identification to look up.EnumCustomerIdentificationTypeCustomer identification type.-
CustomCustom identification. -
CustomerSESSNOrCompanyNoIdentify by Swedish SSN or company number. -
CustomerNOSSNOrCompanyNoIdentify by Norwegian SSN or company number. -
CustomerReferenceNumberIdentify by customer reference number. -
CustomerGuidCustomer identification.
-
-
CustomerIdentificationValue Mandatory
Customer identification to look up, depending on type it has different formats.string -
JuridicalType
Type of customer, e.g. physical.EnumCustomerJuridicalTypeJuridical type of the customer.-
PhysicalPhysical person, meaning a natural person. -
CompanyA company or other organisation. -
PersonalFirmA company that shares the juridical entity with a physical person.
-
-
-
CustomerOwnerReferenceFilter
Customer owner reference filter.string -
FromDate
Get history actions from specified date.DateTime -
InvoiceNumber
Invoice number.string -
ToDate
Get history actions to specified date.DateTime
-
-
Output
Error codes:
- 1 : Specified argument was out of the range of valid values.
- 1 : Error in the application.
- 1 : error message from ARC server
GetApplicantActionHistoryResponse
-
GetApplicantActionHistoryResult
Result of GetApplicationHistory.ObjectGetApplicantActionHistoryResultThe result of GetApplicantActionHistory request.-
HistoryDocuments
List of history actions.ArrayObjectHistoryDetailed information about history action item.-
ActionGroup
Action group (predefined category for history actions).EnumActionGroupAction group.-
NoneNone. -
RespiteAn action (e.g. letter) to be sent as a confirmation of a given respite. -
Legal_SE_SUPRO_reduceAn export or letter action to handle reduction of a claim in Swedish injunction to pay process. -
Legal_SE_SUPRO_recallAn export or letter action to handle a recall of a claim from the Swedish injunction to pay process. -
Legal_SE_enforcement_reduceAn export or letter action to handle reduction of a claim in Swedish enforcement process. -
Legal_SE_enforcement_recallAn export or letter action to handle a recall of a claim from the Swedish enforcement process. -
InvoiceAn action (e.g. letter) that is the actual invoice. -
ReminderAn action (e.g. letter) that is a reminder of an unpaid invoice. -
CollectionAn action (e.g. export) that is the start of the debcollection process. -
Legal_SE_enforcement_applicationAn export or letter action to handle an application for a Swedish enforcement process. -
Legal_SE_enforcement_renewAn export or letter action to handle a yearly renewal in a Swedish enforcement process. -
Legal_SE_enforcement_respiteAn export or letter action to to give the debtor a respite in a Swedish enforcement process. -
PP_AviMonthly payment notice in a payment (instalment) plan. -
Legal_SE_enforcement_messageAn export or letter action to handle a message to the bailiff in a Swedish enforcement process. -
Legal_SE_enforcement_changeAn export or letter action to handle an update to a case in a Swedish enforcement process. -
PP_ReminderReminder of a monthly payment notice in a payment (instalment) plan. -
Legal_SE_SUPRO_applicationAn export or letter action to handle application of a Swedish injunction to pay process. -
BOFA letter action for Norwegian debt collection notice. -
VarselNorwegian reminder letter. -
IKVARNorwegian reminder and debt collection warning letter. -
Bankruptcy_applicationA letter action with application for bankruptcy. -
XFR_applicationAn export action for Swedish credit information at Kronofogden (XFR). -
NoticeAction for monthly invoice of an account/loan. -
Promissory_NoteAction for promissory note of an account/loan. -
BOFVarselA letter action for Norwegian debt collection notice. -
TungInkassoAn action for initiating double charge of the debtor in a Norwegian collection case. -
Legal_NO_SI_application_ForlikNorwegian action for application of simplified summons. -
Legal_NO_Forlik_reduceAn export or letter action to handle reduction of a claim in Norwegian simplified summons process. -
Legal_NO_Forlik_recallAn export or letter action to handle a recall of a claim in Norwegian simplified summons process. -
Legal_NO_DirekteUtlegg_reduceAn export or letter action to handle reduction of a claim in Norwegian direct enforcement process. -
Legal_NO_DirekteUtlegg_recallAn export or letter action to handle a recall of a claim in Norwegian direct enforcement process. -
Legal_NO_Utlegg_reduceAn export or letter action to handle reduction of a claim in Norwegian enforcement process. -
Legal_NO_Utlegg_recallAn export or letter action to handle a recall of a claim in Norwegian enforcement process. -
Legal_NO_SI_application_UtleggNorwegian action for application of enforcement. -
Legal_NO_SI_application_DirekteUtleggNorwegian action for application of direct enforcement (without prior summons). -
NL_WIKA letter action for Dutch debt collection notice. -
Legal_FI_Summons_reduceAn export or letter action to handle reduction of a claim in Finnish summons process. -
Legal_FI_Summons_recallAn export or letter action to handle a recall of a claim in Finnish summons process. -
Legal_FI_Enforcement_reduceAn export or letter action to handle reduction of a claim in Finnish enforcement process. -
Legal_FI_Enforcement_recallAn export or letter action to handle a recall of a claim in Finnish enforcement process. -
Legal_NL_WritOfSummonsA letter action for Dutch writ of summons. -
Legal_NL_LegalDocumentA letter action for Dutch document that needs to be sent to the bailiff. -
Legal_NL_BailiffExportAn export action for exporting writ of summons or legal documents to the Dutch bailiff. -
SamlingsaviseringAction for monthly invoice of a revolving account. -
Samlingsavisering_Reminder_1Action for first reminder of a revolving account. -
Samlingsavisering_Reminder_2Action for second reminder of a revolving account. -
SECCIA letter action for the Standard European Consumer Credit Information. -
PersonalDataReportA letter action for presenting a personal data report to the customer/debtor. -
Legal_FI_SummonsFinnish action for writ of summons. -
Legal_FI_EnforcementFinnish action for application of enforcement. -
DemPayment remark revoke. -
Legal_FI_Enforcement_NotificationFinnish Enforcement notification -
Legal_FI_Balance_Inquiry_ResponseFinnish Bailiff balance inquiry response -
Legal_FI_DebtrecallUljas, debt recall (FI) -
Back_To_BillingBack to billing
-
-
ActionGroupingGuid
Ledger account group unique identifier.string -
ActionItemCode
History action item code.string -
ActionType
History item action type.EnumActionTypeAction type.-
UndefinedUndefined. -
LetterLetter. -
WordLetterWord letter. -
ExportDataExport data. -
ManualManual collection. -
PhonePhone. -
ManualSystemManual collection (System). -
InsertLegalRegistration legal information. -
ChangeServiceChange service. -
NoOpWait. -
InsertOfferRegistration offer. -
ReturnToPreviousReturn to previous. -
EmailE-mail. -
UserQuestionQuestion to user. -
InsertPurchasePurchase of claim. -
SmsSMS message (text). -
EndorsementEndorsement. -
ReendorsementReendorsement. -
ListList. -
UpdateDataUpdate data. -
ServiceService call. -
UpdatePaymentPlanUpdate payment plan. -
NewInvoiceConfirmMerge new invoice. -
GroupingGrouping. -
VoicemailVoicemail. -
DecisionDecsicion. -
UserQuestionListQuestion list. -
CaseTransferCase transfer. -
AccountTransferAccount transfer. -
AuthSignAuthentication/signing. -
RegisterVerdictRegister Verdict.
-
-
AmountToPay
Amount to pay.decimal -
BankAccountNo
Bank account number.string -
CaseNumber
Case number.string -
CurrencyCode
Currency code, e.g. SEK, NOK, EUR etc.string -
CustomerAccountNumber
Customer account number.string -
Date
History action item registration date.DateTime -
Description
Action item description.string -
DueDate
Due date.DateTime -
FileName
Original file namestring -
HasArchivedDocument
If history action item has corresponding archived document.bool -
HistoryGuid
History action item unique identifier.string -
InvoiceNumber
Invoice number.string -
Name
History action item name.string -
PaidDate
Payment date.DateTime -
PaymentRefrence
Payment reference.string -
PrintedAt
Print date.DateTime -
UserCode
User codestring -
UserEmail
E-mail of the action performer.string -
UserFullName
Full name of the action performer.string -
UserType
Party type of the action performer.EnumUserTypeUser type.-
NoneUser type is undefined. -
AllAll types. -
CreditorUserCreditor user type. -
SolicitorUserSolicitor user type. -
CreditorAndSolicitorUserCreditor | Solicitor user type. -
DebtorDebtor user type. -
CreditorUserAndDebtorCreditor Debtor user type -
SolicitorUserAndDebtorSolicito Debtor user type -
CreditorAndSolicitorUserAndDebtorCreditor Solicitor Debtor user type
-
-
-
Result Mandatory
The result of the request. Indicating success or error.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.int -
ResultText Mandatory
Text information of the result. Usually contains a warning or error message when result code is indicating other than success.string
-
-
GetCreditApplicationDetails
Examples
CreditApplicationClient client = new CreditApplicationClient();
GetCreditApplicationDetailsResult result = client.GetCreditApplicationDetails(new GetCreditApplicationDetailsRequest()
{
CreditApplicationGuid = "C80F76D8-8B2D-4619-BE92-2070795A04C1"
});
Sample soap request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
<urn:GetCreditApplicationDetails>
<urn:GetCreditApplicationDetailsRequest>
<urn:CreditApplicationGuid>EAAB478D-E04E-4DDA-911E-F3F4332FF427</urn:CreditApplicationGuid>
</urn:GetCreditApplicationDetailsRequest>
</urn:GetCreditApplicationDetails>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectGetCreditApplicationDetailsGetCreditApplicationDetails-
GetCreditApplicationDetailsRequest
Get credit application request parameters.ObjectGetCreditApplicationDetailsRequestThe GetCreditApplicationDetails request.-
CreditApplicationGuid Mandatory
Credit application unique identifier.string
-
-
Output
Error codes:
- 1 : error message from ARC server
GetCreditApplicationDetailsResponse
-
GetCreditApplicationDetailsResult
Result of GetCreditApplicationDetailsObjectGetCreditApplicationDetailsResultThe result of GetCreditApplicationDetails request.-
CreditApplicationDetails
Credit application details.ObjectCreditApplicationDetailsCredit application details.-
AccountGuid Mandatory
Account unique identifier.string -
AccountNumber
Customer account number.string -
ActionFlowStatus
Account status informationObjectActionFlowAccount status information-
StatusCode
Status codestring -
StatusDate
Status dateDateTime -
StatusDescription
Status descriptionstring -
SubstatusCode
Substatus datestring -
SubstatusDate
Substatus dateDateTime -
SubstatusDescription
Substatus datestring
-
-
ActionHistory
List of history actions.ArrayObjectHistoryDetailed information about history action item.-
ActionGroup
Action group (predefined category for history actions).EnumActionGroupAction group.-
NoneNone. -
RespiteAn action (e.g. letter) to be sent as a confirmation of a given respite. -
Legal_SE_SUPRO_reduceAn export or letter action to handle reduction of a claim in Swedish injunction to pay process. -
Legal_SE_SUPRO_recallAn export or letter action to handle a recall of a claim from the Swedish injunction to pay process. -
Legal_SE_enforcement_reduceAn export or letter action to handle reduction of a claim in Swedish enforcement process. -
Legal_SE_enforcement_recallAn export or letter action to handle a recall of a claim from the Swedish enforcement process. -
InvoiceAn action (e.g. letter) that is the actual invoice. -
ReminderAn action (e.g. letter) that is a reminder of an unpaid invoice. -
CollectionAn action (e.g. export) that is the start of the debcollection process. -
Legal_SE_enforcement_applicationAn export or letter action to handle an application for a Swedish enforcement process. -
Legal_SE_enforcement_renewAn export or letter action to handle a yearly renewal in a Swedish enforcement process. -
Legal_SE_enforcement_respiteAn export or letter action to to give the debtor a respite in a Swedish enforcement process. -
PP_AviMonthly payment notice in a payment (instalment) plan. -
Legal_SE_enforcement_messageAn export or letter action to handle a message to the bailiff in a Swedish enforcement process. -
Legal_SE_enforcement_changeAn export or letter action to handle an update to a case in a Swedish enforcement process. -
PP_ReminderReminder of a monthly payment notice in a payment (instalment) plan. -
Legal_SE_SUPRO_applicationAn export or letter action to handle application of a Swedish injunction to pay process. -
BOFA letter action for Norwegian debt collection notice. -
VarselNorwegian reminder letter. -
IKVARNorwegian reminder and debt collection warning letter. -
Bankruptcy_applicationA letter action with application for bankruptcy. -
XFR_applicationAn export action for Swedish credit information at Kronofogden (XFR). -
NoticeAction for monthly invoice of an account/loan. -
Promissory_NoteAction for promissory note of an account/loan. -
BOFVarselA letter action for Norwegian debt collection notice. -
TungInkassoAn action for initiating double charge of the debtor in a Norwegian collection case. -
Legal_NO_SI_application_ForlikNorwegian action for application of simplified summons. -
Legal_NO_Forlik_reduceAn export or letter action to handle reduction of a claim in Norwegian simplified summons process. -
Legal_NO_Forlik_recallAn export or letter action to handle a recall of a claim in Norwegian simplified summons process. -
Legal_NO_DirekteUtlegg_reduceAn export or letter action to handle reduction of a claim in Norwegian direct enforcement process. -
Legal_NO_DirekteUtlegg_recallAn export or letter action to handle a recall of a claim in Norwegian direct enforcement process. -
Legal_NO_Utlegg_reduceAn export or letter action to handle reduction of a claim in Norwegian enforcement process. -
Legal_NO_Utlegg_recallAn export or letter action to handle a recall of a claim in Norwegian enforcement process. -
Legal_NO_SI_application_UtleggNorwegian action for application of enforcement. -
Legal_NO_SI_application_DirekteUtleggNorwegian action for application of direct enforcement (without prior summons). -
NL_WIKA letter action for Dutch debt collection notice. -
Legal_FI_Summons_reduceAn export or letter action to handle reduction of a claim in Finnish summons process. -
Legal_FI_Summons_recallAn export or letter action to handle a recall of a claim in Finnish summons process. -
Legal_FI_Enforcement_reduceAn export or letter action to handle reduction of a claim in Finnish enforcement process. -
Legal_FI_Enforcement_recallAn export or letter action to handle a recall of a claim in Finnish enforcement process. -
Legal_NL_WritOfSummonsA letter action for Dutch writ of summons. -
Legal_NL_LegalDocumentA letter action for Dutch document that needs to be sent to the bailiff. -
Legal_NL_BailiffExportAn export action for exporting writ of summons or legal documents to the Dutch bailiff. -
SamlingsaviseringAction for monthly invoice of a revolving account. -
Samlingsavisering_Reminder_1Action for first reminder of a revolving account. -
Samlingsavisering_Reminder_2Action for second reminder of a revolving account. -
SECCIA letter action for the Standard European Consumer Credit Information. -
PersonalDataReportA letter action for presenting a personal data report to the customer/debtor. -
Legal_FI_SummonsFinnish action for writ of summons. -
Legal_FI_EnforcementFinnish action for application of enforcement. -
DemPayment remark revoke. -
Legal_FI_Enforcement_NotificationFinnish Enforcement notification -
Legal_FI_Balance_Inquiry_ResponseFinnish Bailiff balance inquiry response -
Legal_FI_DebtrecallUljas, debt recall (FI) -
Back_To_BillingBack to billing
-
-
ActionGroupingGuid
Ledger account group unique identifier.string -
ActionItemCode
History action item code.string -
ActionType
History item action type.EnumActionTypeAction type.-
UndefinedUndefined. -
LetterLetter. -
WordLetterWord letter. -
ExportDataExport data. -
ManualManual collection. -
PhonePhone. -
ManualSystemManual collection (System). -
InsertLegalRegistration legal information. -
ChangeServiceChange service. -
NoOpWait. -
InsertOfferRegistration offer. -
ReturnToPreviousReturn to previous. -
EmailE-mail. -
UserQuestionQuestion to user. -
InsertPurchasePurchase of claim. -
SmsSMS message (text). -
EndorsementEndorsement. -
ReendorsementReendorsement. -
ListList. -
UpdateDataUpdate data. -
ServiceService call. -
UpdatePaymentPlanUpdate payment plan. -
NewInvoiceConfirmMerge new invoice. -
GroupingGrouping. -
VoicemailVoicemail. -
DecisionDecsicion. -
UserQuestionListQuestion list. -
CaseTransferCase transfer. -
AccountTransferAccount transfer. -
AuthSignAuthentication/signing. -
RegisterVerdictRegister Verdict.
-
-
AmountToPay
Amount to pay.decimal -
BankAccountNo
Bank account number.string -
CaseNumber
Case number.string -
CurrencyCode
Currency code, e.g. SEK, NOK, EUR etc.string -
CustomerAccountNumber
Customer account number.string -
Date
History action item registration date.DateTime -
Description
Action item description.string -
DueDate
Due date.DateTime -
FileName
Original file namestring -
HasArchivedDocument
If history action item has corresponding archived document.bool -
HistoryGuid
History action item unique identifier.string -
InvoiceNumber
Invoice number.string -
Name
History action item name.string -
PaidDate
Payment date.DateTime -
PaymentRefrence
Payment reference.string -
PrintedAt
Print date.DateTime -
UserCode
User codestring -
UserEmail
E-mail of the action performer.string -
UserFullName
Full name of the action performer.string -
UserType
Party type of the action performer.EnumUserTypeUser type.-
NoneUser type is undefined. -
AllAll types. -
CreditorUserCreditor user type. -
SolicitorUserSolicitor user type. -
CreditorAndSolicitorUserCreditor | Solicitor user type. -
DebtorDebtor user type. -
CreditorUserAndDebtorCreditor Debtor user type -
SolicitorUserAndDebtorSolicito Debtor user type -
CreditorAndSolicitorUserAndDebtorCreditor Solicitor Debtor user type
-
-
-
AnnualPercentage
Annual percentage.decimal -
ApplicationDate
The application creation date.DateTime -
AppliedCreditAmount Mandatory
Applied credit amount.decimal -
Broker
Broker party informationObjectBrokerPartyBroker party information-
FullName
Party namestring -
Guid
Guidstring -
InformalName
Party informal namestring -
ReferenceCode
Party reference codestring
-
-
CoApplicants
List of credit co-applicants.ArrayObjectCreditApplicantDetailsCredit applicant details.-
Addresses
List of credit applicant addresses.ArrayObjectAddressHolds address information.-
CareOf
Care of address.string -
City
City.string -
CountryCode
Country code, i.e. EN, SE etc.string -
DefaultAddress
Whether this is the default address.bool -
FullAddress
Combined address with all fields into single string.string -
FullName
The full name of the receiving party, i.e name of person or company.string -
HouseNo
House number.string -
HouseNoExtension
House number extension.string -
StateCode
State code if applicable.string -
Street
Street address.string -
TypeCode Mandatory
The type code of the address, i.e. what the address is used for, e.g. LEGAL, AVI, INVOICE, SITE, DELIVERY, TRUSTACCNT. Should be used one of predefined values using correct letter case.string -
UpdateExisting
Whether this should update existing or create new address.bool -
ValidFrom
The date when the address becomes active. If the element is missing, then do not change the current actual value.DateTime -
ValidTo
The date after which the address becomes inactive. If the element is missing, then do not change the current actual value.DateTime -
ZipCode
Zip code, i.e. postal code.string
-
-
AnnualIncome
Annual income value.decimal -
Authenticated Mandatory
Credit applicant authenticated boolean flag.bool -
CellularPhone
Cellular phone number of the credit applicant.string -
CreditApplicantStatus
Current status of the credit applicant.EnumCreditApplicationStatusStatus of credit application.-
NewApplicationNew credit application, initial state. -
AnalysisPending analysis of credit application. -
AwaitingConfirmationAwaiting confirmation for credit application. -
AwaitingAdditionalInfoAwaiting additional information for credit application. -
AwaitingSignatureAwaiting signature from customer. -
RejectedCredit application has been rejected. -
ApprovedCredit application has been approved. -
TerminatedCredit application has been terminated.
-
-
CreditApplicantStatusDate
Date of the credit applicant status.DateTime -
CurrencyCode
Currency code, e.g. SEK, NOK, EUR etc.string -
CurrentCustomerGuid
Unique identifier of current customer.string -
CustomerReference
Customer reference number.string -
DataProvisions
List of credit applicant data provisions.ArrayObjectDataProvisionHolds data provision details.-
Code Mandatory
Data provision code.string -
Text
Data provision text.string -
Version
Data provision version.string
-
-
DateOfBirth
Date of birth of the credit applicant.DateTime -
Email
E-mail of the credit applicant.string -
EmployerName
Employer name.string -
EmployerPhone
Employer phone number.string -
EmploymentType
Employment type of the credit applicant.EnumEmploymentTypeEmployment type of person.-
StudentStudent. -
DisabilityPensionDisability pension. -
UnemployedUnemployed. -
TemporaryEmployedTemporary employed. -
PermanentEmployedPermanent employed. -
SelfEmployedSelf-employed. -
RetiredRetired.
-
-
ExtraFields
List of credit applicant extra fields.ArrayObjectExtraFieldExtra field contains custom data.-
Data
Value of extra field.string -
Name
Name of extra field.string
-
-
Firstname
FIrst name of the credit applicant.string -
Gender
Credit applicant gender.EnumGenderTypeGender of a person.-
FemaleFemale gender, a woman. -
MaleMale gender, a man. -
UnknownUnknown gender, or neither Female nor Male.
-
-
HomePhone
Home phone number of the credit applicant.string -
IdNumber
Credit applicant ID number.string -
InvoiceChannel
Preffered invoice channel, e.g. LETTER, E-INVOICE, EMAIL, SMS etc. Should be used one of predefined values using correct letter case.string -
JuridicalType
Type of credit applicant, juridically.EnumJuridicalTypeType of person, juridically.-
NaturalPersonActual person. -
JuridicalPersonJuridical person, e.g a company.
-
-
LanguageCode
Language code e.g. sv, en etc.string -
Lastname
Last name of the credit applicant.string -
MaritalStatus
Marital status.EnumMaritalStatusMarital status.-
UnmarriedUnmarried. -
MarriedMarried. -
CommonLawSpouseCommon law spouse. -
WidowWidow. -
DivorcedDivorced. -
PartnerPartner.
-
-
Middlename
Middle name of the credit applicant.string -
MonthlyCostForOtherCreditsAndLoans
Monthly cost of other credits and loans value.decimal -
MonthlyIncome
Monthly income value.decimal -
MonthlyRentalCost
Monthly rental cost.decimal -
NumberOfAdults
Number of adults.int -
NumberOfDependentChildren
Number of dependent children.int -
OtherSecuredLoans
Other secured loans value.decimal -
OtherTotalCreditsandLoans
Other total credits and loans value.decimal -
OtherUnsecuredLoans
Other unsecured loans value.decimal -
PlaceOfbirth
Place of birth of the credit applicant.string -
PreferredChannel
Preffered communication channel, e.g. LETTER, E-INVOICE, EMAIL, SMS etc. Should be used one of predefined values using correct letter case.string -
ResidentDescription
Resident description.string -
ShareOfAccommodationCost
Share of accommodation cost value.decimal -
Signed Mandatory
Credit applicant signed boolean flag.bool -
TypeOfResident
Type of resident.EnumTypeOfResidentType of resident.-
RentedApartmentRented apartment. -
CoOperativeApartmentCo-operative apartment. -
DetachedHouseDetached house. -
RoomerOrSecondHandRoomer or second hand.
-
-
WorkPhone
Work phone number of the credit applicant.string
-
-
CreditApplicationStatus
Current status of the credit application.EnumCreditApplicationStatusStatus of credit application.-
NewApplicationNew credit application, initial state. -
AnalysisPending analysis of credit application. -
AwaitingConfirmationAwaiting confirmation for credit application. -
AwaitingAdditionalInfoAwaiting additional information for credit application. -
AwaitingSignatureAwaiting signature from customer. -
RejectedCredit application has been rejected. -
ApprovedCredit application has been approved. -
TerminatedCredit application has been terminated.
-
-
CreditApplicationStatusDate
Date of the credit application status.DateTime -
CustomerAccountTypeCode Mandatory
Customer account type code.string -
DataProvisions
List of data provisions.ArrayObjectDataProvisionHolds data provision details.-
Code Mandatory
Data provision code.string -
Text
Data provision text.string -
Version
Data provision version.string
-
-
Disbursements
Loan disbursement informationArrayObjectLoanDisbursementLoan disbursement information-
Amount Mandatory
Amountdecimal -
CurrencyCode Mandatory
Currencystring -
DisbursementDate Mandatory
Operation dateDateTime
-
-
DurationInMonths Mandatory
The application duration in months.int -
ExtraFields
List of extra fields.ArrayObjectExtraFieldExtra field contains custom data.-
Data
Value of extra field.string -
Name
Name of extra field.string
-
-
InterestCode
The interest code of application.string -
InterestRate
The interest rate of application.decimal -
LoansToSettle
List of loans to settle.ArrayObjectLoanToSettleLoan to settle data type.-
AccruedInterest
Accrued interest value.decimal -
BankAccountNo Mandatory
Bank account number.string -
BankCode
Bank code.string -
BankCurrencyCode Mandatory
Bank currency code, e.g. SEK, NOK, EUR etc.string -
BankDescription
Bank description.string -
BankName Mandatory
Bank name.string -
Bic
BIC code.string -
Blz
BLZ code.string -
CountryCode Mandatory
Bank country code, e.g. SE, NO, NL etc.string -
CurrencyCode Mandatory
Currency code, e.g. SEK, NOK, EUR etc.string -
DisburSementDate
Disbursment date.DateTime -
Fees
Fees value.decimal -
Iban
IBAN number.string -
LoanReferenceNumber
Loan reference number.string -
NetInterestLossCompensation
Net interest loss compensation value.decimal -
PaymentReferenceNumber
Payment reference number.string -
PrincipalAmount
Principal amount.decimal -
SettlementAmount Mandatory
Settlement amount.decimal -
Swift
SWIFT code.string
-
-
MainApplicant Mandatory
Main credit applicant details.ObjectCreditApplicantDetailsCredit applicant details.-
Addresses
List of credit applicant addresses.ArrayObjectAddressHolds address information.-
CareOf
Care of address.string -
City
City.string -
CountryCode
Country code, i.e. EN, SE etc.string -
DefaultAddress
Whether this is the default address.bool -
FullAddress
Combined address with all fields into single string.string -
FullName
The full name of the receiving party, i.e name of person or company.string -
HouseNo
House number.string -
HouseNoExtension
House number extension.string -
StateCode
State code if applicable.string -
Street
Street address.string -
TypeCode Mandatory
The type code of the address, i.e. what the address is used for, e.g. LEGAL, AVI, INVOICE, SITE, DELIVERY, TRUSTACCNT. Should be used one of predefined values using correct letter case.string -
UpdateExisting
Whether this should update existing or create new address.bool -
ValidFrom
The date when the address becomes active. If the element is missing, then do not change the current actual value.DateTime -
ValidTo
The date after which the address becomes inactive. If the element is missing, then do not change the current actual value.DateTime -
ZipCode
Zip code, i.e. postal code.string
-
-
AnnualIncome
Annual income value.decimal -
Authenticated Mandatory
Credit applicant authenticated boolean flag.bool -
CellularPhone
Cellular phone number of the credit applicant.string -
CreditApplicantStatus
Current status of the credit applicant.EnumCreditApplicationStatusStatus of credit application.-
NewApplicationNew credit application, initial state. -
AnalysisPending analysis of credit application. -
AwaitingConfirmationAwaiting confirmation for credit application. -
AwaitingAdditionalInfoAwaiting additional information for credit application. -
AwaitingSignatureAwaiting signature from customer. -
RejectedCredit application has been rejected. -
ApprovedCredit application has been approved. -
TerminatedCredit application has been terminated.
-
-
CreditApplicantStatusDate
Date of the credit applicant status.DateTime -
CurrencyCode
Currency code, e.g. SEK, NOK, EUR etc.string -
CurrentCustomerGuid
Unique identifier of current customer.string -
CustomerReference
Customer reference number.string -
DataProvisions
List of credit applicant data provisions.ArrayObjectDataProvisionHolds data provision details.-
Code Mandatory
Data provision code.string -
Text
Data provision text.string -
Version
Data provision version.string
-
-
DateOfBirth
Date of birth of the credit applicant.DateTime -
Email
E-mail of the credit applicant.string -
EmployerName
Employer name.string -
EmployerPhone
Employer phone number.string -
EmploymentType
Employment type of the credit applicant.EnumEmploymentTypeEmployment type of person.-
StudentStudent. -
DisabilityPensionDisability pension. -
UnemployedUnemployed. -
TemporaryEmployedTemporary employed. -
PermanentEmployedPermanent employed. -
SelfEmployedSelf-employed. -
RetiredRetired.
-
-
ExtraFields
List of credit applicant extra fields.ArrayObjectExtraFieldExtra field contains custom data.-
Data
Value of extra field.string -
Name
Name of extra field.string
-
-
Firstname
FIrst name of the credit applicant.string -
Gender
Credit applicant gender.EnumGenderTypeGender of a person.-
FemaleFemale gender, a woman. -
MaleMale gender, a man. -
UnknownUnknown gender, or neither Female nor Male.
-
-
HomePhone
Home phone number of the credit applicant.string -
IdNumber
Credit applicant ID number.string -
InvoiceChannel
Preffered invoice channel, e.g. LETTER, E-INVOICE, EMAIL, SMS etc. Should be used one of predefined values using correct letter case.string -
JuridicalType
Type of credit applicant, juridically.EnumJuridicalTypeType of person, juridically.-
NaturalPersonActual person. -
JuridicalPersonJuridical person, e.g a company.
-
-
LanguageCode
Language code e.g. sv, en etc.string -
Lastname
Last name of the credit applicant.string -
MaritalStatus
Marital status.EnumMaritalStatusMarital status.-
UnmarriedUnmarried. -
MarriedMarried. -
CommonLawSpouseCommon law spouse. -
WidowWidow. -
DivorcedDivorced. -
PartnerPartner.
-
-
Middlename
Middle name of the credit applicant.string -
MonthlyCostForOtherCreditsAndLoans
Monthly cost of other credits and loans value.decimal -
MonthlyIncome
Monthly income value.decimal -
MonthlyRentalCost
Monthly rental cost.decimal -
NumberOfAdults
Number of adults.int -
NumberOfDependentChildren
Number of dependent children.int -
OtherSecuredLoans
Other secured loans value.decimal -
OtherTotalCreditsandLoans
Other total credits and loans value.decimal -
OtherUnsecuredLoans
Other unsecured loans value.decimal -
PlaceOfbirth
Place of birth of the credit applicant.string -
PreferredChannel
Preffered communication channel, e.g. LETTER, E-INVOICE, EMAIL, SMS etc. Should be used one of predefined values using correct letter case.string -
ResidentDescription
Resident description.string -
ShareOfAccommodationCost
Share of accommodation cost value.decimal -
Signed Mandatory
Credit applicant signed boolean flag.bool -
TypeOfResident
Type of resident.EnumTypeOfResidentType of resident.-
RentedApartmentRented apartment. -
CoOperativeApartmentCo-operative apartment. -
DetachedHouseDetached house. -
RoomerOrSecondHandRoomer or second hand.
-
-
WorkPhone
Work phone number of the credit applicant.string
-
-
MonthlyAmount
Monthly amount.decimal -
OriginalAppliedCreditAmount
Original applied credit amount.decimal -
OriginalDurationInMonths
The original application duration in months.int -
Payments
List of payments.ArrayObjectCreditApplicationPaymentPayment description type.-
Amount Mandatory
Payment amount.decimal -
Date Mandatory
Payment date.DateTime -
Fee Mandatory
Payment fee value.decimal -
Interest Mandatory
Payment interest value.decimal -
Principal Mandatory
Payment principal value.decimal
-
-
Reason
The application reason.string -
RegistrationFee
Registration fee.decimal -
SettlementFee
Settlement fee.decimal -
StartDate
The application start date.DateTime -
TotalCreditAmount
Total credit amount.decimal
-
-
Result Mandatory
The result of the request. Indicating success or error.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.int -
ResultText Mandatory
Text information of the result. Usually contains a warning or error message when result code is indicating other than success.string
-
-
GetCreditApplications
Examples
CreditApplicationClient client = new CreditApplicationClient();
GetCreditApplicationsResult result = client.GetCreditApplications(new GetCreditApplicationsRequest()
{
CustomerLookup = new CustomerLookup
{
CustomerIdentification = CustomerIdentificationType.CustomerSESSNOrCompanyNo,
CustomerIdentificationValue = "770714-2308",
}
});
Sample soap request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
<urn:GetCreditApplications>
<urn:GetCreditApplicationsRequest>
<urn:CustomerLookup>
<urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
<urn:CustomerIdentificationValue>470105-3151</urn:CustomerIdentificationValue>
</urn:CustomerLookup>
</urn:GetCreditApplicationsRequest>
</urn:GetCreditApplications>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectGetCreditApplicationsGetCreditApplications-
GetCreditApplicationsRequest
Get credit application request parameters.ObjectGetCreditApplicationsRequestThe GetCreditApplicationsRequest parameters.-
Active
Active or not active boolean flag.bool -
CustomerLookup
A lookup for customer.ObjectCustomerLookupA lookup for customer.-
CustomerIdentification Mandatory
Type of customer identification to look up.EnumCustomerIdentificationTypeCustomer identification type.-
CustomCustom identification. -
CustomerSESSNOrCompanyNoIdentify by Swedish SSN or company number. -
CustomerNOSSNOrCompanyNoIdentify by Norwegian SSN or company number. -
CustomerReferenceNumberIdentify by customer reference number. -
CustomerGuidCustomer identification.
-
-
CustomerIdentificationValue Mandatory
Customer identification to look up, depending on type it has different formats.string -
JuridicalType
Type of customer, e.g. physical.EnumCustomerJuridicalTypeJuridical type of the customer.-
PhysicalPhysical person, meaning a natural person. -
CompanyA company or other organisation. -
PersonalFirmA company that shares the juridical entity with a physical person.
-
-
-
CustomerOwnerReferenceFilter
Customer owner reference filter.string
-
-
Output
Error codes:
- 1 : error message from ARC server
GetCreditApplicationsResponse
-
GetCreditApplicationsResult
Result of GetCreditApplicationsObjectGetCreditApplicationsResultThe result of GetCreditApplications request.-
CreditApplications
List of returned credit appliations.ArrayObjectCreditApplicationInfoCredit application information.-
ActionFlowStatus
Account status informationObjectActionFlowAccount status information-
StatusCode
Status codestring -
StatusDate
Status dateDateTime -
StatusDescription
Status descriptionstring -
SubstatusCode
Substatus datestring -
SubstatusDate
Substatus dateDateTime -
SubstatusDescription
Substatus datestring
-
-
ApplicationDate Mandatory
The application creation date.DateTime -
AppliedCreditAmount Mandatory
Applied credit amount.decimal -
Broker
Broker party informationObjectBrokerPartyBroker party information-
FullName
Party namestring -
Guid
Guidstring -
InformalName
Party informal namestring -
ReferenceCode
Party reference codestring
-
-
CreditApplicationGuid Mandatory
Credit application GUID.string -
CustomerAccountTypeCode Mandatory
Customer account type code.string -
Disbursements
Loan disbursement informationArrayObjectLoanDisbursementLoan disbursement information-
Amount Mandatory
Amountdecimal -
CurrencyCode Mandatory
Currencystring -
DisbursementDate Mandatory
Operation dateDateTime
-
-
DurationOfCredit Mandatory
Duration of credit in months.int -
OriginalAppliedCreditAmount
Original applied credit amount.decimal -
OriginalDurationOfCredit
Original duration of credit in months.int -
Status Mandatory
Current status of the credit application.EnumCreditApplicationStatusStatus of credit application.-
NewApplicationNew credit application, initial state. -
AnalysisPending analysis of credit application. -
AwaitingConfirmationAwaiting confirmation for credit application. -
AwaitingAdditionalInfoAwaiting additional information for credit application. -
AwaitingSignatureAwaiting signature from customer. -
RejectedCredit application has been rejected. -
ApprovedCredit application has been approved. -
TerminatedCredit application has been terminated.
-
-
TotalCreditAmount Mandatory
Total credit amount.decimal
-
-
Result Mandatory
The result of the request. Indicating success or error.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.int -
ResultText Mandatory
Text information of the result. Usually contains a warning or error message when result code is indicating other than success.string
-
-
GetHistoryDocument
Examples
CreditApplicationClient client = new CreditApplicationClient();
GetHistoryDocumentResult result = client.GetHistoryDocument("0C1472C0-5732-4549-A45D-BF877A6E8C76");
Sample soap request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
<urn:GetHistoryDocument>
<urn:HistoryGuid>702DED94-84FE-4ED3-BF00-D60213ABCB62</urn:HistoryGuid>
</urn:GetHistoryDocument>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectGetHistoryDocumentGetHistoryDocument-
HistoryGuid
History action document's unique identifier.string
-
Output
Error codes:
- 1 : error message from ARC server
GetHistoryDocumentResponse
-
GetHistoryDocumentResult
Result of GetHistoryDocumentObjectGetHistoryDocumentResultGeneral class for representing method output.-
Data
Base64-encoded file body.string -
Extension
File extension.string -
FileName
File name.string -
Result
The result of the request. Indicating success or error.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.int -
ResultText Mandatory
Text information of the result. Usually contains a warning or error message when result code is indicating other than success.string
-
-
Ping
0 if everything went ok. If something went wrong
it will return a result code other than 0 and the result text will contain
information about error. However if service is unreachable, e.g. not started, the
service will not respond at all.Examples
CreditApplicationClient client = new CreditApplicationClient();
try
{
GeneralResult result = client.Ping();
if (result.Result.ResultCode != 0)
{
throw new Exception(result.Result.ResultText ?? "Unknown error");
}
}
catch(Exception e)
{
throw new Exception("Failed to ping credit application service.", e);
}
Sample soap request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
<urn:Ping/>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request data.ObjectPingPing
Output
0 if ping was successful, otherwise read result text for error information.
GeneralResultResponse
-
GeneralResult
Result of GeneralResultObjectGeneralResultA general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.int -
ResultText Mandatory
Text information of the result. Usually contains a warning or error message when result code is indicating other than success.string
-
-
RegisterCreditApplication
Examples
CreditApplicationClient client = new CreditApplicationClient();
RegisterCreditApplicationResult result = client.RegisterCreditApplication(new RegisterCreditApplicationRequest()
{
ClientReference = "1004",
CustomerAccountTypeCode = "LOAN",
CreditApplication = new CreditApplication.CreditApplication()
{
AppliedCreditAmount = 5423m,
ApplicationDate = new DateTime(2018, 11, 20),
StartDate = new DateTime(2018, 11, 25),
DurationInMonths = 12,
Reason = "Some reason",
InterestRate = 5,
InterestCode = "360"
},
MainApplicant = new CreditApplicant()
{
IdNumber = "380607-0441",
JuridicalType = JuridicalType.NaturalPerson,
Firstname = "Lilly",
Lastname = "Nordström"
}
});
Sample soap request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
<urn:RegisterCreditApplication>
<urn:RegisterCreditApplicationRequest>
<urn:ClientReference>1004</urn:ClientReference>
<urn:CreditApplication>
<urn:ApplicationDate>2018-11-20</urn:ApplicationDate>
<urn:AppliedCreditAmount>5423</urn:AppliedCreditAmount>
<urn:DurationInMonths>12</urn:DurationInMonths>
<urn:InterestCode>360</urn:InterestCode>
<urn:InterestRate>5</urn:InterestRate>
<urn:Reason>Some reason</urn:Reason>
<urn:StartDate>2018-11-25</urn:StartDate>
</urn:CreditApplication>
<urn:CustomerAccountTypeCode>LOAN</urn:CustomerAccountTypeCode>
<urn:MainApplicant>
<urn:Firstname>Lilly</urn:Firstname>
<urn:IdNumber>380607-0441</urn:IdNumber>
<urn:JuridicalType>NaturalPerson</urn:JuridicalType>
<urn:Lastname>Nordström</urn:Lastname>
</urn:MainApplicant>
</urn:RegisterCreditApplicationRequest>
</urn:RegisterCreditApplication>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectRegisterCreditApplicationRegisterCreditApplication-
RegisterCreditApplicationRequest
Credit application detailed information.ObjectRegisterCreditApplicationRequestThe RegisterCreditApplicationRequest parameters with credit application details.-
BrokerPartyReference
Credit application details.string -
ClientReference Mandatory
client reference string.string -
CoApplicants
List of credit co-applicants.ArrayObjectCreditApplicantCredit applicant details.-
Addresses
List of credit applicant adresses.ArrayObjectAddressHolds address information.-
CareOf
Care of address.string -
City
City.string -
CountryCode
Country code, i.e. EN, SE etc.string -
DefaultAddress
Whether this is the default address.bool -
FullAddress
Combined address with all fields into single string.string -
FullName
The full name of the receiving party, i.e name of person or company.string -
HouseNo
House number.string -
HouseNoExtension
House number extension.string -
StateCode
State code if applicable.string -
Street
Street address.string -
TypeCode Mandatory
The type code of the address, i.e. what the address is used for, e.g. LEGAL, AVI, INVOICE, SITE, DELIVERY, TRUSTACCNT. Should be used one of predefined values using correct letter case.string -
UpdateExisting
Whether this should update existing or create new address.bool -
ValidFrom
The date when the address becomes active. If the element is missing, then do not change the current actual value.DateTime -
ValidTo
The date after which the address becomes inactive. If the element is missing, then do not change the current actual value.DateTime -
ZipCode
Zip code, i.e. postal code.string
-
-
AnnualIncome
Annual income value.decimal -
BankAccountInfo
Bank account information.ObjectBankAccountInfoBank account information.-
BankAccountNo Mandatory
Bank account number.string -
BankCode
Bank code.string -
BankDescription
Bank description.string -
BankName
Bank name.string -
Bic
BIC code.string -
Blz
BLZ code.string -
CountryCode Mandatory
Country code, e.g. SE, NO, NL etc.string -
CurrencyCode
Currency code, e.g. SEK, NOK, EUR etc.string -
Iban
IBAN number.string -
Swift
SWIFT code.string
-
-
CellularPhone
Cellular phone number of the credit applicant.string -
CurrencyCode
Currency code, e.g. SEK, NOK, EUR etc.string -
CurrentCustomerGuid
Unique identifier of current customer.string -
CustomerReference
Customer reference number.string -
DataProvisions
List of data provisions.ArrayObjectDataProvisionHolds data provision details.-
Code Mandatory
Data provision code.string -
Text
Data provision text.string -
Version
Data provision version.string
-
-
DateOfBirth
Date of birth of the credit applicant.DateTime -
Email
E-mail of the credit applicant.string -
EmployerName
Employer name.string -
EmployerPhone
Employer phone number.string -
EmploymentType
Employment type of the credit applicant.EnumEmploymentTypeEmployment type of person.-
StudentStudent. -
DisabilityPensionDisability pension. -
UnemployedUnemployed. -
TemporaryEmployedTemporary employed. -
PermanentEmployedPermanent employed. -
SelfEmployedSelf-employed. -
RetiredRetired.
-
-
ExtraFields
List of extra fields.ArrayObjectExtraFieldExtra field contains custom data.-
Data
Value of extra field.string -
Name
Name of extra field.string
-
-
Firstname Mandatory
First name of the credit applicant.string -
Gender
Credit applicant gender.EnumGenderTypeGender of a person.-
FemaleFemale gender, a woman. -
MaleMale gender, a man. -
UnknownUnknown gender, or neither Female nor Male.
-
-
HomePhone
Home phone number of the credit applicant.string -
IdNumber
Credit applicant ID number.string -
InvoiceChannel
Preffered invoice channel, e.g. LETTER, E-INVOICE, EMAIL, SMS etc. Should be used one of predefined values using correct letter case.string -
JuridicalType
Type of credit applicant, juridically.EnumJuridicalTypeType of person, juridically.-
NaturalPersonActual person. -
JuridicalPersonJuridical person, e.g a company.
-
-
LanguageCode
Language code e.g. sv, en etc.string -
Lastname Mandatory
Last name of the credit applicant.string -
MaritalStatus
Marital status.EnumMaritalStatusMarital status.-
UnmarriedUnmarried. -
MarriedMarried. -
CommonLawSpouseCommon law spouse. -
WidowWidow. -
DivorcedDivorced. -
PartnerPartner.
-
-
Middlename
Middle name of the credit applicant.string -
MonthlyCostForOtherCreditsAndLoans
Monthly cost of other credits and loans value.decimal -
MonthlyIncome
Monthly income value.decimal -
MonthlyRentalCost
Monthly rental cost.decimal -
NumberOfAdults
Number of adults.int -
NumberOfDependentChildren
Number of dependent children.int -
OtherSecuredLoans
Other secured loans value.decimal -
OtherTotalCreditsandLoans
Other total credits and loans value.decimal -
OtherUnsecuredLoans
Other unsecured loans value.decimal -
PlaceOfbirth
Place of birth of the credit applicant.string -
PreferredChannel
Preffered communication channel, e.g. LETTER, E-INVOICE, EMAIL, SMS etc. Should be used one of predefined values using correct letter case.string -
ResidentDescription
Resident description.string -
ShareOfAccommodationCost
Share of accomodation cost.decimal -
TypeOfResident
Type of resident.EnumTypeOfResidentType of resident.-
RentedApartmentRented apartment. -
CoOperativeApartmentCo-operative apartment. -
DetachedHouseDetached house. -
RoomerOrSecondHandRoomer or second hand.
-
-
WorkPhone
Work phone number of the credit applicant.string
-
-
CreditApplication Mandatory
Credit application details.ObjectCreditApplicationCredit application description.-
ApplicationDate Mandatory
The application creation date.DateTime -
AppliedCreditAmount Mandatory
Applied credit amount.decimal -
DataProvisions
The list of data provisions for the application.ArrayObjectDataProvisionHolds data provision details.-
Code Mandatory
Data provision code.string -
Text
Data provision text.string -
Version
Data provision version.string
-
-
DurationInMonths Mandatory
The application duration in months.int -
ExtraFields
The list of extra fields for the application.ArrayObjectExtraFieldExtra field contains custom data.-
Data
Value of extra field.string -
Name
Name of extra field.string
-
-
InterestCode
The interest code of application.string -
InterestRate
The interest rate of application.decimal -
OriginalAppliedCreditAmount
Original applied credit amount.decimal -
OriginalDurationInMonths
The original application duration in months.int -
Reason
The application reason.string -
StartDate
The application start date.DateTime
-
-
CustomerAccountTypeCode Mandatory
CustomerAccount type code.string -
LoansToSettle
List of loans to settle.ArrayObjectLoanToSettleLoan to settle data type.-
AccruedInterest
Accrued interest value.decimal -
BankAccountNo Mandatory
Bank account number.string -
BankCode
Bank code.string -
BankCurrencyCode Mandatory
Bank currency code, e.g. SEK, NOK, EUR etc.string -
BankDescription
Bank description.string -
BankName Mandatory
Bank name.string -
Bic
BIC code.string -
Blz
BLZ code.string -
CountryCode Mandatory
Bank country code, e.g. SE, NO, NL etc.string -
CurrencyCode Mandatory
Currency code, e.g. SEK, NOK, EUR etc.string -
DisburSementDate
Disbursment date.DateTime -
Fees
Fees value.decimal -
Iban
IBAN number.string -
LoanReferenceNumber
Loan reference number.string -
NetInterestLossCompensation
Net interest loss compensation value.decimal -
PaymentReferenceNumber
Payment reference number.string -
PrincipalAmount
Principal amount.decimal -
SettlementAmount Mandatory
Settlement amount.decimal -
Swift
SWIFT code.string
-
-
MainApplicant Mandatory
Main credit applicant details.ObjectCreditApplicantCredit applicant details.-
Addresses
List of credit applicant adresses.ArrayObjectAddressHolds address information.-
CareOf
Care of address.string -
City
City.string -
CountryCode
Country code, i.e. EN, SE etc.string -
DefaultAddress
Whether this is the default address.bool -
FullAddress
Combined address with all fields into single string.string -
FullName
The full name of the receiving party, i.e name of person or company.string -
HouseNo
House number.string -
HouseNoExtension
House number extension.string -
StateCode
State code if applicable.string -
Street
Street address.string -
TypeCode Mandatory
The type code of the address, i.e. what the address is used for, e.g. LEGAL, AVI, INVOICE, SITE, DELIVERY, TRUSTACCNT. Should be used one of predefined values using correct letter case.string -
UpdateExisting
Whether this should update existing or create new address.bool -
ValidFrom
The date when the address becomes active. If the element is missing, then do not change the current actual value.DateTime -
ValidTo
The date after which the address becomes inactive. If the element is missing, then do not change the current actual value.DateTime -
ZipCode
Zip code, i.e. postal code.string
-
-
AnnualIncome
Annual income value.decimal -
BankAccountInfo
Bank account information.ObjectBankAccountInfoBank account information.-
BankAccountNo Mandatory
Bank account number.string -
BankCode
Bank code.string -
BankDescription
Bank description.string -
BankName
Bank name.string -
Bic
BIC code.string -
Blz
BLZ code.string -
CountryCode Mandatory
Country code, e.g. SE, NO, NL etc.string -
CurrencyCode
Currency code, e.g. SEK, NOK, EUR etc.string -
Iban
IBAN number.string -
Swift
SWIFT code.string
-
-
CellularPhone
Cellular phone number of the credit applicant.string -
CurrencyCode
Currency code, e.g. SEK, NOK, EUR etc.string -
CurrentCustomerGuid
Unique identifier of current customer.string -
CustomerReference
Customer reference number.string -
DataProvisions
List of data provisions.ArrayObjectDataProvisionHolds data provision details.-
Code Mandatory
Data provision code.string -
Text
Data provision text.string -
Version
Data provision version.string
-
-
DateOfBirth
Date of birth of the credit applicant.DateTime -
Email
E-mail of the credit applicant.string -
EmployerName
Employer name.string -
EmployerPhone
Employer phone number.string -
EmploymentType
Employment type of the credit applicant.EnumEmploymentTypeEmployment type of person.-
StudentStudent. -
DisabilityPensionDisability pension. -
UnemployedUnemployed. -
TemporaryEmployedTemporary employed. -
PermanentEmployedPermanent employed. -
SelfEmployedSelf-employed. -
RetiredRetired.
-
-
ExtraFields
List of extra fields.ArrayObjectExtraFieldExtra field contains custom data.-
Data
Value of extra field.string -
Name
Name of extra field.string
-
-
Firstname Mandatory
First name of the credit applicant.string -
Gender
Credit applicant gender.EnumGenderTypeGender of a person.-
FemaleFemale gender, a woman. -
MaleMale gender, a man. -
UnknownUnknown gender, or neither Female nor Male.
-
-
HomePhone
Home phone number of the credit applicant.string -
IdNumber
Credit applicant ID number.string -
InvoiceChannel
Preffered invoice channel, e.g. LETTER, E-INVOICE, EMAIL, SMS etc. Should be used one of predefined values using correct letter case.string -
JuridicalType
Type of credit applicant, juridically.EnumJuridicalTypeType of person, juridically.-
NaturalPersonActual person. -
JuridicalPersonJuridical person, e.g a company.
-
-
LanguageCode
Language code e.g. sv, en etc.string -
Lastname Mandatory
Last name of the credit applicant.string -
MaritalStatus
Marital status.EnumMaritalStatusMarital status.-
UnmarriedUnmarried. -
MarriedMarried. -
CommonLawSpouseCommon law spouse. -
WidowWidow. -
DivorcedDivorced. -
PartnerPartner.
-
-
Middlename
Middle name of the credit applicant.string -
MonthlyCostForOtherCreditsAndLoans
Monthly cost of other credits and loans value.decimal -
MonthlyIncome
Monthly income value.decimal -
MonthlyRentalCost
Monthly rental cost.decimal -
NumberOfAdults
Number of adults.int -
NumberOfDependentChildren
Number of dependent children.int -
OtherSecuredLoans
Other secured loans value.decimal -
OtherTotalCreditsandLoans
Other total credits and loans value.decimal -
OtherUnsecuredLoans
Other unsecured loans value.decimal -
PlaceOfbirth
Place of birth of the credit applicant.string -
PreferredChannel
Preffered communication channel, e.g. LETTER, E-INVOICE, EMAIL, SMS etc. Should be used one of predefined values using correct letter case.string -
ResidentDescription
Resident description.string -
ShareOfAccommodationCost
Share of accomodation cost.decimal -
TypeOfResident
Type of resident.EnumTypeOfResidentType of resident.-
RentedApartmentRented apartment. -
CoOperativeApartmentCo-operative apartment. -
DetachedHouseDetached house. -
RoomerOrSecondHandRoomer or second hand.
-
-
WorkPhone
Work phone number of the credit applicant.string
-
-
-
Output
Error codes:
- 1 : Specified argument was out of the range of valid values.
- 1 : Error in the application.
- 1 : error message from ARC server
RegisterCreditApplicationResponse
-
RegisterCreditApplicationResult
Result of RegisterCreditApplicationObjectRegisterCreditApplicationResultThe result of the RegisterCreditApplication request.-
CreditApplication
Credit application information.ObjectCreditApplicationInfoCredit application information.-
ActionFlowStatus
Account status informationObjectActionFlowAccount status information-
StatusCode
Status codestring -
StatusDate
Status dateDateTime -
StatusDescription
Status descriptionstring -
SubstatusCode
Substatus datestring -
SubstatusDate
Substatus dateDateTime -
SubstatusDescription
Substatus datestring
-
-
ApplicationDate Mandatory
The application creation date.DateTime -
AppliedCreditAmount Mandatory
Applied credit amount.decimal -
Broker
Broker party informationObjectBrokerPartyBroker party information-
FullName
Party namestring -
Guid
Guidstring -
InformalName
Party informal namestring -
ReferenceCode
Party reference codestring
-
-
CreditApplicationGuid Mandatory
Credit application GUID.string -
CustomerAccountTypeCode Mandatory
Customer account type code.string -
Disbursements
Loan disbursement informationArrayObjectLoanDisbursementLoan disbursement information-
Amount Mandatory
Amountdecimal -
CurrencyCode Mandatory
Currencystring -
DisbursementDate Mandatory
Operation dateDateTime
-
-
DurationOfCredit Mandatory
Duration of credit in months.int -
OriginalAppliedCreditAmount
Original applied credit amount.decimal -
OriginalDurationOfCredit
Original duration of credit in months.int -
Status Mandatory
Current status of the credit application.EnumCreditApplicationStatusStatus of credit application.-
NewApplicationNew credit application, initial state. -
AnalysisPending analysis of credit application. -
AwaitingConfirmationAwaiting confirmation for credit application. -
AwaitingAdditionalInfoAwaiting additional information for credit application. -
AwaitingSignatureAwaiting signature from customer. -
RejectedCredit application has been rejected. -
ApprovedCredit application has been approved. -
TerminatedCredit application has been terminated.
-
-
TotalCreditAmount Mandatory
Total credit amount.decimal
-
-
Result Mandatory
The result of the request. Indicating success or error.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.int -
ResultText Mandatory
Text information of the result. Usually contains a warning or error message when result code is indicating other than success.string
-
-
RegisterRaiseCredit
Examples
CreditApplication1Client client = new CreditApplication1Client();
client.RegisterRaiseCredit(null, new RegisterRaiseCreditReq()
{
ClientReference = "1004",
CreditDebtNo = "30000008802",
CreditApplication = new RaiseCreditApplication()
{
ApplicationDate = DateTime.Today,
AppliedCreditAmount = 10000.00m,
DurationInMonths = 12,
InterestCode = "FIXED",
InterestRate = 10m,
Reason = "For some reason",
StartDate = DateTime.Today.AddDays(30)
}
}, out RegisterRaiseCreditResp resp);
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Body>
<urn:RegisterRaiseCreditReqContract>
<urn:RegisterRaiseCreditReq>
<urn:ClientReference>1004</urn:ClientReference>
<urn:CreditDebtNo>30000008802</urn:CreditDebtNo>
<urn:CreditApplication>
<urn:AppliedCreditAmount>10000</urn:AppliedCreditAmount>
<urn:ApplicationDate>2021-07-09</urn:ApplicationDate>
<urn:StartDate>2021-07-09</urn:StartDate>
<urn:DurationInMonths>12</urn:DurationInMonths>
<urn:Reason>rrere dfd ert rtdf</urn:Reason>
<urn:InterestRate>10</urn:InterestRate>
<urn:InterestCode>FIXED</urn:InterestCode>
</urn:CreditApplication>
</urn:RegisterRaiseCreditReq>
</urn:RegisterRaiseCreditReqContract>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Raise credit request dataObjectRegisterRaiseCreditReqContractRaise credit limit-
RegisterRaiseCreditReq
Raise credit limitObjectRegisterRaiseCreditReqRegisterRaiseCredit arguments-
ClientReference Mandatory
Client reference string.string -
CreditApplication Mandatory
Credit application details.ObjectRaiseCreditApplicationRaise credit application description.-
ApplicationDate Mandatory
The application creation date.DateTime -
AppliedCreditAmount Mandatory
Applied credit amount.decimal -
ExtraFields
The list of extra fields for the application.ArrayObjectExtraFieldExtra field contains custom data.-
Data
Value of extra field.string -
Name
Name of extra field.string
-
-
InterestCode
The interest code of application.string -
InterestRate
The interest rate of application.decimal -
Reason
The application reason.string -
StartDate
The application start date/agreement date.DateTime -
DurationInMonths Mandatory
The application duration in months.int
-
-
CreditDebtNo Mandatory
Credit debt number.string -
LoansToSettle
List of loans to settle.ArrayObjectLoanToSettleLoan to settle data type.-
AccruedInterest
Accrued interest value.decimal -
BankAccountNo Mandatory
Bank account number.string -
BankCode
Bank code.string -
BankCurrencyCode Mandatory
Bank currency code, e.g. SEK, NOK, EUR etc.string -
BankDescription
Bank description.string -
BankName Mandatory
Bank name.string -
Bic
BIC code.string -
Blz
BLZ code.string -
CountryCode Mandatory
Bank country code, e.g. SE, NO, NL etc.string -
CurrencyCode Mandatory
Currency code, e.g. SEK, NOK, EUR etc.string -
DisburSementDate
Disbursment date.DateTime -
Fees
Fees value.decimal -
Iban
IBAN number.string -
LoanReferenceNumber
Loan reference number.string -
NetInterestLossCompensation
Net interest loss compensation value.decimal -
PaymentReferenceNumber
Payment reference number.string -
PrincipalAmount
Principal amount.decimal -
SettlementAmount Mandatory
Settlement amount.decimal -
Swift
SWIFT code.string
-
-
-
Output
- -1 generic error
RegisterRaiseCreditRespContract
-
RegisterRaiseCreditResp
Raise credit response dataObjectRegisterRaiseCreditRespRaise credit response data-
Result Mandatory
The result of the request. Indicating success or error.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.int -
ResultText Mandatory
Text information of the result. Usually contains a warning or error message when result code is indicating other than success.string
-
-
SetPaymentAsFreeMonth
Examples
CreditApplicationClient client = new CreditApplicationClient();
GeneralResult result = client.SetPaymentAsFreeMonth(new SetPaymentAsFreeMonthRequest()
{
CreditDebtNo = "30000008674",
CustomerLookup = new CustomerLookup
{
CustomerIdentification = CustomerIdentificationType.CustomerSESSNOrCompanyNo,
CustomerIdentificationValue = "770714-2308",
},
PaymentNo = 1
});
Sample soap request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b" xmlns:apt="http://schemas.datacontract.org/2004/07/Aptic.WebIntegrationPlatform.Soap.DataContracts.CreditApplication">
<soapenv:Header/>
<soapenv:Body>
<urn:SetPaymentAsFreeMonth>
<urn:setPaymentAsFreeMonthRequest>
<apt:CreditDebtNo>30000008674</apt:CreditDebtNo>
<apt:CustomerLookup>
<urn:CustomerIdentification>CustomerSESSNOrCompanyNo</urn:CustomerIdentification>
<urn:CustomerIdentificationValue>770714-2308</urn:CustomerIdentificationValue>
</apt:CustomerLookup>
<apt:PaymentNo>1</apt:PaymentNo>
</urn:setPaymentAsFreeMonthRequest>
</urn:SetPaymentAsFreeMonth>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectSetPaymentAsFreeMonthSetPaymentAsFreeMonth.-
setPaymentAsFreeMonthRequest
Set payment as free months request parameters. CreditDebtNo, CustomerLookup and PaymentNo are mandatory parametersObjectSetPaymentAsFreeMonthRequestThe SetPaymentAsFreeMonthRequest parameters.-
CreditDebtNo Mandatory
Credit debt number.string -
CustomerLookup Mandatory
A lookup for customer.ObjectCustomerLookupA lookup for customer.-
CustomerIdentification Mandatory
Type of customer identification to look up.EnumCustomerIdentificationTypeCustomer identification type.-
CustomCustom identification. -
CustomerSESSNOrCompanyNoIdentify by Swedish SSN or company number. -
CustomerNOSSNOrCompanyNoIdentify by Norwegian SSN or company number. -
CustomerReferenceNumberIdentify by customer reference number. -
CustomerGuidCustomer identification.
-
-
CustomerIdentificationValue Mandatory
Customer identification to look up, depending on type it has different formats.string -
JuridicalType
Type of customer, e.g. physical.EnumCustomerJuridicalTypeJuridical type of the customer.-
PhysicalPhysical person, meaning a natural person. -
CompanyA company or other organisation. -
PersonalFirmA company that shares the juridical entity with a physical person.
-
-
-
PaymentNo
Payment number.int
-
-
Output
0 if request was successful, otherwise read result text for error information.
Error codes:
- 1 : Specified argument was out of the range of valid values.
- 1 : Error in the application.
- 1 : error message from ARC server
SetPaymentAsFreeMonthResponse
-
SetPaymentAsFreeMonthResult
Result of SetPaymentAsFreeMonth.ObjectGeneralResultA general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.int -
ResultText Mandatory
Text information of the result. Usually contains a warning or error message when result code is indicating other than success.string
-
-
TerminateCreditApplication
Examples
CreditApplicationClient client = new CreditApplicationClient();
TerminateCreditApplicationResult result = client.TerminateCreditApplication(new TerminateCreditApplicationRequest()
{
CreditApplicationGuid = "C80F76D8-8B2D-4619-BE92-2070795A04C1"
});
Sample soap request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
<urn:TerminateCreditApplication>
<urn:TerminateCreditApplicationRequest>
<urn:CreditApplicationGuid>EAAB478D-E04E-4DDA-911E-F3F4332FF427</urn:CreditApplicationGuid>
<!--Optional:-->
<urn:Reason>Reason description</urn:Reason>
</urn:TerminateCreditApplicationRequest>
</urn:TerminateCreditApplication>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectTerminateCreditApplicationTerminateCreditApplication-
TerminateCreditApplicationRequest
Credit application termination details.ObjectTerminateCreditApplicationRequestThe TerminateCreditApplicationRequest parameters with credit application GUID and termination reason.-
CreditApplicationGuid Mandatory
Credit application GUID.string -
Reason
Credit application termination reason.string
-
-
Output
Error codes:
- 1 : error message from ARC server
TerminateCreditApplicationResponse
-
TerminateCreditApplicationResult
TerminateCreditApplication resultObjectTerminateCreditApplicationResultThe result of TerminateCreditApplication request.-
CreditApplication
Details of the terminated credit application.ObjectCreditApplicationInfoCredit application information.-
ActionFlowStatus
Account status informationObjectActionFlowAccount status information-
StatusCode
Status codestring -
StatusDate
Status dateDateTime -
StatusDescription
Status descriptionstring -
SubstatusCode
Substatus datestring -
SubstatusDate
Substatus dateDateTime -
SubstatusDescription
Substatus datestring
-
-
ApplicationDate Mandatory
The application creation date.DateTime -
AppliedCreditAmount Mandatory
Applied credit amount.decimal -
Broker
Broker party informationObjectBrokerPartyBroker party information-
FullName
Party namestring -
Guid
Guidstring -
InformalName
Party informal namestring -
ReferenceCode
Party reference codestring
-
-
CreditApplicationGuid Mandatory
Credit application GUID.string -
CustomerAccountTypeCode Mandatory
Customer account type code.string -
Disbursements
Loan disbursement informationArrayObjectLoanDisbursementLoan disbursement information-
Amount Mandatory
Amountdecimal -
CurrencyCode Mandatory
Currencystring -
DisbursementDate Mandatory
Operation dateDateTime
-
-
DurationOfCredit Mandatory
Duration of credit in months.int -
OriginalAppliedCreditAmount
Original applied credit amount.decimal -
OriginalDurationOfCredit
Original duration of credit in months.int -
Status Mandatory
Current status of the credit application.EnumCreditApplicationStatusStatus of credit application.-
NewApplicationNew credit application, initial state. -
AnalysisPending analysis of credit application. -
AwaitingConfirmationAwaiting confirmation for credit application. -
AwaitingAdditionalInfoAwaiting additional information for credit application. -
AwaitingSignatureAwaiting signature from customer. -
RejectedCredit application has been rejected. -
ApprovedCredit application has been approved. -
TerminatedCredit application has been terminated.
-
-
TotalCreditAmount Mandatory
Total credit amount.decimal
-
-
Result Mandatory
The result of the request. Indicating success or error.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.int -
ResultText Mandatory
Text information of the result. Usually contains a warning or error message when result code is indicating other than success.string
-
-
WaitForLoanActivation
Examples
CreditApplicationClient client = new CreditApplicationClient();
WaitForLoanActivationResult result = client.WaitForLoanActivation("2911A789-9BFD-4BB6-9C7E-CF8C8CDFB992", 500);
Sample soap request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:uuid:e657a351-ae8c-42c5-b083-ebe5dcda5c0b">
<soapenv:Header/>
<soapenv:Body>
<urn:WaitForLoanActivation>
<urn:AccountGuid>2911A789-9BFD-4BB6-9C7E-CF8C8CDFB992</urn:AccountGuid>
<urn:Timeout>500</urn:Timeout>
</urn:WaitForLoanActivation>
</soapenv:Body>
</soapenv:Envelope>Input
-
request Mandatory
Request dataObjectWaitForLoanActivationWaitForLoanActivation.-
AccountGuid
The account identifier for a loan.string -
Timeout
Optionally set timeout to wait for result.int
-
Output
Error codes:
- 1 : error message from ARC server
WaitForLoanActivationResponse
-
WaitForLoanActivationResult
Result of WaitForLoanActivation.ObjectWaitForLoanActivationResultThe result of checking for loan activation.-
Active
Is loan active.bool -
Result
The result of the request.ObjectResultTypeCommon result type.-
ResultCode Mandatory
The result code0means ok, anything else usually indicates a warning or an error. Look at accompanying result text for more details on result.int -
ResultText Mandatory
Text information of the result. Usually contains a warning or error message when result code is indicating other than success.string
-
-
Statuses
Requested loan statuses.ArrayEnumStatusLoan status.-
ClosedLoan has been closed. -
OnHoldLoan is currently on hold. -
OverdraftLoan has been overdrawn. -
ReminderLoan has sent payment reminder. -
DebtCollectionLoan has been sent to debt collection. -
CreditStopLoan has had credit stopped. -
ManualCreditStopLoan has had credit stopped manually. -
RespiteLoan has payment respite. -
DeceasedDebtor has deceased. -
OriginationLoan in the phase of origination, to be activated. -
DeclinedLoan was declined. -
PreRedemptionLoan redeemed earlier than planned. -
TerminationLoan has been terminated. -
UsedRightToWithdrawDebtor has used right to withdraw. -
PreTerminationLoan is in pre termination state.
-
-