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 dataObjectActionEvent
ActionEvent-
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.EnumActionBaseType
ActionBaseType.-
Undefined
Undefined. -
CollectionAccount
CollectionAccount. -
PaymentPlan
PaymentPlan. -
Legal
Legal. -
Offer
Offer. -
Bankruptcy
Bankruptcy. -
Deceased
Deceased. -
DebtRelief
DebtRelief. -
CompanyReorganisation
CompanyReorganisation. -
Debtor
Debtor. -
LedgerAccount
LedgerAccount. -
LedgerAccountGroup
LedgerAccountGroup. -
Ticket
Ticket. -
CollectionAccountGroup
CollectionAccountGroup.
-
-
EventType
Value corresponding to event type code in action events.EnumActionEventType
ActionEventType.-
STARTUP
STARTUP. -
TIMEOUT
TIMEOUT. -
USER_ALTERNATIVE
USER_ALTERNATIVE. -
TIMER
TIMER. -
DECISION
DECISION. -
UNKNOWN
UNKNOWN. -
PAYMENT
PAYMENT. -
PAYMENT_AUTHORITY
PAYMENT_AUTHORITY. -
CUSTOM
CUSTOM. -
VERIFICATION
VERIFICATION. -
MESSAGE_SENT
MESSAGE_SENT. -
AMOUNTADJUSTMENT
AMOUNTADJUSTMENT. -
NEWINVOICEADDED
NEWINVOICEADDED. -
NEWDEBTORADDED
NEWDEBTORADDED. -
FULLPAYMENT
FULLPAYMENT. -
CLOSURE
CLOSURE. -
NEWACCOUNTADDED
NEWACCOUNTADDED. -
MESSAGE_CONFIRMED
MESSAGE_CONFIRMED. -
MESSAGE_CONFIRM_FAILED
MESSAGE_CONFIRM_FAILED. -
PROCESSINGERROR
PROCESSINGERROR. -
OBJECTION
OBJECTION. -
CREDIT_ANSWER
CREDIT_ANSWER. -
ACTIONGROUPING_IGNORED
ACTIONGROUPING_IGNORED. -
DEBTOR_NEW_ADDRESS
DEBTOR_NEW_ADDRESS. -
DEBTOR_ADDRESS_NOTVALID
DEBTOR_ADDRESS_NOTVALID. -
DEBTOR_UPDATE
DEBTOR_UPDATE. -
PP_FIRST_PAYMENT_ADVICE
PP_FIRST_PAYMENT_ADVICE. -
PP_PAYMENT_ADVICE
PP_PAYMENT_ADVICE. -
PP_LAST_PAYMENT_ADVICE
PP_LAST_PAYMENT_ADVICE. -
PP_MISSED_PAYMENT
PP_MISSED_PAYMENT. -
PP_BROKEN_AGREEMENT
PP_BROKEN_AGREEMENT. -
PP_REMINDER
PP_REMINDER. -
PP_PAYMENT
PP_PAYMENT. -
PP_PARTPAYMENT
PP_PARTPAYMENT. -
PP_EXTERNAL_PAYMENT
PP_EXTERNAL_PAYMENT. -
PP_EXTERNAL_ADJUSTMENT
PP_EXTERNAL_ADJUSTMENT. -
PP_FIRSTPAYMENT
PP_FIRSTPAYMENT. -
PP_COMPLETED
PP_COMPLETED. -
PP_LATE_PAYMENT_ADVICE
PP_LATE_PAYMENT_ADVICE. -
PP_REMINDER_AND_ADVICE
PP_REMINDER_AND_ADVICE. -
PP_STOPPED
PP_STOPPED. -
PP_REPLACED
PP_REPLACED. -
PP_ACTIVATED
PP_ACTIVATED. -
LEGAL_VERDICT
LEGAL_VERDICT. -
LEGAL_RENEWAL
LEGAL_RENEWAL. -
LEGAL_CASEINFO
LEGAL_CASEINFO. -
LEGAL_REPORT
LEGAL_REPORT. -
LEGAL_LEX
LEGAL_LEX. -
LEGAL_BECOMINGFINAL
LEGAL_BECOMINGFINAL. -
LEGAL_FINALPAYMENT
LEGAL_FINALPAYMENT. -
LEGAL_NEWLEGALDOCUMENT
LEGAL_NEWLEGALDOCUMENT. -
LEGAL_FI_SUMMONS_ERROR
LEGAL_FI_SUMMONS_ERROR. -
CUSTOMER_UPDATE
CUSTOMER_UPDATE. -
CUSTOMER_ADDRESS_NOTVALID
CUSTOMER_ADDRESS_NOTVALID. -
BANKRUPTCY_ADDED
BANKRUPTCY_ADDED. -
DECEASED_ADDED
DECEASED_ADDED. -
DEBTRELIEF_ADDED
DEBTRELIEF_ADDED. -
DEBTRELIEF_UPDATED
DEBTRELIEF_UPDATED. -
COMPANYREORGANISATION_ADDED
COMPANYREORGANISATION_ADDED. -
TRANSACTION_IMPORTED
TRANSACTION_IMPORTED. -
PRINTLETTER_CONDITION_FALSE
PRINTLETTER_CONDITION_FALSE. -
INTEREST_INVOICING_INFO_CREATED
INTEREST_INVOICING_INFO_CREATED. -
INTEREST_INVOICING_INFO_DELETED
INTEREST_INVOICING_INFO_DELETED. -
DUE_DATE_CHANGED
DUE_DATE_CHANGED. -
AUTOTRANSFER_EVENT
AUTOTRANSFER_EVENT. -
OFFER_PAID_IN_FULL
OFFER_PAID_IN_FULL. -
USER_QUESTION_ANSWER
USER_QUESTION_ANSWER. -
CUSTOMERACCOUNT_FIRST_SETTLEMENT
CUSTOMERACCOUNT_FIRST_SETTLEMENT. -
CUSTOMERACCOUNT_SETTLEMENT
CUSTOMERACCOUNT_SETTLEMENT. -
CUSTOMERACCOUNT_LAST_SETTLEMENT
CUSTOMERACCOUNT_LAST_SETTLEMENT. -
CUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAY
CUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAY. -
CUSTOMERACCOUNT_BROKEN_SETTLEMENT
CUSTOMERACCOUNT_BROKEN_SETTLEMENT. -
CUSTOMERACCOUNT_REMINDER
CUSTOMERACCOUNT_REMINDER. -
CUSTOMERACCOUNT_PAYMENT
CUSTOMERACCOUNT_PAYMENT. -
CUSTOMERACCOUNT_PARTPAYMENT
CUSTOMERACCOUNT_PARTPAYMENT. -
CUSTOMERACCOUNT_PAYMENTFREE_SETTLEMENT
CUSTOMERACCOUNT_PAYMENTFREE_SETTLEMENT. -
CUSTOMERACCOUNT_DEBTCOLLECTION
CUSTOMERACCOUNT_DEBTCOLLECTION. -
CUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAY_INCLUDING_CAMPAIGN
CUSTOMERACCOUNT_MISSED_PAYMENT_MINIMUM_TO_PAY_INCLUDING_CAMPAIGN. -
CUSTOMERACCOUNT_STATEMENTOFACCOUNT
ccCUSTOMERACCOUNT_STATEMENTOFACCOUNT. -
CUSTOMERACCOUNT_CREDITSTOPCAUSE_ADDED
CUSTOMERACCOUNT_CREDITSTOPCAUSE_ADDED. -
CUSTOMERACCOUNT_CREDITSTOPCAUSE_REMOVED
CUSTOMERACCOUNT_CREDITSTOPCAUSE_REMOVED. -
CUSTOMERACCOUNT_CAMPAIGNEVENT
CUSTOMERACCOUNT_CAMPAIGNEVENT. -
CUSTOMERACCOUNT_CAMPAIGN_CREATED_RETROACTIVELY
CUSTOMERACCOUNT_CAMPAIGN_CREATED_RETROACTIVELY. -
CUSTOMERACCOUNT_CAMPAIGN_ACTIVATED
CUSTOMERACCOUNT_CAMPAIGN_ACTIVATED. -
CUSTOMERACCOUNT_LOAN_LETTER_FLOATING
CUSTOMERACCOUNT_LOAN_LETTER_FLOATING. -
CUSTOMERACCOUNT_LOAN_LETTER_NEWFIXEDINTERESTTERM
CUSTOMERACCOUNT_LOAN_LETTER_NEWFIXEDINTERESTTERM. -
CUSTOMERACCOUNT_LOAN_LETTER_INFIXEDINTERESTTERM
CUSTOMERACCOUNT_LOAN_LETTER_INFIXEDINTERESTTERM. -
CUSTOMERACCOUNT_LOAN_LETTER_REMINDER
CUSTOMERACCOUNT_LOAN_LETTER_REMINDER. -
CUSTOMERACCOUNT_LOAN_TERMINATION
CUSTOMERACCOUNT_LOAN_TERMINATION. -
CUSTOMERACCOUNT_LOAN_PRETERMINATION
CUSTOMERACCOUNT_LOAN_PRETERMINATION. -
CUSTOMERACCOUNT_LOAN_REVERSETERMINATION
CUSTOMERACCOUNT_LOAN_REVERSETERMINATION. -
CUSTOMERACCOUNT_VIRT_INSTALMENT_INVOICING
CUSTOMERACCOUNT_VIRT_INSTALMENT_INVOICING. -
CUSTOMERACCOUNT_VIRT_REMINDER
CUSTOMERACCOUNT_VIRT_REMINDER. -
CUSTOMERACCOUNT_VIRT_TERMINATION
CUSTOMERACCOUNT_VIRT_TERMINATION. -
CUSTOMERACCOUNT_INCREASED_AMOUNT_TO_PAY
CUSTOMERACCOUNT_INCREASED_AMOUNT_TO_PAY. -
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_ADDED
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_ADDED. -
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_UPDATED
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_UPDATED. -
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_DELETED
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_DELETED. -
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_STATUSCHANGED
CUSTOMERACCOUNT_CREDITDEBTINSURANCE_STATUSCHANGED. -
CUSTOMERACCOUNT_USED_RIGHT_TO_WITHDRAW
CUSTOMERACCOUNT_USED_RIGHT_TO_WITHDRAW. -
CUSTOMERACCOUNT_ACCOUNT_TRANSFER
CUSTOMERACCOUNT_ACCOUNT_TRANSFER. -
LEDGER_RETURN
LEDGER_RETURN. -
LEDGERACCOUNT_EVENT
LEDGERACCOUNT_EVENT. -
COLLECTIONACCOUNTGROUP_CASE_ADDED
COLLECTIONACCOUNTGROUP_CASE_ADDED. -
COLLECTIONACCOUNTGROUP_CASE_REMOVED
COLLECTIONACCOUNTGROUP_CASE_REMOVED. -
COLLECTIONACCOUNT_AUTO_CASE_REVOKE
COLLECTIONACCOUNT_AUTO_CASE_REVOKE. -
AUTHSIGN_APPROVED
AUTHSIGN_APPROVED. -
AUTHSIGN_TIMEOUT
AUTHSIGN_TIMEOUT. -
AUTHSIGN_REJECTED
AUTHSIGN_REJECTED. -
NEWDOCUMENT
NEWDOCUMENT. -
LEDGERACCOUNT_MERGE
LEDGERACCOUNT_MERGE. -
LEDGERACCOUNT_REWRITE
LEDGERACCOUNT_REWRITE. -
BAILIFF_CANCELLATION
Information on cancellation reported by the bailiff. -
BAILIFF_LIMITATION_CREDITOR
Information on the creditor’s liability to interrupt limitation. -
BAILIFF_FINAL_REMITTANCE
Information on final remittance by the bailiff. -
BAILIFF_OBSTACLE_LACKOFFUNDS
Obstacle: debtor lacks funds. -
BAILIFF_OBSTACLE_LACKOFFUNDS_UNKNOWN
Obstacle: debtor lacks funds and is unknown. -
BAILIFF_OBSTACLE_OTHER
Obstacle: other. -
BAILIFF_OBSTACLE_LIMITEDENFORCEMENT
Obstacle: limited enforcement. -
BAILIFF_OBSTACLE_LIMITEDENFORCEMENT_UNKNOWN
Obstacle: limited enforcement and unknown. -
BAILIFF_DEBTOR_STATUS_UPDATE
Debtor: status update. -
BAILIFF_BALANCE
Debtor: balance inquiry.. -
OBJECT_UPDATE
OBJECT_UPDATE.
-
-
ProcessImmediately
Process action event immediately.bool
-
Output
0
if event is triggered.
ActionEventResponse
-
ActionEventResult
Result of ActionEvent.ObjectGeneralResult
A general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultType
Common result type.-
ResultCode Mandatory
The result code0
means 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 dataObjectCustomAction
CustomAction-
ServiceDefinition
The invoke service definition request.ObjectInvokeServiceDefinitionRequest
A 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 CustomActionObjectCustomActionResult
The 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.ObjectResultType
Common result type.-
ResultCode Mandatory
The result code0
means 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 dataObjectGetApplicantActionHistory
GetApplicationHistory-
getApplicantActionHistoryRequest
Get credit application request parameters.ObjectGetApplicantActionHistoryRequest
The GetApplicantActionHistory request parameters.-
ActionGroup
History action group.EnumActionGroup
Action group.-
None
None. -
Respite
An action (e.g. letter) to be sent as a confirmation of a given respite. -
Legal_SE_SUPRO_reduce
An export or letter action to handle reduction of a claim in Swedish injunction to pay process. -
Legal_SE_SUPRO_recall
An export or letter action to handle a recall of a claim from the Swedish injunction to pay process. -
Legal_SE_enforcement_reduce
An export or letter action to handle reduction of a claim in Swedish enforcement process. -
Legal_SE_enforcement_recall
An export or letter action to handle a recall of a claim from the Swedish enforcement process. -
Invoice
An action (e.g. letter) that is the actual invoice. -
Reminder
An action (e.g. letter) that is a reminder of an unpaid invoice. -
Collection
An action (e.g. export) that is the start of the debcollection process. -
Legal_SE_enforcement_application
An export or letter action to handle an application for a Swedish enforcement process. -
Legal_SE_enforcement_renew
An export or letter action to handle a yearly renewal in a Swedish enforcement process. -
Legal_SE_enforcement_respite
An export or letter action to to give the debtor a respite in a Swedish enforcement process. -
PP_Avi
Monthly payment notice in a payment (instalment) plan. -
Legal_SE_enforcement_message
An export or letter action to handle a message to the bailiff in a Swedish enforcement process. -
Legal_SE_enforcement_change
An export or letter action to handle an update to a case in a Swedish enforcement process. -
PP_Reminder
Reminder of a monthly payment notice in a payment (instalment) plan. -
Legal_SE_SUPRO_application
An export or letter action to handle application of a Swedish injunction to pay process. -
BOF
A letter action for Norwegian debt collection notice. -
Varsel
Norwegian reminder letter. -
IKVAR
Norwegian reminder and debt collection warning letter. -
Bankruptcy_application
A letter action with application for bankruptcy. -
XFR_application
An export action for Swedish credit information at Kronofogden (XFR). -
Notice
Action for monthly invoice of an account/loan. -
Promissory_Note
Action for promissory note of an account/loan. -
BOFVarsel
A letter action for Norwegian debt collection notice. -
TungInkasso
An action for initiating double charge of the debtor in a Norwegian collection case. -
Legal_NO_SI_application_Forlik
Norwegian action for application of simplified summons. -
Legal_NO_Forlik_reduce
An export or letter action to handle reduction of a claim in Norwegian simplified summons process. -
Legal_NO_Forlik_recall
An export or letter action to handle a recall of a claim in Norwegian simplified summons process. -
Legal_NO_DirekteUtlegg_reduce
An export or letter action to handle reduction of a claim in Norwegian direct enforcement process. -
Legal_NO_DirekteUtlegg_recall
An export or letter action to handle a recall of a claim in Norwegian direct enforcement process. -
Legal_NO_Utlegg_reduce
An export or letter action to handle reduction of a claim in Norwegian enforcement process. -
Legal_NO_Utlegg_recall
An export or letter action to handle a recall of a claim in Norwegian enforcement process. -
Legal_NO_SI_application_Utlegg
Norwegian action for application of enforcement. -
Legal_NO_SI_application_DirekteUtlegg
Norwegian action for application of direct enforcement (without prior summons). -
NL_WIK
A letter action for Dutch debt collection notice. -
Legal_FI_Summons_reduce
An export or letter action to handle reduction of a claim in Finnish summons process. -
Legal_FI_Summons_recall
An export or letter action to handle a recall of a claim in Finnish summons process. -
Legal_FI_Enforcement_reduce
An export or letter action to handle reduction of a claim in Finnish enforcement process. -
Legal_FI_Enforcement_recall
An export or letter action to handle a recall of a claim in Finnish enforcement process. -
Legal_NL_WritOfSummons
A letter action for Dutch writ of summons. -
Legal_NL_LegalDocument
A letter action for Dutch document that needs to be sent to the bailiff. -
Legal_NL_BailiffExport
An export action for exporting writ of summons or legal documents to the Dutch bailiff. -
Samlingsavisering
Action for monthly invoice of a revolving account. -
Samlingsavisering_Reminder_1
Action for first reminder of a revolving account. -
Samlingsavisering_Reminder_2
Action for second reminder of a revolving account. -
SECCI
A letter action for the Standard European Consumer Credit Information. -
PersonalDataReport
A letter action for presenting a personal data report to the customer/debtor. -
Legal_FI_Summons
Finnish action for writ of summons. -
Legal_FI_Enforcement
Finnish action for application of enforcement. -
Dem
Payment remark revoke. -
Legal_FI_Enforcement_Notification
Finnish Enforcement notification -
Legal_FI_Balance_Inquiry_Response
Finnish Bailiff balance inquiry response -
Legal_FI_Debtrecall
Uljas, debt recall (FI) -
Back_To_Billing
Back to billing
-
-
ActionType
History action type.EnumActionType
Action type.-
Undefined
Undefined. -
Letter
Letter. -
WordLetter
Word letter. -
ExportData
Export data. -
Manual
Manual collection. -
Phone
Phone. -
ManualSystem
Manual collection (System). -
InsertLegal
Registration legal information. -
ChangeService
Change service. -
NoOp
Wait. -
InsertOffer
Registration offer. -
ReturnToPrevious
Return to previous. -
Email
E-mail. -
UserQuestion
Question to user. -
InsertPurchase
Purchase of claim. -
Sms
SMS message (text). -
Endorsement
Endorsement. -
Reendorsement
Reendorsement. -
List
List. -
UpdateData
Update data. -
Service
Service call. -
UpdatePaymentPlan
Update payment plan. -
NewInvoiceConfirm
Merge new invoice. -
Grouping
Grouping. -
Voicemail
Voicemail. -
Decision
Decsicion. -
UserQuestionList
Question list. -
CaseTransfer
Case transfer. -
AccountTransfer
Account transfer. -
AuthSign
Authentication/signing. -
RegisterVerdict
Register Verdict.
-
-
CustomerAccountNumber
Customer account number.string
-
CustomerLookup Mandatory
A lookup for customer.ObjectCustomerLookup
A lookup for customer.-
CustomerIdentification Mandatory
Type of customer identification to look up.EnumCustomerIdentificationType
Customer identification type.-
Custom
Custom identification. -
CustomerSESSNOrCompanyNo
Identify by Swedish SSN or company number. -
CustomerNOSSNOrCompanyNo
Identify by Norwegian SSN or company number. -
CustomerReferenceNumber
Identify by customer reference number. -
CustomerGuid
Customer identification.
-
-
CustomerIdentificationValue Mandatory
Customer identification to look up, depending on type it has different formats.string
-
JuridicalType
Type of customer, e.g. physical.EnumCustomerJuridicalType
Juridical type of the customer.-
Physical
Physical person, meaning a natural person. -
Company
A company or other organisation. -
PersonalFirm
A 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.ObjectGetApplicantActionHistoryResult
The result of GetApplicantActionHistory request.-
HistoryDocuments
List of history actions.ArrayObjectHistory
Detailed information about history action item.-
ActionGroup
Action group (predefined category for history actions).EnumActionGroup
Action group.-
None
None. -
Respite
An action (e.g. letter) to be sent as a confirmation of a given respite. -
Legal_SE_SUPRO_reduce
An export or letter action to handle reduction of a claim in Swedish injunction to pay process. -
Legal_SE_SUPRO_recall
An export or letter action to handle a recall of a claim from the Swedish injunction to pay process. -
Legal_SE_enforcement_reduce
An export or letter action to handle reduction of a claim in Swedish enforcement process. -
Legal_SE_enforcement_recall
An export or letter action to handle a recall of a claim from the Swedish enforcement process. -
Invoice
An action (e.g. letter) that is the actual invoice. -
Reminder
An action (e.g. letter) that is a reminder of an unpaid invoice. -
Collection
An action (e.g. export) that is the start of the debcollection process. -
Legal_SE_enforcement_application
An export or letter action to handle an application for a Swedish enforcement process. -
Legal_SE_enforcement_renew
An export or letter action to handle a yearly renewal in a Swedish enforcement process. -
Legal_SE_enforcement_respite
An export or letter action to to give the debtor a respite in a Swedish enforcement process. -
PP_Avi
Monthly payment notice in a payment (instalment) plan. -
Legal_SE_enforcement_message
An export or letter action to handle a message to the bailiff in a Swedish enforcement process. -
Legal_SE_enforcement_change
An export or letter action to handle an update to a case in a Swedish enforcement process. -
PP_Reminder
Reminder of a monthly payment notice in a payment (instalment) plan. -
Legal_SE_SUPRO_application
An export or letter action to handle application of a Swedish injunction to pay process. -
BOF
A letter action for Norwegian debt collection notice. -
Varsel
Norwegian reminder letter. -
IKVAR
Norwegian reminder and debt collection warning letter. -
Bankruptcy_application
A letter action with application for bankruptcy. -
XFR_application
An export action for Swedish credit information at Kronofogden (XFR). -
Notice
Action for monthly invoice of an account/loan. -
Promissory_Note
Action for promissory note of an account/loan. -
BOFVarsel
A letter action for Norwegian debt collection notice. -
TungInkasso
An action for initiating double charge of the debtor in a Norwegian collection case. -
Legal_NO_SI_application_Forlik
Norwegian action for application of simplified summons. -
Legal_NO_Forlik_reduce
An export or letter action to handle reduction of a claim in Norwegian simplified summons process. -
Legal_NO_Forlik_recall
An export or letter action to handle a recall of a claim in Norwegian simplified summons process. -
Legal_NO_DirekteUtlegg_reduce
An export or letter action to handle reduction of a claim in Norwegian direct enforcement process. -
Legal_NO_DirekteUtlegg_recall
An export or letter action to handle a recall of a claim in Norwegian direct enforcement process. -
Legal_NO_Utlegg_reduce
An export or letter action to handle reduction of a claim in Norwegian enforcement process. -
Legal_NO_Utlegg_recall
An export or letter action to handle a recall of a claim in Norwegian enforcement process. -
Legal_NO_SI_application_Utlegg
Norwegian action for application of enforcement. -
Legal_NO_SI_application_DirekteUtlegg
Norwegian action for application of direct enforcement (without prior summons). -
NL_WIK
A letter action for Dutch debt collection notice. -
Legal_FI_Summons_reduce
An export or letter action to handle reduction of a claim in Finnish summons process. -
Legal_FI_Summons_recall
An export or letter action to handle a recall of a claim in Finnish summons process. -
Legal_FI_Enforcement_reduce
An export or letter action to handle reduction of a claim in Finnish enforcement process. -
Legal_FI_Enforcement_recall
An export or letter action to handle a recall of a claim in Finnish enforcement process. -
Legal_NL_WritOfSummons
A letter action for Dutch writ of summons. -
Legal_NL_LegalDocument
A letter action for Dutch document that needs to be sent to the bailiff. -
Legal_NL_BailiffExport
An export action for exporting writ of summons or legal documents to the Dutch bailiff. -
Samlingsavisering
Action for monthly invoice of a revolving account. -
Samlingsavisering_Reminder_1
Action for first reminder of a revolving account. -
Samlingsavisering_Reminder_2
Action for second reminder of a revolving account. -
SECCI
A letter action for the Standard European Consumer Credit Information. -
PersonalDataReport
A letter action for presenting a personal data report to the customer/debtor. -
Legal_FI_Summons
Finnish action for writ of summons. -
Legal_FI_Enforcement
Finnish action for application of enforcement. -
Dem
Payment remark revoke. -
Legal_FI_Enforcement_Notification
Finnish Enforcement notification -
Legal_FI_Balance_Inquiry_Response
Finnish Bailiff balance inquiry response -
Legal_FI_Debtrecall
Uljas, debt recall (FI) -
Back_To_Billing
Back to billing
-
-
ActionGroupingGuid
Ledger account group unique identifier.string
-
ActionItemCode
History action item code.string
-
ActionType
History item action type.EnumActionType
Action type.-
Undefined
Undefined. -
Letter
Letter. -
WordLetter
Word letter. -
ExportData
Export data. -
Manual
Manual collection. -
Phone
Phone. -
ManualSystem
Manual collection (System). -
InsertLegal
Registration legal information. -
ChangeService
Change service. -
NoOp
Wait. -
InsertOffer
Registration offer. -
ReturnToPrevious
Return to previous. -
Email
E-mail. -
UserQuestion
Question to user. -
InsertPurchase
Purchase of claim. -
Sms
SMS message (text). -
Endorsement
Endorsement. -
Reendorsement
Reendorsement. -
List
List. -
UpdateData
Update data. -
Service
Service call. -
UpdatePaymentPlan
Update payment plan. -
NewInvoiceConfirm
Merge new invoice. -
Grouping
Grouping. -
Voicemail
Voicemail. -
Decision
Decsicion. -
UserQuestionList
Question list. -
CaseTransfer
Case transfer. -
AccountTransfer
Account transfer. -
AuthSign
Authentication/signing. -
RegisterVerdict
Register 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.EnumUserType
User type.-
None
User type is undefined. -
All
All types. -
CreditorUser
Creditor user type. -
SolicitorUser
Solicitor user type. -
CreditorAndSolicitorUser
Creditor | Solicitor user type. -
Debtor
Debtor user type. -
CreditorUserAndDebtor
Creditor Debtor user type -
SolicitorUserAndDebtor
Solicito Debtor user type -
CreditorAndSolicitorUserAndDebtor
Creditor Solicitor Debtor user type
-
-
-
Result Mandatory
The result of the request. Indicating success or error.ObjectResultType
Common result type.-
ResultCode Mandatory
The result code0
means 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 dataObjectGetCreditApplicationDetails
GetCreditApplicationDetails-
GetCreditApplicationDetailsRequest
Get credit application request parameters.ObjectGetCreditApplicationDetailsRequest
The GetCreditApplicationDetails request.-
CreditApplicationGuid Mandatory
Credit application unique identifier.string
-
-
Output
Error codes:
- 1 : error message from ARC server
GetCreditApplicationDetailsResponse
-
GetCreditApplicationDetailsResult
Result of GetCreditApplicationDetailsObjectGetCreditApplicationDetailsResult
The result of GetCreditApplicationDetails request.-
CreditApplicationDetails
Credit application details.ObjectCreditApplicationDetails
Credit application details.-
AccountGuid Mandatory
Account unique identifier.string
-
AccountNumber
Customer account number.string
-
ActionFlowStatus
Account status informationObjectActionFlow
Account 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.ArrayObjectHistory
Detailed information about history action item.-
ActionGroup
Action group (predefined category for history actions).EnumActionGroup
Action group.-
None
None. -
Respite
An action (e.g. letter) to be sent as a confirmation of a given respite. -
Legal_SE_SUPRO_reduce
An export or letter action to handle reduction of a claim in Swedish injunction to pay process. -
Legal_SE_SUPRO_recall
An export or letter action to handle a recall of a claim from the Swedish injunction to pay process. -
Legal_SE_enforcement_reduce
An export or letter action to handle reduction of a claim in Swedish enforcement process. -
Legal_SE_enforcement_recall
An export or letter action to handle a recall of a claim from the Swedish enforcement process. -
Invoice
An action (e.g. letter) that is the actual invoice. -
Reminder
An action (e.g. letter) that is a reminder of an unpaid invoice. -
Collection
An action (e.g. export) that is the start of the debcollection process. -
Legal_SE_enforcement_application
An export or letter action to handle an application for a Swedish enforcement process. -
Legal_SE_enforcement_renew
An export or letter action to handle a yearly renewal in a Swedish enforcement process. -
Legal_SE_enforcement_respite
An export or letter action to to give the debtor a respite in a Swedish enforcement process. -
PP_Avi
Monthly payment notice in a payment (instalment) plan. -
Legal_SE_enforcement_message
An export or letter action to handle a message to the bailiff in a Swedish enforcement process. -
Legal_SE_enforcement_change
An export or letter action to handle an update to a case in a Swedish enforcement process. -
PP_Reminder
Reminder of a monthly payment notice in a payment (instalment) plan. -
Legal_SE_SUPRO_application
An export or letter action to handle application of a Swedish injunction to pay process. -
BOF
A letter action for Norwegian debt collection notice. -
Varsel
Norwegian reminder letter. -
IKVAR
Norwegian reminder and debt collection warning letter. -
Bankruptcy_application
A letter action with application for bankruptcy. -
XFR_application
An export action for Swedish credit information at Kronofogden (XFR). -
Notice
Action for monthly invoice of an account/loan. -
Promissory_Note
Action for promissory note of an account/loan. -
BOFVarsel
A letter action for Norwegian debt collection notice. -
TungInkasso
An action for initiating double charge of the debtor in a Norwegian collection case. -
Legal_NO_SI_application_Forlik
Norwegian action for application of simplified summons. -
Legal_NO_Forlik_reduce
An export or letter action to handle reduction of a claim in Norwegian simplified summons process. -
Legal_NO_Forlik_recall
An export or letter action to handle a recall of a claim in Norwegian simplified summons process. -
Legal_NO_DirekteUtlegg_reduce
An export or letter action to handle reduction of a claim in Norwegian direct enforcement process. -
Legal_NO_DirekteUtlegg_recall
An export or letter action to handle a recall of a claim in Norwegian direct enforcement process. -
Legal_NO_Utlegg_reduce
An export or letter action to handle reduction of a claim in Norwegian enforcement process. -
Legal_NO_Utlegg_recall
An export or letter action to handle a recall of a claim in Norwegian enforcement process. -
Legal_NO_SI_application_Utlegg
Norwegian action for application of enforcement. -
Legal_NO_SI_application_DirekteUtlegg
Norwegian action for application of direct enforcement (without prior summons). -
NL_WIK
A letter action for Dutch debt collection notice. -
Legal_FI_Summons_reduce
An export or letter action to handle reduction of a claim in Finnish summons process. -
Legal_FI_Summons_recall
An export or letter action to handle a recall of a claim in Finnish summons process. -
Legal_FI_Enforcement_reduce
An export or letter action to handle reduction of a claim in Finnish enforcement process. -
Legal_FI_Enforcement_recall
An export or letter action to handle a recall of a claim in Finnish enforcement process. -
Legal_NL_WritOfSummons
A letter action for Dutch writ of summons. -
Legal_NL_LegalDocument
A letter action for Dutch document that needs to be sent to the bailiff. -
Legal_NL_BailiffExport
An export action for exporting writ of summons or legal documents to the Dutch bailiff. -
Samlingsavisering
Action for monthly invoice of a revolving account. -
Samlingsavisering_Reminder_1
Action for first reminder of a revolving account. -
Samlingsavisering_Reminder_2
Action for second reminder of a revolving account. -
SECCI
A letter action for the Standard European Consumer Credit Information. -
PersonalDataReport
A letter action for presenting a personal data report to the customer/debtor. -
Legal_FI_Summons
Finnish action for writ of summons. -
Legal_FI_Enforcement
Finnish action for application of enforcement. -
Dem
Payment remark revoke. -
Legal_FI_Enforcement_Notification
Finnish Enforcement notification -
Legal_FI_Balance_Inquiry_Response
Finnish Bailiff balance inquiry response -
Legal_FI_Debtrecall
Uljas, debt recall (FI) -
Back_To_Billing
Back to billing
-
-
ActionGroupingGuid
Ledger account group unique identifier.string
-
ActionItemCode
History action item code.string
-
ActionType
History item action type.EnumActionType
Action type.-
Undefined
Undefined. -
Letter
Letter. -
WordLetter
Word letter. -
ExportData
Export data. -
Manual
Manual collection. -
Phone
Phone. -
ManualSystem
Manual collection (System). -
InsertLegal
Registration legal information. -
ChangeService
Change service. -
NoOp
Wait. -
InsertOffer
Registration offer. -
ReturnToPrevious
Return to previous. -
Email
E-mail. -
UserQuestion
Question to user. -
InsertPurchase
Purchase of claim. -
Sms
SMS message (text). -
Endorsement
Endorsement. -
Reendorsement
Reendorsement. -
List
List. -
UpdateData
Update data. -
Service
Service call. -
UpdatePaymentPlan
Update payment plan. -
NewInvoiceConfirm
Merge new invoice. -
Grouping
Grouping. -
Voicemail
Voicemail. -
Decision
Decsicion. -
UserQuestionList
Question list. -
CaseTransfer
Case transfer. -
AccountTransfer
Account transfer. -
AuthSign
Authentication/signing. -
RegisterVerdict
Register 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.EnumUserType
User type.-
None
User type is undefined. -
All
All types. -
CreditorUser
Creditor user type. -
SolicitorUser
Solicitor user type. -
CreditorAndSolicitorUser
Creditor | Solicitor user type. -
Debtor
Debtor user type. -
CreditorUserAndDebtor
Creditor Debtor user type -
SolicitorUserAndDebtor
Solicito Debtor user type -
CreditorAndSolicitorUserAndDebtor
Creditor Solicitor Debtor user type
-
-
-
AnnualPercentage
Annual percentage.decimal
-
ApplicationDate
The application creation date.DateTime
-
AppliedCreditAmount Mandatory
Applied credit amount.decimal
-
Broker
Broker party informationObjectBrokerParty
Broker party information-
FullName
Party namestring
-
Guid
Guidstring
-
InformalName
Party informal namestring
-
ReferenceCode
Party reference codestring
-
-
CoApplicants
List of credit co-applicants.ArrayObjectCreditApplicantDetails
Credit applicant details.-
Addresses
List of credit applicant addresses.ArrayObjectAddress
Holds 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.EnumCreditApplicationStatus
Status of credit application.-
NewApplication
New credit application, initial state. -
Analysis
Pending analysis of credit application. -
AwaitingConfirmation
Awaiting confirmation for credit application. -
AwaitingAdditionalInfo
Awaiting additional information for credit application. -
AwaitingSignature
Awaiting signature from customer. -
Rejected
Credit application has been rejected. -
Approved
Credit application has been approved. -
Terminated
Credit 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.ArrayObjectDataProvision
Holds 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.EnumEmploymentType
Employment type of person.-
Student
Student. -
DisabilityPension
Disability pension. -
Unemployed
Unemployed. -
TemporaryEmployed
Temporary employed. -
PermanentEmployed
Permanent employed. -
SelfEmployed
Self-employed. -
Retired
Retired.
-
-
ExtraFields
List of credit applicant extra fields.ArrayObjectExtraField
Extra 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.EnumGenderType
Gender of a person.-
Female
Female gender, a woman. -
Male
Male gender, a man. -
Unknown
Unknown 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.EnumJuridicalType
Type of person, juridically.-
NaturalPerson
Actual person. -
JuridicalPerson
Juridical 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.EnumMaritalStatus
Marital status.-
Unmarried
Unmarried. -
Married
Married. -
CommonLawSpouse
Common law spouse. -
Widow
Widow. -
Divorced
Divorced. -
Partner
Partner.
-
-
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.EnumTypeOfResident
Type of resident.-
RentedApartment
Rented apartment. -
CoOperativeApartment
Co-operative apartment. -
DetachedHouse
Detached house. -
RoomerOrSecondHand
Roomer or second hand.
-
-
WorkPhone
Work phone number of the credit applicant.string
-
-
CreditApplicationStatus
Current status of the credit application.EnumCreditApplicationStatus
Status of credit application.-
NewApplication
New credit application, initial state. -
Analysis
Pending analysis of credit application. -
AwaitingConfirmation
Awaiting confirmation for credit application. -
AwaitingAdditionalInfo
Awaiting additional information for credit application. -
AwaitingSignature
Awaiting signature from customer. -
Rejected
Credit application has been rejected. -
Approved
Credit application has been approved. -
Terminated
Credit application has been terminated.
-
-
CreditApplicationStatusDate
Date of the credit application status.DateTime
-
CustomerAccountTypeCode Mandatory
Customer account type code.string
-
DataProvisions
List of data provisions.ArrayObjectDataProvision
Holds data provision details.-
Code Mandatory
Data provision code.string
-
Text
Data provision text.string
-
Version
Data provision version.string
-
-
Disbursements
Loan disbursement informationArrayObjectLoanDisbursement
Loan 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.ArrayObjectExtraField
Extra 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.ArrayObjectLoanToSettle
Loan 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.ObjectCreditApplicantDetails
Credit applicant details.-
Addresses
List of credit applicant addresses.ArrayObjectAddress
Holds 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.EnumCreditApplicationStatus
Status of credit application.-
NewApplication
New credit application, initial state. -
Analysis
Pending analysis of credit application. -
AwaitingConfirmation
Awaiting confirmation for credit application. -
AwaitingAdditionalInfo
Awaiting additional information for credit application. -
AwaitingSignature
Awaiting signature from customer. -
Rejected
Credit application has been rejected. -
Approved
Credit application has been approved. -
Terminated
Credit 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.ArrayObjectDataProvision
Holds 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.EnumEmploymentType
Employment type of person.-
Student
Student. -
DisabilityPension
Disability pension. -
Unemployed
Unemployed. -
TemporaryEmployed
Temporary employed. -
PermanentEmployed
Permanent employed. -
SelfEmployed
Self-employed. -
Retired
Retired.
-
-
ExtraFields
List of credit applicant extra fields.ArrayObjectExtraField
Extra 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.EnumGenderType
Gender of a person.-
Female
Female gender, a woman. -
Male
Male gender, a man. -
Unknown
Unknown 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.EnumJuridicalType
Type of person, juridically.-
NaturalPerson
Actual person. -
JuridicalPerson
Juridical 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.EnumMaritalStatus
Marital status.-
Unmarried
Unmarried. -
Married
Married. -
CommonLawSpouse
Common law spouse. -
Widow
Widow. -
Divorced
Divorced. -
Partner
Partner.
-
-
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.EnumTypeOfResident
Type of resident.-
RentedApartment
Rented apartment. -
CoOperativeApartment
Co-operative apartment. -
DetachedHouse
Detached house. -
RoomerOrSecondHand
Roomer 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.ArrayObjectCreditApplicationPayment
Payment 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.ObjectResultType
Common result type.-
ResultCode Mandatory
The result code0
means 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 dataObjectGetCreditApplications
GetCreditApplications-
GetCreditApplicationsRequest
Get credit application request parameters.ObjectGetCreditApplicationsRequest
The GetCreditApplicationsRequest parameters.-
Active
Active or not active boolean flag.bool
-
CustomerLookup
A lookup for customer.ObjectCustomerLookup
A lookup for customer.-
CustomerIdentification Mandatory
Type of customer identification to look up.EnumCustomerIdentificationType
Customer identification type.-
Custom
Custom identification. -
CustomerSESSNOrCompanyNo
Identify by Swedish SSN or company number. -
CustomerNOSSNOrCompanyNo
Identify by Norwegian SSN or company number. -
CustomerReferenceNumber
Identify by customer reference number. -
CustomerGuid
Customer identification.
-
-
CustomerIdentificationValue Mandatory
Customer identification to look up, depending on type it has different formats.string
-
JuridicalType
Type of customer, e.g. physical.EnumCustomerJuridicalType
Juridical type of the customer.-
Physical
Physical person, meaning a natural person. -
Company
A company or other organisation. -
PersonalFirm
A 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 GetCreditApplicationsObjectGetCreditApplicationsResult
The result of GetCreditApplications request.-
CreditApplications
List of returned credit appliations.ArrayObjectCreditApplicationInfo
Credit application information.-
ActionFlowStatus
Account status informationObjectActionFlow
Account 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 informationObjectBrokerParty
Broker 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 informationArrayObjectLoanDisbursement
Loan 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.EnumCreditApplicationStatus
Status of credit application.-
NewApplication
New credit application, initial state. -
Analysis
Pending analysis of credit application. -
AwaitingConfirmation
Awaiting confirmation for credit application. -
AwaitingAdditionalInfo
Awaiting additional information for credit application. -
AwaitingSignature
Awaiting signature from customer. -
Rejected
Credit application has been rejected. -
Approved
Credit application has been approved. -
Terminated
Credit application has been terminated.
-
-
TotalCreditAmount Mandatory
Total credit amount.decimal
-
-
Result Mandatory
The result of the request. Indicating success or error.ObjectResultType
Common result type.-
ResultCode Mandatory
The result code0
means 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 dataObjectGetHistoryDocument
GetHistoryDocument-
HistoryGuid
History action document's unique identifier.string
-
Output
Error codes:
- 1 : error message from ARC server
GetHistoryDocumentResponse
-
GetHistoryDocumentResult
Result of GetHistoryDocumentObjectGetHistoryDocumentResult
General 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.ObjectResultType
Common result type.-
ResultCode Mandatory
The result code0
means 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.ObjectPing
Ping
Output
0
if ping was successful, otherwise read result text for error information.
GeneralResultResponse
-
GeneralResult
Result of GeneralResultObjectGeneralResult
A general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultType
Common result type.-
ResultCode Mandatory
The result code0
means 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 dataObjectRegisterCreditApplication
RegisterCreditApplication-
RegisterCreditApplicationRequest
Credit application detailed information.ObjectRegisterCreditApplicationRequest
The RegisterCreditApplicationRequest parameters with credit application details.-
BrokerPartyReference
Credit application details.string
-
ClientReference Mandatory
client reference string.string
-
CoApplicants
List of credit co-applicants.ArrayObjectCreditApplicant
Credit applicant details.-
Addresses
List of credit applicant adresses.ArrayObjectAddress
Holds 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.ObjectBankAccountInfo
Bank 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.ArrayObjectDataProvision
Holds 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.EnumEmploymentType
Employment type of person.-
Student
Student. -
DisabilityPension
Disability pension. -
Unemployed
Unemployed. -
TemporaryEmployed
Temporary employed. -
PermanentEmployed
Permanent employed. -
SelfEmployed
Self-employed. -
Retired
Retired.
-
-
ExtraFields
List of extra fields.ArrayObjectExtraField
Extra 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.EnumGenderType
Gender of a person.-
Female
Female gender, a woman. -
Male
Male gender, a man. -
Unknown
Unknown 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.EnumJuridicalType
Type of person, juridically.-
NaturalPerson
Actual person. -
JuridicalPerson
Juridical 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.EnumMaritalStatus
Marital status.-
Unmarried
Unmarried. -
Married
Married. -
CommonLawSpouse
Common law spouse. -
Widow
Widow. -
Divorced
Divorced. -
Partner
Partner.
-
-
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.EnumTypeOfResident
Type of resident.-
RentedApartment
Rented apartment. -
CoOperativeApartment
Co-operative apartment. -
DetachedHouse
Detached house. -
RoomerOrSecondHand
Roomer or second hand.
-
-
WorkPhone
Work phone number of the credit applicant.string
-
-
CreditApplication Mandatory
Credit application details.ObjectCreditApplication
Credit application description.-
ApplicationDate Mandatory
The application creation date.DateTime
-
AppliedCreditAmount Mandatory
Applied credit amount.decimal
-
DataProvisions
The list of data provisions for the application.ArrayObjectDataProvision
Holds 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.ArrayObjectExtraField
Extra 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.ArrayObjectLoanToSettle
Loan 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.ObjectCreditApplicant
Credit applicant details.-
Addresses
List of credit applicant adresses.ArrayObjectAddress
Holds 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.ObjectBankAccountInfo
Bank 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.ArrayObjectDataProvision
Holds 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.EnumEmploymentType
Employment type of person.-
Student
Student. -
DisabilityPension
Disability pension. -
Unemployed
Unemployed. -
TemporaryEmployed
Temporary employed. -
PermanentEmployed
Permanent employed. -
SelfEmployed
Self-employed. -
Retired
Retired.
-
-
ExtraFields
List of extra fields.ArrayObjectExtraField
Extra 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.EnumGenderType
Gender of a person.-
Female
Female gender, a woman. -
Male
Male gender, a man. -
Unknown
Unknown 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.EnumJuridicalType
Type of person, juridically.-
NaturalPerson
Actual person. -
JuridicalPerson
Juridical 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.EnumMaritalStatus
Marital status.-
Unmarried
Unmarried. -
Married
Married. -
CommonLawSpouse
Common law spouse. -
Widow
Widow. -
Divorced
Divorced. -
Partner
Partner.
-
-
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.EnumTypeOfResident
Type of resident.-
RentedApartment
Rented apartment. -
CoOperativeApartment
Co-operative apartment. -
DetachedHouse
Detached house. -
RoomerOrSecondHand
Roomer 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 RegisterCreditApplicationObjectRegisterCreditApplicationResult
The result of the RegisterCreditApplication request.-
CreditApplication
Credit application information.ObjectCreditApplicationInfo
Credit application information.-
ActionFlowStatus
Account status informationObjectActionFlow
Account 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 informationObjectBrokerParty
Broker 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 informationArrayObjectLoanDisbursement
Loan 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.EnumCreditApplicationStatus
Status of credit application.-
NewApplication
New credit application, initial state. -
Analysis
Pending analysis of credit application. -
AwaitingConfirmation
Awaiting confirmation for credit application. -
AwaitingAdditionalInfo
Awaiting additional information for credit application. -
AwaitingSignature
Awaiting signature from customer. -
Rejected
Credit application has been rejected. -
Approved
Credit application has been approved. -
Terminated
Credit application has been terminated.
-
-
TotalCreditAmount Mandatory
Total credit amount.decimal
-
-
Result Mandatory
The result of the request. Indicating success or error.ObjectResultType
Common result type.-
ResultCode Mandatory
The result code0
means 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 dataObjectRegisterRaiseCreditReqContract
Raise credit limit-
RegisterRaiseCreditReq
Raise credit limitObjectRegisterRaiseCreditReq
RegisterRaiseCredit arguments-
ClientReference Mandatory
Client reference string.string
-
CreditApplication Mandatory
Credit application details.ObjectRaiseCreditApplication
Raise 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.ArrayObjectExtraField
Extra 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.ArrayObjectLoanToSettle
Loan 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 dataObjectRegisterRaiseCreditResp
Raise credit response data-
Result Mandatory
The result of the request. Indicating success or error.ObjectResultType
Common result type.-
ResultCode Mandatory
The result code0
means 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 dataObjectSetPaymentAsFreeMonth
SetPaymentAsFreeMonth.-
setPaymentAsFreeMonthRequest
Set payment as free months request parameters. CreditDebtNo, CustomerLookup and PaymentNo are mandatory parametersObjectSetPaymentAsFreeMonthRequest
The SetPaymentAsFreeMonthRequest parameters.-
CreditDebtNo Mandatory
Credit debt number.string
-
CustomerLookup Mandatory
A lookup for customer.ObjectCustomerLookup
A lookup for customer.-
CustomerIdentification Mandatory
Type of customer identification to look up.EnumCustomerIdentificationType
Customer identification type.-
Custom
Custom identification. -
CustomerSESSNOrCompanyNo
Identify by Swedish SSN or company number. -
CustomerNOSSNOrCompanyNo
Identify by Norwegian SSN or company number. -
CustomerReferenceNumber
Identify by customer reference number. -
CustomerGuid
Customer identification.
-
-
CustomerIdentificationValue Mandatory
Customer identification to look up, depending on type it has different formats.string
-
JuridicalType
Type of customer, e.g. physical.EnumCustomerJuridicalType
Juridical type of the customer.-
Physical
Physical person, meaning a natural person. -
Company
A company or other organisation. -
PersonalFirm
A 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.ObjectGeneralResult
A general result containing a result with result code and result text.-
Result
The result of the request.ObjectResultType
Common result type.-
ResultCode Mandatory
The result code0
means 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 dataObjectTerminateCreditApplication
TerminateCreditApplication-
TerminateCreditApplicationRequest
Credit application termination details.ObjectTerminateCreditApplicationRequest
The 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 resultObjectTerminateCreditApplicationResult
The result of TerminateCreditApplication request.-
CreditApplication
Details of the terminated credit application.ObjectCreditApplicationInfo
Credit application information.-
ActionFlowStatus
Account status informationObjectActionFlow
Account 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 informationObjectBrokerParty
Broker 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 informationArrayObjectLoanDisbursement
Loan 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.EnumCreditApplicationStatus
Status of credit application.-
NewApplication
New credit application, initial state. -
Analysis
Pending analysis of credit application. -
AwaitingConfirmation
Awaiting confirmation for credit application. -
AwaitingAdditionalInfo
Awaiting additional information for credit application. -
AwaitingSignature
Awaiting signature from customer. -
Rejected
Credit application has been rejected. -
Approved
Credit application has been approved. -
Terminated
Credit application has been terminated.
-
-
TotalCreditAmount Mandatory
Total credit amount.decimal
-
-
Result Mandatory
The result of the request. Indicating success or error.ObjectResultType
Common result type.-
ResultCode Mandatory
The result code0
means 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 dataObjectWaitForLoanActivation
WaitForLoanActivation.-
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.ObjectWaitForLoanActivationResult
The result of checking for loan activation.-
Active
Is loan active.bool
-
Result
The result of the request.ObjectResultType
Common result type.-
ResultCode Mandatory
The result code0
means 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.ArrayEnumStatus
Loan status.-
Closed
Loan has been closed. -
OnHold
Loan is currently on hold. -
Overdraft
Loan has been overdrawn. -
Reminder
Loan has sent payment reminder. -
DebtCollection
Loan has been sent to debt collection. -
CreditStop
Loan has had credit stopped. -
ManualCreditStop
Loan has had credit stopped manually. -
Respite
Loan has payment respite. -
Deceased
Debtor has deceased. -
Origination
Loan in the phase of origination, to be activated. -
Declined
Loan was declined. -
PreRedemption
Loan redeemed earlier than planned. -
Termination
Loan has been terminated. -
UsedRightToWithdraw
Debtor has used right to withdraw. -
PreTermination
Loan is in pre termination state.
-
-