{"openapi":"3.0.1","info":{"title":"PAYMENTS","contact":{"name":"Digiteal.eu","url":"http://docs.digiteal.eu/","email":"support@digiteal.eu"},"version":"1.2.2"},"x-readme":{"explorer-enabled":true,"proxy-enabled":true},"servers":[{"url":"https://test.digiteal.eu","description":"Test environment"},{"url":"https://app.digiteal.eu","description":"Production environment"}],"paths":{"/api/v1/refund":{"post":{"tags":["Refund"],"summary":"Refund payment","description":"Refund a payment","operationId":"refund","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundRequest"}}},"required":true},"responses":{"200":{"description":"empty response body with the refund payment identifier in the uuid header","headers":{"uuid":{"description":"unique identifier of the refund payment if it has started","style":"simple","schema":{"type":"string"}},"status":{"description":"STARTED if the refund has started or SCHEDULED if it has been scheduled for later because Digiteal did not receive or transfer the funds yet","style":"simple","schema":{"type":"string"}}},"content":{"*/*":{"schema":{"type":"array","items":{"type":"string","format":"byte"}}}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"500":{"description":"Internal server error occurred","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"basic":[]}]}},"/api/v1/payment-request":{"post":{"tags":["Payment"],"summary":"Payment request","description":"Create a payment request.","operationId":"createPaymentRequest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCreationRequest"}}},"required":true},"responses":{"200":{"description":"OK","headers":{"payment-url-intent":{"description":"url to perform payment on smartphone  (this link can be used only once, you should generate a new one for each new interactive payment)","style":"simple","schema":{"type":"string"}},"payment-web-url":{"description":"url to perform payment in web browser (this link can be used only once, you should generate a new one for each new interactive payment)","style":"simple","schema":{"type":"string"}},"uuid":{"description":"unique identifier of the payment request","style":"simple","schema":{"type":"string"}}},"content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"500":{"description":"Internal server error occurred","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"basic":[]}]}},"/api/v1/payment-request/generate-qr-code":{"get":{"tags":["payment"],"summary":"Generate QR","description":"Generate a QR code","operationId":"generateQrCode","parameters":[{"name":"paymentRequestUUID","in":"query","description":"The internal identifier of the SinglePaymentRequest, associated to the payment as known by the creditor. \"Max length of 255","required":false,"schema":{"type":"string","format":"uuid","description":"The internal identifier of the SinglePaymentRequest, associated to the payment as known by the creditor. \"Max length of 255","example":"550e8400-e29b-41d4-a716-446655440000"},"example":"550e8400-e29b-41d4-a716-446655440000"},{"name":"format","in":"query","description":"Format of the image you want to receive, default value = QR_URL","required":false,"schema":{"type":"string","description":"Format of the image you want to receive, default value = QR_URL","enum":["QR_URL","QR_TEXT","BANNER3","BANNER4","BANNER5","BANNER6","NONE"],"example":"QR_URL","pattern":"(BANNER3)|(BANNER4)|(BANNER5)|(BANNER6)|(QR_TEXT)|(QR_URL)|(NONE)"},"example":"QR_URL"},{"name":"language","in":"query","description":"The language of the client (nl, fr or en), default value = en","required":false,"schema":{"type":"string","description":"The language of the client (nl, fr or en), default value = en","example":"en"},"example":"en"},{"name":"size","in":"query","description":"The width of the image to generate (minimum 250, maximum 4000)","required":false,"schema":{"type":"integer","format":"int32","description":"The width of the image to generate (minimum 250, maximum 4000)","example":400,"minimum":250},"example":400}],"responses":{"200":{"description":"Success","content":{"image/png":{"schema":{"type":"string","format":"byte"}}}},"400":{"description":"Bad request","content":{"image/png":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"basic":[]}]}},"/api/v1/payment-request/invoice":{"post":{"tags":["Invoice"],"summary":"Invoice payment request","description":"Create a invoice payment request.","operationId":"createInvoicePaymentRequest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentRequest"}}},"required":true},"responses":{"200":{"description":"OK","headers":{"payment-url-intent":{"description":"url intent to perform payment on mobile device  (this link can be used only once, you should generate a new one for each new interactive payment)","style":"simple","schema":{"type":"string"}},"payment-web-url":{"description":"url to perform payment in web browser  (this link can be used only once, you should generate a new one for each new interactive payment)","style":"simple","schema":{"type":"string"}},"uuid":{"description":"unique identifier for the payment request","style":"simple","schema":{"type":"string"}}},"content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"500":{"description":"Internal server error occurred","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"basic":[]}]}},"/api/v1/payment-request/sct":{"post":{"tags":["Payment"],"summary":"Payment SCT request","description":"Create an SCT payment request","operationId":"createSctPaymentRequest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SctPaymentRequestInput"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SctPaymentRequestResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SctPaymentRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SctPaymentRequestResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SctPaymentRequestResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SctPaymentRequestResponse"}}}},"500":{"description":"Internal server error occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SctPaymentRequestResponse"}}}}},"security":[{"basic":[]}]}},"/api/v1/payment-request/trustedPayment":{"post":{"tags":["Trusted Payment"],"summary":"Trusted payment collection request","description":"Create a trusted payment collection request.","operationId":"createTrustedPaymentCollectionRequest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrustedPaymentRequest"}}},"required":true},"responses":{"200":{"description":"OK","headers":{"payment-url-intent":{"description":"url intent to perform payment on mobile device  (this link can be used only once, you should generate a new one for each new interactive payment)","style":"simple","schema":{"type":"string"}},"payment-web-url":{"description":"url to perform payment in web browser  (this link can be used only once, you should generate a new one for each new interactive payment)","style":"simple","schema":{"type":"string"}},"uuid":{"description":"unique identifier for the payment request","style":"simple","schema":{"type":"string"}}},"content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}},"500":{"description":"Internal server error occurred","content":{"*/*":{"schema":{"type":"string","format":"byte"}}}}},"security":[{"basic":[]}]}},"/api/v1/invoice-request":{"post":{"tags":["Invoice"],"summary":"Invoice request","description":"Create or update an invoice","operationId":"createInvoiceRequest","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceCreationRequest"}}},"required":true},"responses":{"200":{"description":"The body contains the image in the requested format (binary PNG or BMP). If the selected format was NONE, the body contains a text/plain with the QR responseCode text content.","headers":{"deliveryMethod":{"description":"if the value is S2P then the client has chosen for Digiteal as presentment channel, if the value is null then the client is unknown to Digiteal or has not performed an optin","style":"simple","schema":{"type":"string"}},"uuid":{"description":"unique identifier for the invoice","style":"simple","schema":{"type":"string"}}},"content":{"image/png":{}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"type":"string"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"type":"string"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"type":"string"}}}},"500":{"description":"Internal server error occurred","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorMessage"}}}}},"security":[{"basic":[]}]}}},"components":{"schemas":{"UserNotificationSettings":{"type":"object","properties":{"invoice":{"type":"boolean"},"emitter":{"type":"boolean"},"reminder":{"type":"boolean"},"autoPayment":{"type":"boolean"},"autoPaymentTreshold":{"type":"boolean"},"paymentIssue":{"type":"boolean"},"days":{"type":"integer","format":"int32"},"contact":{"type":"string"},"push":{"type":"boolean"},"mail":{"type":"boolean"}}},"Requester":{"type":"object","properties":{"username":{"$ref":"#/components/schemas/Username"},"userIdentifier":{"$ref":"#/components/schemas/UserIdentifier"},"type":{"type":"string","enum":["INTERNAL","INTEGRATOR_TECHNICAL","COMPANY_TECHNICAL","COMPANY","PERSON","ADMIN"]},"representedLegalEntity":{"$ref":"#/components/schemas/LegalEntityIdentifier"},"metadata":{"$ref":"#/components/schemas/RequestMetadata"},"authorities":{"type":"array","items":{"type":"string","enum":["EMITTER","INTEGRATOR","ADMIN","COMPANY","PERSON","INTEGRATOR_TECHNICAL","COMPANY_TECHNICAL","INTERNAL"]},"uniqueItems":true},"fullyActive":{"type":"boolean"},"mobileDeviceFamily":{"type":"string","enum":["ANDROID","APPLE","OTHER"]},"originator":{"type":"string","enum":["PAYCONIQ","ING","BELFIUS","BNPPF","FINTRO","HELLO_BANK"]},"webappMigrated":{"type":"boolean"},"authenticated":{"type":"boolean"},"integrator":{"type":"boolean"},"representedPerson":{"$ref":"#/components/schemas/PersonIdentifier"},"company":{"type":"boolean"},"representedCompany":{"type":"integer","format":"int64"},"person":{"type":"boolean"},"onMobile":{"type":"boolean"}}},"UserProfile":{"type":"object","properties":{"firstName":{"type":"string","minLength":1},"lastName":{"type":"string","minLength":1},"login":{"type":"string","format":"email","minLength":1},"language":{"type":"string","enum":["FR","EN","ES","NL","DE"],"minLength":1},"additionalMails":{"type":"array","items":{"$ref":"#/components/schemas/UserMail"},"maxItems":5,"minItems":0},"notificationSettings":{"$ref":"#/components/schemas/UserNotificationSettings"},"totpActivated":{"type":"boolean"},"profilePictureUrl":{"type":"string"},"legalEntity":{"type":"integer","format":"int64"},"hasOptin":{"type":"boolean"},"hasValidMandate":{"type":"boolean"},"nationalities":{"type":"array","items":{"type":"string"}},"company":{"type":"boolean"}},"required":["firstName","language","lastName","login"]},"LoggerUpdateRequest":{"type":"object","properties":{"level":{"type":"string","minLength":1,"pattern":"TRACE|DEBUG|INFO|WARN|ERROR"}},"required":["level"]},"IssuerAddresses":{"type":"object","properties":{"defaultAddress":{"$ref":"#/components/schemas/AddressDetails"},"billingAddress":{"$ref":"#/components/schemas/AddressDetails"}},"required":["defaultAddress"]},"EmailPaymentInvitationRequest":{"type":"object","properties":{"mandate":{"type":"string","format":"uuid"},"email":{"type":"string"},"communication":{"type":"string","maxLength":280,"minLength":0},"amount":{"type":"number","format":"double","maximum":10000,"minimum":1}},"required":["amount","communication","email","mandate"]},"PeppolParticipantIdentifierRequest":{"type":"object","properties":{"schemeId":{"type":"string"},"code":{"type":"integer","format":"int32"},"deprecated":{"type":"boolean"}},"required":["code","schemeId"]},"ErrorMessage":{"type":"object","properties":{"errorCode":{"type":"string","description":"error code indicating a specific error","example":"INVALID_PARAMETER"},"errorSubjects":{"type":"array","description":"subjects on which the error code applies","items":{"type":"string"}},"errorMessage":{"type":"string","description":"a more detailed message explaining the code.","example":"Error message"},"requestId":{"type":"string","description":"The request id (generated by the server if no 'correlation-id' provided as a request header)","example":"Error message"}}},"ApplicationStatusInput":{"type":"object","properties":{"application":{"type":"string","pattern":"(MOBILE)"},"operatingSystem":{"type":"string","pattern":"(IOS)|(ANDROID)"},"oldestSupportedVersion":{"type":"string"},"availableVersion":{"type":"string"}},"required":["application","availableVersion","oldestSupportedVersion","operatingSystem"]},"AmlRiskLevelForcedInput":{"type":"object","properties":{"abstract_person_id":{"type":"integer","format":"int64"},"forced":{"type":"boolean"},"aml_decision_type":{"type":"string","enum":["ACCEPT","EVALUATE","REJECT"]},"comment":{"type":"string"}},"required":["abstract_person_id","aml_decision_type","forced"]},"WebHookCredentialsRequest":{"type":"object","description":"Configuration to set only the credentials","properties":{"vatNumber":{"type":"string","description":"VAT number of the company for whom the webhooks are configured. This should only be used by integrators.","example":"BE0000000097"},"identificationNumber":{"type":"string","description":"Identification number of the company for whom the webhooks are configured. This should only be used by integrators. (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"login":{"type":"string","description":"Login used to call the webhooks (in the HTTP Basic Auth). If no login/password is provided or if the webhook is sent by email then this will not be used.","example":"userLogin"},"password":{"type":"string","description":"Password used to call the webhooks (in the HTTP Basic Auth). If no login/password is provided or if the webhook is sent by email then this will not be used.","example":"NotProvidedForSecurityReasons"}}},"WebHookConfigurationRequest":{"type":"object","description":"Configuration to set for the calling company","properties":{"vatNumber":{"type":"string","description":"VAT number of the company for whom the webhooks are configured. This should only be used by integrators.","example":"BE0000000097"},"identificationNumber":{"type":"string","description":"Identification number of the company for whom the webhooks are configured. This should only be used by integrators. (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"login":{"type":"string","description":"Login used to call the webhooks (in the HTTP Basic Auth). If no login/password is provided or if the webhook is sent by email then this will not be used.","example":"userLogin"},"password":{"type":"string","description":"Password used to call the webhooks (in the HTTP Basic Auth). If no login/password is provided or if the webhook is sent by email then this will not be used.","example":"NotProvidedForSecurityReasons"},"webHooks":{"type":"array","description":"Webhooks","items":{"$ref":"#/components/schemas/WebHookInfo"}}}},"PeppolParticipantBusinessCardUpdate":{"type":"object","properties":{"contactPerson":{"$ref":"#/components/schemas/PeppolParticipantContactPersonResource","description":"Contact information to add in the PEPPOL directory and used by Digiteal access point as a point of contact"},"name":{"type":"string","description":"Name of the participant. Required for the PEPPOL directory registration.","example":"MyCompany"},"countryCode":{"type":"string","format":"iso-3166-2","description":"Country code of the participant. Required for the PEPPOL directory registration.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW","ZZ"],"example":"BE"},"website":{"type":"string","format":"url","description":"URL of the participant's website","example":"https://www.mycompany.com"},"additionalInfo":{"type":"string","description":"Additional information about the participant","example":"Please embed the PDF in the UBL document"}},"required":["contactPerson","countryCode","name"]},"PeppolResultAsync":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"},"operationId":{"type":"string","format":"uuid","description":"Operation UUID of the process. Will be referenced in the callback when the outcome is known."}},"required":["operationId","status"]},"PeppolSendDocumentAsyncErrorCode":{"type":"object","properties":{"status":{"type":"string","description":"Error code","enum":["TECHNICAL_ERROR"]},"message":{"type":"string","description":"Error message"}},"required":["message","status"]},"PeppolForbiddenErrorCode":{"type":"object","properties":{"status":{"type":"string","description":"Error code","enum":["PARTICIPANT_NOT_REGISTERED_TO_CALLER"]},"message":{"type":"string","description":"Error message"}},"required":["message","status"]},"PasswordResetRequest":{"type":"object","properties":{"email":{"type":"string","deprecated":true},"username":{"type":"string"},"password":{"type":"string","minLength":1},"token":{"type":"string","minLength":1}},"required":["password","token"]},"PasswordResetInitiationRequest":{"type":"object","properties":{"username":{"type":"string"}},"required":["username"]},"UserPassword":{"type":"object","properties":{"current":{"type":"object","properties":{"empty":{"type":"boolean"}}},"password":{"type":"object","properties":{"empty":{"type":"boolean"}}}},"required":["current","password"]},"OptinInfo":{"type":"object","properties":{"paymentIdentifier":{"type":"string","format":"uuid"},"emitterId":{"type":"integer","format":"int64"},"customerID":{"type":"string"},"optinType":{"type":"string","enum":["OPTIN","DECLINED","UNKNOWN"]},"ip":{"type":"string"},"agent":{"type":"string"}}},"OptinDetails":{"type":"object","properties":{"emitterID":{"type":"integer","format":"int64"},"logo":{"type":"string"},"emitterName":{"type":"string"},"clientID":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"optinType":{"type":"string","enum":["OPTIN","DECLINED","UNKNOWN"]}}},"MfaValue":{"type":"object","properties":{"mfaValue":{"type":"integer","format":"int32","writeOnly":true},"value":{"type":"integer","format":"int32"}},"required":["mfaValue"]},"MfaRequester":{"type":"object","properties":{"username":{"type":"string"}},"required":["username"]},"UserDetails":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"language":{"type":"string","enum":["FR","EN","ES","NL","DE"]}}},"DeliveryPreference":{"type":"object","properties":{"deliveryChannel":{"type":"string","enum":["DIGITEAL","ORIGINAL"]},"invoiceUUID":{"type":"string","format":"uuid"}}},"AccountDeletionRequest":{"type":"object","properties":{"password":{"type":"string"}}},"ContractDetails":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"url":{"type":"string"},"name":{"type":"string"}}},"ValidationInfo":{"type":"object","properties":{"mandateId":{"type":"integer","format":"int64"},"validationCode":{"type":"string"}}},"MandateValidationResult":{"type":"object","properties":{"status":{"type":"string","enum":["OK","ERROR","BLOCKED","NOT_ACTIVATED"]},"remaining":{"type":"integer","format":"int32"},"hasPin":{"type":"boolean"}}},"BankAccountDetails":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"state":{"type":"string"},"bic":{"type":"string"},"iban":{"type":"string","minLength":1},"name":{"type":"string"},"reference":{"type":"boolean"},"type":{"type":"string","enum":["CORE","B2B"]},"activated":{"type":"boolean"},"mandateId":{"type":"integer","format":"int64"},"mandateUuid":{"type":"string","format":"uuid"},"reimbursement":{"type":"boolean"},"bankName":{"type":"string"},"bankIconFileName":{"type":"string"},"remaining":{"type":"integer","format":"int32"}},"required":["iban"]},"AddressDetails":{"type":"object","properties":{"streetName":{"type":"string","description":"Street name","example":"Rue de la Loi","minLength":1},"houseNumber":{"type":"string","description":"House number","example":15},"zipCode":{"type":"string","description":"Zip code","example":1000,"minLength":1},"city":{"type":"string","description":"City","example":"Bruxelles","minLength":1},"country":{"type":"string","description":"Country name","example":"Belgique"},"countryCode":{"type":"string","description":"Country code represented by the two letter country codes as defined in ISO 3166-1 alpha-2.","example":"BE","minLength":1}},"required":["city","countryCode","streetName","zipCode"]},"AddressUpdateRequest":{"type":"object","properties":{"streetName":{"type":"string","description":"Street name","example":"Rue de la Loi","minLength":1},"houseNumber":{"type":"string","description":"House number","example":15,"minLength":1},"zipCode":{"type":"string","description":"Zip code","example":1000,"minLength":1},"city":{"type":"string","description":"City","example":"Bruxelles","minLength":1},"countryCode":{"type":"string","description":"Country code represented by the two letter country codes as defined in ISO 3166-1 alpha-2.","example":"BE"}},"required":["city","countryCode","houseNumber","streetName","zipCode"]},"UserPinCodeCreationRequest":{"type":"object","properties":{"pinCode":{"type":"string"}},"required":["pinCode"]},"UserPinCodeValidationRequest":{"type":"object","properties":{"pinCode":{"type":"string"}},"required":["pinCode"]},"UserPinCodeUpdateRequest":{"type":"object","properties":{"newPinCode":{"type":"string"},"pinCode":{"type":"string"}},"required":["newPinCode","pinCode"]},"SddConsentTransferActivationRequest":{"type":"object","properties":{"approvedContracts":{"type":"array","items":{"type":"integer","format":"int64"}},"password":{"type":"string"},"token":{"type":"string","minLength":1}},"required":["password","token"]},"PersonRegistrationRequest":{"type":"object","properties":{"emailAddress":{"type":"string","minLength":1},"password":{"type":"string","minLength":1},"language":{"type":"string"},"acceptedContracts":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true},"firstName":{"type":"string"},"lastName":{"type":"string"},"integratorId":{"type":"integer","format":"int64"},"businessContributorId":{"type":"integer","format":"int64"},"mainProduct":{"type":"string"}},"required":["acceptedContracts","emailAddress","password"]},"CompanyRegistrationRequest":{"type":"object","properties":{"emailAddress":{"type":"string","minLength":1},"password":{"type":"string","maxLength":64,"minLength":7},"language":{"type":"string"},"acceptedContracts":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true},"vatNumber":{"type":"string"},"identificationNumber":{"type":"string"},"tradeName":{"type":"string","minLength":1},"establishmentDate":{"type":"string","format":"date"},"contactFirstName":{"type":"string"},"contactLastName":{"type":"string"},"integratorId":{"type":"integer","format":"int64"},"businessContributorId":{"type":"integer","format":"int64"},"zoFinancialsIntegrator":{"type":"boolean"},"pack":{"type":"string"},"mainProduct":{"type":"string"},"originNewWebapp":{"type":"boolean"}},"required":["acceptedContracts","emailAddress","establishmentDate","password","tradeName"]},"PreRegistrationActivationRequest":{"type":"object","properties":{"approvedContracts":{"type":"array","items":{"type":"integer","format":"int64"}},"password":{"type":"string"},"token":{"type":"string","minLength":1}},"required":["password","token"]},"CustomerDataReviewConfirmationRequest":{"type":"object","properties":{"valid":{"type":"boolean"},"updateIsRequired":{"type":"boolean"},"dataToUpdate":{"type":"string"}},"required":["updateIsRequired"]},"CompanyInvitationDetails":{"type":"object","properties":{"issuers":{"type":"array","items":{"type":"string"}},"other":{"type":"string"}}},"FeedbackDetails":{"type":"object","properties":{"comment":{"type":"string","minLength":1}},"required":["comment"]},"DocumentDetailsResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"subtype":{"type":"string"},"mediaType":{"type":"string"},"size":{"type":"integer","format":"int64"}}},"RegistrationImage":{"type":"object","properties":{"multipartFile":{"type":"string","format":"binary"},"image":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"subType":{"type":"string","enum":["FRONT","BACK","FRONT_BACK","PROFILE","CERTIFICATE","UNKNOWN","OLD","RIB","BANK_SWITCHING"]},"mimeType":{"type":"string"}}},"AuthorizationCodeRequest":{"type":"object","properties":{"client_id":{"type":"string","format":"uuid","writeOnly":true},"clientId":{"type":"string","format":"uuid"}},"required":["clientId"]},"MultiValueMapStringString":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"properties":{"all":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true},"empty":{"type":"boolean"}}},"LegalEntityGenerationResponse":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"}}},"PaymentInput":{"type":"object","properties":{"name":{"type":"string"},"originIban":{"type":"string"},"creditorReference":{"type":"string"},"amount":{"type":"number","format":"double"}}},"CarpaPaymentInput":{"type":"object","properties":{"carpaUUID":{"type":"string","format":"uuid"},"amountInCents":{"type":"integer","format":"int64"},"debtorIban":{"type":"string"}}},"PinCodeConfirmationAction":{"type":"object","properties":{"pinCode":{"type":"string"},"transferID":{"type":"string","format":"uuid"},"role":{"type":"string"},"decision":{"type":"boolean"}}},"QuestionData":{"type":"object","properties":{"bankAccount":{"$ref":"#/components/schemas/BankAccountDetails"},"pep":{"type":"boolean"},"pack":{"type":"string","enum":["DISCOVER","START","GO","POC","UNKNOWN"]},"nationalities":{"type":"array","items":{"$ref":"#/components/schemas/NationalityDetails"}},"address":{"$ref":"#/components/schemas/AddressDetails"},"billingAddress":{"$ref":"#/components/schemas/AddressDetails"},"nrn":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"birthDay":{"type":"string","format":"date"},"civility":{"type":"string"},"sectors":{"type":"array","items":{"$ref":"#/components/schemas/SectorItem"}},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/UboDetails"}},"ubo":{"$ref":"#/components/schemas/UboDetails"},"finish":{"type":"boolean"},"pinCode":{"type":"string"},"pepCustomerExplanation":{"type":"string"},"birthPlace":{"type":"string"},"idDocumentValidityEnd":{"type":"string","format":"date"},"ibanImportantInfoAccepted":{"type":"boolean"},"companyStatusAreOnline":{"type":"boolean"}}},"CreateEmbeddedPaymentRequest":{"type":"object","properties":{"communication":{"type":"string"},"paymentUuid":{"type":"string"},"paymentMethod":{"type":"string"},"language":{"type":"string"},"amountInCents":{"type":"integer","format":"int64"}},"required":["paymentMethod","paymentUuid"]},"ApplePayMerchantRequest":{"type":"object","properties":{"validationUrl":{"type":"string"},"originDomain":{"type":"string"}},"required":["originDomain","validationUrl"]},"InitiateEmbeddedPaymentRequest":{"type":"object","properties":{"paymentUuid":{"type":"string"},"paymentMethod":{"type":"string"},"amountInCents":{"type":"integer","format":"int64"},"language":{"type":"string"},"token":{"type":"string"}},"required":["amountInCents","paymentMethod","paymentUuid","token"]},"PaymentConfirmationAction":{"type":"object","properties":{"pinCode":{"type":"string"},"paymentUUID":{"type":"string","format":"uuid"},"bankAccountSelection":{"$ref":"#/components/schemas/BankAccountSelection"},"executionDate":{"type":"string","format":"date"},"amount":{"type":"string"},"debtorIban":{"type":"string"}}},"RedirectView":{"type":"object","properties":{"applicationContext":{"$ref":"#/components/schemas/ApplicationContext"},"servletContext":{"$ref":"#/components/schemas/ServletContext","writeOnly":true},"contentType":{"type":"string"},"requestContextAttribute":{"type":"string"},"staticAttributes":{"type":"object","additionalProperties":{}},"exposePathVariables":{"type":"boolean"},"exposeContextBeansAsAttributes":{"type":"boolean","writeOnly":true},"exposedContextBeanNames":{"type":"array","items":{"type":"string"},"writeOnly":true},"beanName":{"type":"string"},"url":{"type":"string"},"contextRelative":{"type":"boolean","writeOnly":true},"http10Compatible":{"type":"boolean","writeOnly":true},"exposeModelAttributes":{"type":"boolean","writeOnly":true},"encodingScheme":{"type":"string","writeOnly":true},"statusCode":{"oneOf":[{"$ref":"#/components/schemas/DefaultHttpStatusCode"},{"$ref":"#/components/schemas/HttpStatus"}],"writeOnly":true},"expandUriTemplateVariables":{"type":"boolean","writeOnly":true},"propagateQueryParams":{"type":"boolean","writeOnly":true},"hosts":{"type":"array","items":{"type":"string"}},"redirectView":{"type":"boolean"},"propagateQueryProperties":{"type":"boolean"},"attributes":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true},"attributesMap":{"type":"object","additionalProperties":{}},"attributesCSV":{"type":"string","writeOnly":true}}},"PaymentOptinRequest":{"type":"object","properties":{"paymentId":{"type":"string","format":"uuid"},"email":{"type":"string","maxLength":255,"minLength":0}},"required":["email","paymentId"]},"PaymentActionResult":{"type":"object","properties":{"channelKnown":{"type":"boolean"},"invoiceID":{"type":"string","format":"uuid"},"deliveryChannels":{"type":"array","items":{"type":"string","enum":["DIGITEAL","ORIGINAL"]}},"redirectURL":{"type":"string"},"issuer":{"type":"string"},"companyId":{"type":"integer","format":"int64"},"clientId":{"type":"integer","format":"int64"},"proposeAutoPayment":{"type":"boolean"},"success":{"type":"boolean"},"errorCode":{"type":"string"}}},"PisRequest":{"type":"object","properties":{"bankId":{"type":"integer","format":"int32"},"language":{"type":"string"},"debtorAdditionalSteps":{"$ref":"#/components/schemas/PisDebtorAdditionalStepsRequest"}},"required":["bankId","language"]},"AisRequest":{"type":"object","properties":{"aisIdentifier":{"type":"string","format":"uuid"},"bankId":{"type":"integer","format":"int32"},"language":{"type":"string"},"additionalSteps":{"$ref":"#/components/schemas/AisAdditionalStepsRequest"}},"required":["aisIdentifier","bankId","language"]},"AisResponse":{"type":"object","properties":{"redirectUrl":{"type":"string"}}},"UserActionInput":{"type":"object","properties":{"domain":{"type":"string","enum":["DEMO_MODE"]},"action":{"type":"string","enum":["START","ACCOUNT_CREATION_STARTED"]}},"required":["action","domain"]},"QRDetails":{"type":"object","properties":{"iban":{"type":"string"},"reference":{"type":"string"},"name":{"type":"string"},"amount":{"type":"number","format":"double"},"information":{"type":"string"},"amountInCents":{"type":"number"}}},"PaymentButtonPaymentRequest":{"type":"object","properties":{"invoiceUUID":{"type":"string","description":"The identifier of the invoice as received when created with Digiteal","example":"e529f8b4790f11e7b5a5be2e44b06b52"},"trustedPaymentUUID":{"type":"string","description":"The identifier of the trusted payment as received when created with Digiteal","example":"e529f8b4790f11e7b5a5be2e44b06b52"},"requesterVAT":{"type":"string","description":"The VAT number of the creditor","example":"BE0000000097"},"requesterIdentificationNumber":{"type":"string"},"iban":{"type":"string","description":"The IBAN of the creditor. It if is not provided, the default IBAN of the requester will be used.","example":"BE40251230861709"},"amountInCents":{"type":"integer","format":"int64","description":"The amount to pay (in cents)","example":1234},"minAmountInCents":{"type":"integer","format":"int64","description":"The minimum amount to pay (in cents, cannot be used at the same time as amountInCents)","example":500},"maxAmountInCents":{"type":"integer","format":"int64","description":"The maximum amount to pay (in cents, cannot be used at the same time as amountInCents)","example":50000},"suggestedAmountInCents":{"type":"integer","format":"int64","description":"The suggested amount to pay (in cents, cannot be used at the same time as amountInCents)","example":50000},"language":{"type":"string","description":"The language of the button to be displayed (EN, NL or FR). Default is EN.","example":"EN"},"creditorReference":{"type":"string","description":"The structured reference used by the biller to reconcile the payment. This is also called the structured communication in Belgium. Both BBA (Belgium) and ISO (International) types are supported. It can be left empty if the remittanceInfo is defined","example":"000600232562"},"remittanceInfo":{"type":"string","description":"An unstructured string that is used as communication in the payment. This information is only used if there is nol creditorReference. It can be left empty if the creditorReference is defined","example":"Bill1234"},"customerInternalId":{"type":"string","description":"The identifier of the debtor as defined by the creditor","example":"Customer1234"},"customerEmail":{"type":"string","description":"The email of the debtor","example":"john.doe@me.com"},"multiple":{"type":"boolean","description":"True if you want to accept multiple payments with this description. Default value is false.","example":false},"errorURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when the payment has not been completed successfully (mandatory in case of interactive payment). Maximum length of 255 characters.","example":"https://api.myservice.com/paymentError"},"cancelURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when the payment is cancelled (reverts to errorURL if it is not present). Maximum length of 255 characters.","example":"https://api.myservice.com/paymentCancelled"},"confirmationURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when the payment has been completed successfully (mandatory in case of interactive payment). Maximum length of 255 characters.","example":"https://api.myservice.com/paymentConfirmed"},"type":{"type":"string","description":"Define the format of the output image. Default is PNG.","enum":["PNG, SVG"],"example":"PNG","pattern":"(PNG)|(SVG)"},"paymentMethod":{"type":"string","description":"The payment method that is to be used. If it is defined, only that payment method will be available. If left empty, all the payment methods supported by the creditor will be available to the user.","enum":["DIGITEAL_STANDARD","PIS_STANDARD","BANCONTACT","IDEAL","VISA","MASTERCARD","CARTE_BLEUE","MAESTRO","PAYCONIQ","PIS_STANDARD"],"example":"BANCONTACT","pattern":"(DIGITEAL_STANDARD)|(BANCONTACT)|(IDEAL)|(VISA)|(MASTERCARD)|(CARTE_BLEUE)|(MAESTRO)|(PAYCONIQ)|(PIS_STANDARD)"},"allowedPaymentMethods":{"type":"string","description":"A list of comma separated values of payment method that we want to only allow for a specific payment","example":"VISA,MASTERCARD,BANCONTACT"},"qrCode":{"type":"boolean","description":"If true, the QR code (for Bancontact payment method), will be displayed for example to enable the payment by a third party and not the user.","example":false},"paymentInternalId":{"type":"string","description":"The internal identifier of the payment as known by the creditor","example":"Payment1234"},"mobile":{"type":"boolean","description":"True if this is a payment to be executed on a mobile device. False by default","example":true},"emailOptin":{"type":"boolean","description":"Triggers the email optin retrieval in the payment flow.","example":true}}},"IssuerDetails":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","minLength":1},"language":{"type":"string","enum":["FR","EN","ES","NL","DE"]},"logo":{"type":"string"},"smallLogo":{"type":"string"},"vatNumber":{"type":"string"},"identificationNumber":{"type":"string","minLength":1},"streetName":{"type":"string"},"houseNumber":{"type":"string"},"zipCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"bankAccountDetails":{"type":"array","items":{"$ref":"#/components/schemas/BankAccountDetails"}},"status":{"type":"string","enum":["NONE","PROD","ONHOLD","ONHOLD_PEPPOL","MERGED"]},"validationCheckState":{"type":"string","enum":["PENDING","RENEWED","OK","FAILED","NONE","EXPIRED","DELETED"]},"userDetails":{"$ref":"#/components/schemas/EmitterUserDetails"},"hasNewOptins":{"type":"boolean"},"pack":{"type":"string"}},"required":["identificationNumber","name"]},"IntegratorOverview":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/IntegratorDetails"},"possibilities":{"type":"array","items":{"$ref":"#/components/schemas/IntegratorDetails"}}}},"IntegratorDetails":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"integer","format":"int64"}}},"InvoiceCommentCreationRequest":{"type":"object","properties":{"invoiceId":{"type":"string","format":"uuid"},"comment":{"type":"string","maxLength":1000,"minLength":0}},"required":["comment","invoiceId"]},"PapiTimeBasedTransfer":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"minimumAmount":{"type":"number","format":"double"},"endDate":{"type":"string","format":"date"},"creditorPayments":{"type":"array","items":{"$ref":"#/components/schemas/PapiTimeBasedTransferPayment"}},"name":{"type":"string"}}},"CalculatePricing":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"maxAmount":{"type":"number","format":"double"}},"required":["amount"]},"PricingResult":{"type":"object","properties":{"cost":{"type":"number","format":"double"},"maxCost":{"type":"number","format":"double"},"vatIncluded":{"type":"boolean"}}},"PaymentButtonPaymentRequestDigitrust":{"type":"object","properties":{"digitrustUUID":{"type":"string","format":"uuid","minLength":1},"creditorReference":{"type":"string"},"remittanceInfo":{"type":"string"},"language":{"type":"string"},"confirmationURL":{"type":"string"},"errorURL":{"type":"string"},"cancelURL":{"type":"string"},"amountInCents":{"type":"integer","format":"int64"}},"required":["digitrustUUID"]},"ConfirmationBasedTransfer":{"type":"object","properties":{"requesterVAT":{"type":"string","description":"The VAT number of the Requester. The requesterVAT needs to be filled in if the transfer is created by an integrator in the name of the Requester.","example":"BE0000000196"},"projectName":{"type":"string","description":"The name of the transfer","example":"Corvette VIN 1234567890123456"},"transferPayments":{"type":"array","description":"List of outgoing payments to perform when this transfer will be confirmed. There should at least be one payment.","items":{"$ref":"#/components/schemas/Payment"}},"actors":{"type":"array","description":"List of actors participating in the transfer. There will typically be a buyer and a seller as actor but any combination can do. There should at least be one actor to receive the funds.","items":{"$ref":"#/components/schemas/Actor"}},"hidePaymentDetails":{"type":"boolean","description":"True if the details of the outgoing payments should not be displayed to the buyer, false otherwise. This is useful for example when there is a commission planned but you do not want this to be disclosed to the buyer.","example":true},"confirmedBuyer":{"type":"boolean","description":"True if the buyer has confirmed he wants to buy, false otherwise (default is true).","example":true},"delayToCollect":{"type":"integer","format":"int32","description":"The number of calendar days after the transfer was confirmed on which the money will be withdrawn from the buyers account. This only applies if this transfer is linked to a buffer account. Default is 60 days.","example":60},"notifyOfPaymentReceived":{"type":"boolean","description":"Notifications should be sent when there is a pay-in, cancellation or success for this Digitrust. True by default."}},"required":["actors","projectName","transferPayments"]},"CBTProposalRequest":{"type":"object","properties":{"transferUUID":{"type":"string","format":"uuid"},"comment":{"type":"string"},"pinCode":{"type":"string"},"transferPayments":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}}}},"BuyerInvitationAction":{"type":"object","properties":{"transferID":{"type":"string","format":"uuid"},"email":{"type":"string"},"language":{"type":"string"}}},"PinCodeCancelAction":{"type":"object","properties":{"pinCode":{"type":"string"},"transferID":{"type":"string","format":"uuid"},"comment":{"type":"string"}}},"ContestParticipantDetails":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"contestId":{"type":"integer","format":"int64"},"registrationDate":{"type":"string","format":"date-time"},"participating":{"type":"boolean"}}},"CommentEventSearch":{"type":"object","properties":{"invoiceId":{"type":"string"},"commentId":{"type":"integer","format":"int64"}}},"PagedResourcesAssemblerInvoiceCommentDto":{"type":"object","properties":{"forceFirstAndLastRels":{"type":"boolean","writeOnly":true}}},"Pageable":{"type":"object","properties":{"page":{"type":"integer","format":"int32","minimum":0},"size":{"type":"integer","format":"int32","minimum":1},"sort":{"type":"array","items":{"type":"string"}}}},"PagedModel":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"PagedResourcesAssemblerAutoPayConfig":{"type":"object","properties":{"forceFirstAndLastRels":{"type":"boolean","writeOnly":true}}},"PagedModelEntityModelAutoPayConfig":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/EntityModelAutoPayConfig"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"AutoPayCreation":{"type":"object","properties":{"autoPayConfig":{"$ref":"#/components/schemas/AutoPayConfig"},"pinCode":{"type":"string"}}},"MandateRequest":{"type":"object","properties":{"iban":{"type":"string"},"name":{"type":"string","maxLength":255,"minLength":0}},"required":["iban","name"]},"UboDetails":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"firstName":{"type":"string"},"lastName":{"type":"string"},"birthDate":{"type":"string","format":"date"},"birthPlace":{"type":"string"},"ownsMin25Percent":{"type":"boolean"},"controlsCompany":{"type":"boolean"},"hasSigningAuthority":{"type":"boolean"},"endDate":{"type":"string","format":"date"},"pepRelated":{"type":"boolean"}}},"PeppolIntegratorCreationRequest":{"type":"object","properties":{"emailAddress":{"type":"string"},"integrator":{"type":"integer","format":"int64"}},"required":["emailAddress","integrator"]},"AuthVO":{"type":"object","properties":{"token":{"type":"string"},"origin":{"type":"string"}}},"CompanyCustomizationResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"companyId":{"type":"integer","format":"int64"},"color":{"type":"string"},"logoUrl":{"type":"string","format":"url"},"primaryColor":{"type":"string"},"primaryFontColor":{"type":"string"},"backgroundImageUrl":{"type":"string"},"showWebAppVersion":{"type":"boolean"},"paymentChoiceShowCreditorIban":{"type":"boolean"},"activatedPaymentMethodOrder":{"$ref":"#/components/schemas/ActivatedPaymentMethodOrder"}},"required":["companyId","id"]},"CompanyCustomizationRequest":{"type":"object","properties":{"color":{"type":"string"},"primaryColor":{"type":"string"},"primaryFontColor":{"type":"string"},"showWebAppVersion":{"type":"boolean"},"paymentChoiceShowCreditorIban":{"type":"boolean"},"activatedPaymentMethodOrder":{"$ref":"#/components/schemas/ActivatedPaymentMethodOrderRequest"}}},"InvoiceCommentDeletionRequest":{"type":"object","properties":{"commentId":{"type":"string","format":"uuid"}},"required":["commentId"]},"TechnicalUserCreationRequest":{"type":"object","properties":{"representedLegalEntity":{"type":"integer","format":"int64"},"emailAddress":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}},"required":["emailAddress","representedLegalEntity","username"]},"CompanyUserCreationRequest":{"type":"object","properties":{"emailAddress":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"representedCompany":{"type":"integer","format":"int64"}},"required":["emailAddress","representedCompany"]},"AdminUserCreationRequest":{"type":"object","properties":{"emailAddress":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}},"required":["emailAddress","password","username"]},"TspConfigAdminRequest":{"type":"object","properties":{"companyIdentifier":{"type":"integer","format":"int64"},"tsp":{"type":"string","enum":["FINARO"]},"tspKey":{"type":"string"},"mitEnabled":{"type":"boolean"},"gatewayId":{"type":"string"}},"required":["companyIdentifier","gatewayId","mitEnabled","tsp","tspKey"]},"PersonDetailsOutput":{"type":"object","properties":{"login":{"type":"string"},"oldLogin":{"type":"string"},"supportExplanation":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"phoneNumber":{"type":"string"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string"},"language":{"type":"string"},"address":{"$ref":"#/components/schemas/AddressDetails"},"idCheckState":{"type":"string"},"sex":{"type":"string"},"pep":{"type":"boolean"},"pepCustomerExplanation":{"type":"string"},"ubo":{"type":"boolean"},"registrationDate":{"type":"string","format":"date-time"},"activationReason":{"type":"string"},"nationalities":{"type":"array","items":{"$ref":"#/components/schemas/NationalityDetails"}},"evaluation":{"$ref":"#/components/schemas/EvaluationDetails"},"validityEnd":{"type":"string","format":"date"},"sectors":{"type":"array","items":{"$ref":"#/components/schemas/SectorDetailsOutput"},"uniqueItems":true},"mandates":{"type":"array","items":{"$ref":"#/components/schemas/MandateDetails"}},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentDetails"}},"allServicesAreEnabled":{"type":"boolean"},"nrn":{"type":"string"},"nrnAlreadyUsed":{"type":"boolean"},"nrnAlreadyUsedEmailAddressList":{"type":"array","items":{"type":"string"}},"nrnAlreadyUsedIdList":{"type":"array","items":{"type":"integer","format":"int64"}},"companyIdLinkedToContactPerson":{"type":"integer","format":"int64"},"companiesIdLinkedToUbo":{"type":"array","items":{"type":"integer","format":"int64"}},"loginIsBlocked":{"type":"boolean"},"pinCodeIsBlocked":{"type":"boolean"},"isaMandateIsBlocked":{"type":"boolean"},"automaticallyValidated":{"type":"boolean"},"paymentChoiceMigrated":{"type":"boolean"}}},"PersonDetailsInput":{"type":"object","properties":{"login":{"type":"string"},"oldLogin":{"type":"string"},"supportExplanation":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"phoneNumber":{"type":"string"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string"},"language":{"type":"string"},"address":{"$ref":"#/components/schemas/AddressDetails"},"idCheckState":{"type":"string"},"sex":{"type":"string"},"pep":{"type":"boolean"},"pepCustomerExplanation":{"type":"string"},"ubo":{"type":"boolean"},"registrationDate":{"type":"string","format":"date-time"},"activationReason":{"type":"string"},"nationalities":{"type":"array","items":{"$ref":"#/components/schemas/NationalityDetails"}},"evaluation":{"$ref":"#/components/schemas/EvaluationDetails"},"validityEnd":{"type":"string","format":"date"},"sectors":{"type":"array","items":{"$ref":"#/components/schemas/SectorDetailsInput"}},"mandates":{"type":"array","items":{"$ref":"#/components/schemas/MandateDetails"}},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentDetails"}},"allServicesAreEnabled":{"type":"boolean"},"nrn":{"type":"string"},"companyIdLinkedToContactPerson":{"type":"integer","format":"int64"},"companiesIdLinkedToUbo":{"type":"array","items":{"type":"integer","format":"int64"}},"paymentChoiceMigrated":{"type":"boolean"}}},"AdditionalInformationInput":{"type":"object","properties":{"text":{"type":"string","minLength":1}},"required":["text"]},"DataValidationResultRequest":{"type":"object","properties":{"valid":{"type":"boolean"},"sentToJiraSupport":{"type":"boolean"},"publicRejectedReason":{"type":"string"},"internalNote":{"type":"string"},"updateTemplateActivated":{"type":"boolean"}}},"OpenBankingBankDeactivatedAdminRequest":{"type":"object","properties":{"bankName":{"type":"string"}},"required":["bankName"]},"OpenBankingCountryAdminRequest":{"type":"object","properties":{"service":{"type":"string","enum":["AIS","PIS"]},"country":{"$ref":"#/components/schemas/CountryCode"}},"required":["country","service"]},"OpenBankingCompanyConfigAdminRequest":{"type":"object","properties":{"service":{"type":"string","enum":["AIS","PIS"]},"companyId":{"type":"integer","format":"int64"},"customDomain":{"type":"string"},"hasLimitedCountries":{"type":"boolean"},"limitedCountries":{"type":"array","items":{"$ref":"#/components/schemas/CountryCode"}},"transactionValidationActivated":{"type":"boolean"},"amountDaysTransactionValidation":{"type":"integer","format":"int32"}},"required":["companyId","hasLimitedCountries","service"]},"MandateBankSwitchingRequest":{"type":"object","properties":{"newIban":{"type":"string","minLength":1},"documentId":{"type":"string","minLength":1}},"required":["documentId","newIban"]},"MandateValidationRequest":{"type":"object","properties":{"reason":{"type":"string","maxLength":255,"minLength":1}},"required":["reason"]},"MandateAddDocumentInput":{"type":"object","properties":{"documentId":{"type":"string","minLength":1}},"required":["documentId"]},"MandateInvalidationRequest":{"type":"object","properties":{"reason":{"type":"string","maxLength":255,"minLength":1}},"required":["reason"]},"FinaroGatewayConfigAdminResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"gatewayId":{"type":"string"},"mcc":{"type":"integer","format":"int32"},"cipherKey":{"type":"string"},"staticKey":{"type":"string"}}},"FinaroGatewayConfigAdminRequest":{"type":"object","properties":{"gatewayId":{"type":"string"},"mcc":{"type":"integer","format":"int32"},"cipherKey":{"type":"string"},"staticKey":{"type":"string"},"type":{"type":"string"}},"required":["cipherKey","gatewayId","mcc","staticKey","type"]},"DocumentDetails":{"type":"object","properties":{"status":{"type":"string"},"name":{"type":"string"},"uuid":{"type":"string"},"type":{"type":"string"},"subType":{"type":"string"},"url":{"type":"string"}}},"ContestDetails":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"companyName":{"type":"string"},"companyVAT":{"type":"string"},"summaryKey":{"type":"string"},"urlKey":{"type":"string"},"urlRulesKey":{"type":"string"},"sinceDate":{"type":"string","format":"date-time"},"toDate":{"type":"string","format":"date-time"}}},"CompanyDetailsOutput":{"type":"object","properties":{"login":{"type":"string"},"oldLogin":{"type":"string"},"supportExplanation":{"type":"string"},"pack":{"type":"string"},"activeProfile":{"$ref":"#/components/schemas/CompanyProfileDetails"},"nextProfile":{"$ref":"#/components/schemas/CompanyProfileDetails"},"mandates":{"type":"array","items":{"$ref":"#/components/schemas/MandateDetails"}},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentDetails"}},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/UboDetails"}},"evaluation":{"$ref":"#/components/schemas/EvaluationDetails"},"sectorDetails":{"type":"array","items":{"$ref":"#/components/schemas/SectorDetailsOutput"},"uniqueItems":true},"integrationDetails":{"$ref":"#/components/schemas/IntegrationDetails"},"idCheckState":{"type":"string"},"nbOfCustomers":{"type":"integer","format":"int32"},"activationReason":{"type":"string"},"contactPersonId":{"type":"integer","format":"int64"},"loginIsBlocked":{"type":"boolean"},"pinCodeIsBlocked":{"type":"boolean"},"isaMandateIsBlocked":{"type":"boolean"},"paymentChoiceMigrated":{"type":"boolean"},"notificationMuted":{"type":"boolean"},"deleted":{"type":"boolean"}}},"CompanyDetailsInput":{"type":"object","properties":{"login":{"type":"string"},"oldLogin":{"type":"string"},"supportExplanation":{"type":"string"},"pack":{"type":"string"},"activeProfile":{"$ref":"#/components/schemas/CompanyProfileDetails"},"nextProfile":{"$ref":"#/components/schemas/CompanyProfileDetails"},"mandates":{"type":"array","items":{"$ref":"#/components/schemas/MandateDetails"}},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentDetails"}},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/UboDetails"}},"evaluation":{"$ref":"#/components/schemas/EvaluationDetails"},"sectorDetails":{"type":"array","items":{"$ref":"#/components/schemas/SectorDetailsInput"}},"integrationDetails":{"$ref":"#/components/schemas/IntegrationDetails"},"idCheckState":{"type":"string"},"nbOfCustomers":{"type":"integer","format":"int32"},"activationReason":{"type":"string"},"contactPersonId":{"type":"integer","format":"int64"},"paymentChoiceMigrated":{"type":"boolean"},"deleted":{"type":"boolean"}}},"UboRequest":{"type":"object","properties":{"lastName":{"type":"string"},"firstName":{"type":"string"},"birthDay":{"type":"string"},"birthPlace":{"type":"string"},"pep":{"type":"boolean"},"pepExplanation":{"type":"string"},"comment":{"type":"string"}}},"PSPConfigurationAdminInput":{"type":"object","properties":{"psp":{"type":"string","minLength":1},"secretKey":{"type":"string"},"websiteKey":{"type":"string"},"pspConfigurationId":{"type":"integer","format":"int64"}},"required":["psp"]},"PaymentMethodAdminInput":{"type":"object","properties":{"paymentMethod":{"type":"string","minLength":1},"pspConfiguration":{"type":"integer","format":"int64"}},"required":["paymentMethod"]},"AutomaticValidationDetails":{"type":"object","properties":{"tests":{"type":"array","items":{"$ref":"#/components/schemas/ValidationResultDetails"}}}},"RiskEvaluationInput":{"type":"object","properties":{"abstractPersonId":{"type":"integer","format":"int64"}},"required":["abstractPersonId"]},"RiskEvaluationOutput":{"type":"object","properties":{"evaluation":{"type":"integer","format":"int32"},"decision":{"type":"string"}}},"WebHookConfigurationInfo":{"type":"object","properties":{"vatNumber":{"type":"string","description":"VAT number of the company for whom the webhooks are configured. This should only be used by integrators.","example":"BE0000000097"},"identificationNumber":{"type":"string","description":"Identification number of the company for whom the webhooks are configured. This should only be used by integrators. (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"login":{"type":"string","description":"Login used to call the webhooks (in the HTTP Basic Auth). If no login/password is provided or if the webhook is sent by email then this will not be used.","example":"userLogin"},"webHooks":{"type":"array","description":"Webhooks","items":{"$ref":"#/components/schemas/WebHookInfo"}}}},"WebHookInfo":{"type":"object","properties":{"type":{"type":"string","description":"Type of webhook to configure.","enum":["AUTOPAY_CONFIGURATION_ACTIVATED","AUTOPAY_CONFIGURATION_CANCELLED","AUTOPAY_CONFIGURATION_CREATED","AUTOPAY_CONFIGURATION_SUSPENDED","AUTOPAY_CONFIGURATION_UPDATED","COMPANY_CHANGED_INTEGRATOR","COMPANY_CHANGED_TRUSTED_PAYMENT_INTEGRATOR","COMPANY_CREATED","COMPANY_DELETED","COMPANY_PUT_ON_HOLD","COMPANY_REJECTED","COMPANY_UPDATED","COMPANY_VALIDATED","COMPANY_VALIDATED_BY_ACQUIRER","COMPANY_REJECTED_BY_ACQUIRER","TERMINAL_VALIDATED_BY_ACQUIRER","TERMINAL_REJECTED_BY_ACQUIRER","CREDIT_NOTE_DOCUMENT_ADDED","CREDIT_NOTE_PUBLISHED","CUSTOMER_OPTIN","CUSTOMER_OPTOUT","INVOICE_COMMENTED","INVOICE_DOCUMENT_ADDED","INVOICE_PAID","INVOICE_PUBLISHED","INVOICE_READ","INVOICE_UNPAID","MANDATE_AUTHORIZATION_STATUS","PAYMENT_BULK_PAYOUT","PAYMENT_CARD_TOKEN_CREATED","PAYMENT_CARD_TOKEN_RESERVED","PAYMENT_INITIATED","PAYMENT_INITIATED_V2","PAYMENT_INITIATION_ERROR","PAYMENT_INITIATION_ERROR_V2","PAYMENT_RECEIVED_IN_TRANSIT","PAYMENT_TRANSFERRED","PAYMENT_WITHDRAWAL_ERROR","PAYMENT_WITHDRAWAL_SUCCESS","PEPPOL_CREDIT_NOTE_RECEIVED","PEPPOL_FUTURE_VALIDATION_FAILED","PEPPOL_INVOICE_RECEIVED","PEPPOL_INVOICE_RESPONSE_RECEIVED","PEPPOL_MLR_RECEIVED","PEPPOL_TRANSPORT_ACK_RECEIVED","PEPPOL_SELF_BILLING_INVOICE_RECEIVED","PEPPOL_SELF_BILLING_CREDIT_NOTE_RECEIVED","PEPPOL_SEND_PROCESSING_OUTCOME","PERSON_CHANGED_INTEGRATOR","PERSON_CHANGED_TRUSTED_PAYMENT_INTEGRATOR","PERSON_CREATED","PERSON_DELETED","PERSON_PUT_ON_HOLD","PERSON_REJECTED","PERSON_UPDATED","PERSON_VALIDATED","REIMBURSEMENT_RECEIVED_FROM_CREDITOR","REIMBURSMENT_TO_CLIENT_FROM_DIGITEAL","REIMBURSMENT_TO_CLIENT_FROM_REQUESTOR","TRANSFER_CREATED","TRANSFER_PAYMENT_COMPLETED","TRANSFER_PAYMENT_RECEIVED","TRANSFER_PAYMENT_STARTED","TRANSFER_REIMBURSEMENT_COMPLETED","TRANSFER_REIMBURSEMENT_STARTED","FUNDS_RECEIVED_IN_BUFFER"],"example":"PAYMENT_INITIATED"},"url":{"type":"string","description":"URL called by the webhook. For initial setup and testing purpose, you can also set to receive the webhook as an email using a URL starting with \"mailto:\".","example":"https://myIntegrator.com/myApp/paymentInitiated"}},"required":["type","url"]},"TimeBasedTransfer":{"type":"object","properties":{"projectName":{"type":"string","description":"Project name of the trusted payment","example":"Crowd-lending for CompanyX"},"amountInCents":{"type":"integer","format":"int64","description":"The maximum amount of the trusted payment. If this amount is reached the total amount will be transferred to the creditor.","example":20000000},"minumumAmountInCents":{"type":"integer","format":"int64","description":"The minimum amount of the trusted payment. If this amount is reached on the end date of the trusted payment the total amount will be transferred to the creditor.","example":10000000},"endDate":{"type":"string","format":"date","description":"The end date of the trusted payment. If the amount requirements are not met before this date the transfer is canceled and the clients are reimbursed. Format: dd/MM/yyyy","example":"31/12/2019"},"creditorPayments":{"type":"array","description":"This list contains the details of the outgoing payments that will be wired when the minimum requirements are met. At least one should be present.","items":{"$ref":"#/components/schemas/TimeBasedTransferPayment"}},"notifyOfPaymentReceived":{"type":"boolean","description":"Notifications should be sent when there is a pay-in, cancellation or success for this Digitrust. True by default."}},"required":["amountInCents","creditorPayments","endDate"]},"TransferCreationResult":{"type":"object","properties":{"creditorReference":{"type":"string","description":"The creditor reference. Use this creditor reference when adding (wire transfer) an amount for this digitrust.","example":"RF84U6"},"transferID":{"type":"string","format":"uuid","description":"The unique identifier of the digitrust","example":"e529f8b4790f11e7b5a5be2e44b06b52"},"transferIDx64":{"type":"string"}}},"TimeBasedTransferInfo":{"type":"object","properties":{"projectName":{"type":"string","description":"Project name of the trusted payment","example":"Crowd-lending for CompanyX"},"amountInCents":{"type":"integer","format":"int64","description":"The maximum amount of the trusted payment. If this amount is reached the total amount will be transferred to the creditor.","example":20000000},"minumumAmountInCents":{"type":"integer","format":"int64","description":"The minimum amount of the trusted payment. If this amount is reached on the end date of the trusted payment the total amount will be transferred to the creditor.","example":10000000},"endDate":{"type":"string","format":"date","description":"The end date of the trusted payment. If the amount requirements are not met before this date the transfer is canceled and the clients are reimbursed. Format: dd/MM/yyyy","example":"31/12/2019"},"creditorPayments":{"type":"array","description":"This list contains the details of the outgoing payments that will be wired when the minimum requirements are met. At least one should be present.","items":{"$ref":"#/components/schemas/TimeBasedTransferPayment"}},"notifyOfPaymentReceived":{"type":"boolean","description":"Notifications should be sent when there is a pay-in, cancellation or success for this Digitrust. True by default."},"availableAmountInCents":{"type":"integer","format":"int64","description":"The amount of funds available for this trusted payment. Only funds that have reached Digiteal's segregated account are considered. Funds in flight are not.","example":15000000}},"required":["amountInCents","availableAmountInCents","creditorPayments","endDate"]},"TransferExecutionData":{"type":"object","properties":{"requesterVAT":{"type":"string","description":"The VAT number of the Requester. The requesterVAT needs to be filled in if the transfer execution is created by an integrator in the name of the Requester.","example":"BE0000000196"},"transferID":{"type":"string","format":"uuid","description":"The transfer unique identifier received upon creation","example":"e529f8b4790f11e7b5a5be2e44b06b52"},"transferIDs":{"type":"array","description":"The transfer unique identifiers received upon creation","items":{"type":"string","format":"uuid"}},"validate":{"type":"boolean","description":"Boolean indicating if you want to execute the transfer (true) or cancel the transfer(false). Canceling will reimburse the clients.","example":true},"comment":{"type":"string","description":"optional field for a comment","example":"Glad to participate !"}}},"ConfirmationBasedTransferInfo":{"type":"object","properties":{"requesterVAT":{"type":"string","description":"The VAT number of the Requester. The requesterVAT needs to be filled in if the transfer is created by an integrator in the name of the Requester.","example":"BE0000000196"},"projectName":{"type":"string","description":"The name of the transfer","example":"Corvette VIN 1234567890123456"},"transferPayments":{"type":"array","description":"List of outgoing payments to perform when this transfer will be confirmed. There should at least be one payment.","items":{"$ref":"#/components/schemas/Payment"}},"actors":{"type":"array","description":"List of actors participating in the transfer. There will typically be a buyer and a seller as actor but any combination can do. There should at least be one actor to receive the funds.","items":{"$ref":"#/components/schemas/Actor"}},"hidePaymentDetails":{"type":"boolean","description":"True if the details of the outgoing payments should not be displayed to the buyer, false otherwise. This is useful for example when there is a commission planned but you do not want this to be disclosed to the buyer.","example":true},"confirmedBuyer":{"type":"boolean","description":"True if the buyer has confirmed he wants to buy, false otherwise (default is true).","example":true},"delayToCollect":{"type":"integer","format":"int32","description":"The number of calendar days after the transfer was confirmed on which the money will be withdrawn from the buyers account. This only applies if this transfer is linked to a buffer account. Default is 60 days.","example":60},"notifyOfPaymentReceived":{"type":"boolean","description":"Notifications should be sent when there is a pay-in, cancellation or success for this Digitrust. True by default."},"availableAmountInCents":{"type":"integer","format":"int64","description":"The amount of funds available for this trusted payment. Only funds that have reached Digiteal's segregated account are considered. Funds in flight are not.","example":15000000},"paymentsIn":{"type":"array","description":"The list of pay-ins related to this trusted payment.","items":{"$ref":"#/components/schemas/PaymentIn"}}},"required":["actors","availableAmountInCents","projectName","transferPayments"]},"ConfirmationBasedTransferPaymentData":{"type":"object","properties":{"requesterVAT":{"type":"string","description":"The VAT number of the Requester. The requesterVAT needs to be filled in if the transfer execution is created by an integrator in the name of the Requester.","example":"BE0000000196"},"updates":{"type":"array","description":"The details of the updates to perform","items":{"$ref":"#/components/schemas/ConfirmationBasedTransferPaymentUpdate"}}},"required":["updates"]},"ShortLinkRequest":{"type":"object","properties":{"longURL":{"type":"string","description":"Long URL of max 1024 characters that must contain \"digiteal.eu/api/v1/payment-request/pay-button/execute\".","example":"https://app.digiteal.eu/api/v1/payment-request/pay-button/execute?requesterVAT=BE0406729809&amountInCents=4000&iban=BE72000000001616&language=en&remittanceInfo=Urgency%20Fund&multiple=true&confirmationURL=https://api.myservice.com/paymentConfirmed&cancelURL=https://api.myservice.com/paymentCancelled&errorURL=https://api.myservice.com/paymentError&multiple=true"}},"required":["longURL"]},"ShortLinkResponse":{"type":"object","properties":{"shortURL":{"type":"string","description":"Short URL","example":"https://app.digiteal.eu/p/abcde"}},"required":["shortURL"]},"PersonSDDConfiguration":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/AutoPaymentConfiguration","description":"Autopayment configuration that will defines the parameters of the SDD mandate. Here are the default parameters if no configuration was provided: Monthly, payment on request date, maximum 1000€."},"creditorVatNumber":{"type":"string","description":"VAT number of the SDD mandate holder (the creditor). The creditor must have an active Digiteal account with at least the START pack.","example":"BE0000000097"},"creditorIdentificationNumber":{"type":"string","description":"The national identification number of the Creditor. The creditorVatNumber or the creditorIdentificationNumber needs to be filled in  (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"creationDate":{"type":"string","description":"The date when the original SDD mandate was created. The expected format is YYYY-MM-DD","example":"2012-12-31"},"debtorIBAN":{"type":"string","description":"The IBAN from which the SDD mandate will be withdrawing money (aka debtor IBAN).","example":"BE40251230861709"},"customerInternalId":{"type":"string","description":"Identifier of the customer as defined by the creditor","example":"TEST12345"},"contractApproval":{"$ref":"#/components/schemas/ContractApproval","description":"Customer contract approval that defines when and how the customer approved the terms and conditions of Digiteal (see <a href='#operation--api-v1-kyc-contractsForCompany-get'>getCompanyContracts</a> to get the terms and conditions)."},"notificationSettings":{"$ref":"#/components/schemas/CustomerNotificationSettings","description":"Notification settings for this customer (these will be used only if this is a new user of Digiteal)"},"welcomeMessage":{"type":"string","description":"Specific welcome message that will be sent by email. Please be careful to send a message in the language of the customer.","example":"We inform you that your SEPA mandate for YourTelecom is transferred to Digiteal, a Belgian company that is a partner of Belfius."},"returnURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when the customer has set his password. Maximum length of 255 characters.","example":"https://www.myportal.com/digitealRegistrationConfirmed"},"product":{"type":"string","description":"Product for which this pre-registration is initiated. Default is INVOICING.","enum":["INVOICING","PAYMENT","DIGITRUST","PEPPOL","TERMS_TECH","ZOFINANCIALS"],"example":"INVOICING"},"complete":{"type":"boolean","description":"Defines if the SDD configuration contains enough data to be evaluated by Digiteal's compliance dept. Default value is true.","example":true},"transferID":{"type":"string","format":"uuid","description":"The unique identifier of the digitrust if this SDD is set up for digitrust pay-ins","example":"e529f8b4790f11e7b5a5be2e44b06b52"},"debtor":{"$ref":"#/components/schemas/PersonKYCInfo"}},"required":["customerInternalId","debtor","debtorIBAN"]},"AutoPaymentConfiguration":{"type":"object","properties":{"thresholdInCents":{"type":"integer","format":"int64","description":"Maximum allowed that will be allowed to withdraw. Default value is 20000","example":20000},"executionType":{"type":"string","description":"When should the automatic payment be executed","enum":["IMMEDIATE","ONE_WEEK_BEFORE_DUE_DATE","DUE_DATE"],"example":"IMMEDIATE"},"periodicity":{"type":"string","description":"Periodicity of the automatic payment","enum":["MONTH","TRIMESTER","SEMESTER","YEAR"],"example":"MONTH"}}},"CompanySDDConfiguration":{"type":"object","properties":{"configuration":{"$ref":"#/components/schemas/AutoPaymentConfiguration","description":"Autopayment configuration that will defines the parameters of the SDD mandate. Here are the default parameters if no configuration was provided: Monthly, payment on request date, maximum 1000€."},"creditorVatNumber":{"type":"string","description":"VAT number of the SDD mandate holder (the creditor). The creditor must have an active Digiteal account with at least the START pack.","example":"BE0000000097"},"creditorIdentificationNumber":{"type":"string","description":"The national identification number of the Creditor. The creditorVatNumber or the creditorIdentificationNumber needs to be filled in  (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"creationDate":{"type":"string","description":"The date when the original SDD mandate was created. The expected format is YYYY-MM-DD","example":"2012-12-31"},"debtorIBAN":{"type":"string","description":"The IBAN from which the SDD mandate will be withdrawing money (aka debtor IBAN).","example":"BE40251230861709"},"customerInternalId":{"type":"string","description":"Identifier of the customer as defined by the creditor","example":"TEST12345"},"contractApproval":{"$ref":"#/components/schemas/ContractApproval","description":"Customer contract approval that defines when and how the customer approved the terms and conditions of Digiteal (see <a href='#operation--api-v1-kyc-contractsForCompany-get'>getCompanyContracts</a> to get the terms and conditions)."},"notificationSettings":{"$ref":"#/components/schemas/CustomerNotificationSettings","description":"Notification settings for this customer (these will be used only if this is a new user of Digiteal)"},"welcomeMessage":{"type":"string","description":"Specific welcome message that will be sent by email. Please be careful to send a message in the language of the customer.","example":"We inform you that your SEPA mandate for YourTelecom is transferred to Digiteal, a Belgian company that is a partner of Belfius."},"returnURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when the customer has set his password. Maximum length of 255 characters.","example":"https://www.myportal.com/digitealRegistrationConfirmed"},"product":{"type":"string","description":"Product for which this pre-registration is initiated. Default is INVOICING.","enum":["INVOICING","PAYMENT","DIGITRUST","PEPPOL","TERMS_TECH","ZOFINANCIALS"],"example":"INVOICING"},"complete":{"type":"boolean","description":"Defines if the SDD configuration contains enough data to be evaluated by Digiteal's compliance dept. Default value is true.","example":true},"transferID":{"type":"string","format":"uuid","description":"The unique identifier of the digitrust if this SDD is set up for digitrust pay-ins","example":"e529f8b4790f11e7b5a5be2e44b06b52"},"debtor":{"$ref":"#/components/schemas/CompanyKYCInfo","description":"SDD mandate client (the debtor)"}},"required":["customerInternalId","debtor","debtorIBAN"]},"RefundRequest":{"type":"object","description":"The details of the refund to be executed. The payment to refund must have been transferred to the creditor in order to be refunded.","properties":{"amountInCents":{"type":"integer","format":"int64","description":"Amount expressed in cents to be refunded.","example":1234,"minimum":1},"currency":{"type":"string","description":"The currency of the amount to be refunded based on the ISO 4217-alpha standard. The default value is EUR","example":"EUR"},"paymentUUID":{"type":"string","format":"uuid","description":"Uuid of the payment to refund.","example":"e529f8b4790f11e7b5a5be2e44b06b52"}},"required":["amountInCents","paymentUUID"]},"PeppolResult":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"}},"required":["status"]},"PeppolAddSupportedDocumentTypeErrorCode":{"type":"object","properties":{"status":{"type":"string","description":"Error code","enum":["PARTICIPANT_NOT_REGISTERED","DOCUMENT_TYPE_ALREADY_PRESENT","PARTICIPANT_LIMITED_TO_OUTBOUND_TRAFFIC"]},"message":{"type":"string","description":"Error message"}},"required":["message","status"]},"PeppolRemoveSupportedDocumentTypeErrorCode":{"type":"object","properties":{"status":{"type":"string","description":"Error code","enum":["PARTICIPANT_NOT_REGISTERED","DOCUMENT_TYPE_NOT_PRESENT"]},"message":{"type":"string","description":"Error message"}},"required":["message","status"]},"PeppolParticipantRegistrationRequest":{"type":"object","properties":{"peppolIdentifier":{"type":"string","description":"PEPPOL identifier","example":"0208:0630675588"},"contactPerson":{"$ref":"#/components/schemas/PeppolParticipantContactPersonResource","description":"Contact information to add in the PEPPOL directory and used by Digiteal access point as a point of contact"},"limitedToOutboundTraffic":{"type":"boolean","default":false,"description":"Register the participant for outbound traffic only"},"name":{"type":"string","description":"Name of the participant. Required for the PEPPOL directory registration.","example":"MyCompany"},"countryCode":{"type":"string","format":"iso-3166-2","description":"Country code of the participant. Required for the PEPPOL directory registration.","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW","ZZ"],"example":"BE"},"website":{"type":"string","format":"url","description":"URL of the participant's website","example":"https://www.mycompany.com"},"additionalInfo":{"type":"string","description":"Additional information about the participant","example":"Please embed the PDF in the UBL document"},"supportedDocumentTypes":{"type":"array","items":{"type":"string","description":"A document type","enum":["INVOICE","CREDIT_NOTE","SELF_BILLING_INVOICE","SELF_BILLING_CREDIT_NOTE","INVOICE_RESPONSE","MLR"],"example":"INVOICE"}}},"required":["contactPerson","countryCode","name","peppolIdentifier"]},"PeppolRegisterParticipantErrorCode":{"type":"object","properties":{"status":{"type":"string","description":"Error code","enum":["ALREADY_REGISTERED_TO_DIGITEAL","ALREADY_REGISTERED_TO_OTHER_AP"]},"message":{"type":"string","description":"Error message"}},"required":["message","status"]},"PeppolDocumentReceivedCallback":{"type":"object","properties":{"integratorVAT":{"type":"string","deprecated":true,"description":"The VAT number of the integrator","example":"BE0000000097"},"recipientPeppolIdentifier":{"type":"string","description":"PEPPOL identifier of the participant","example":"9956:0630675588"},"peppolFileContent":{"type":"string","format":"Base64","description":"Document content"},"changeType":{"type":"string","description":"Callback type","enum":["INVOICE_RECEIVED","CREDIT_NOTE_RECEIVED"],"example":"INVOICE_RECEIVED"},"executionTimestamp":{"type":"string","format":"date-time","description":"Callback execution timestamp","example":"2019-05-31 17:23:45","pattern":"yyyy-MM-dd HH:mm:ss"}},"required":["changeType","executionTimestamp","peppolFileContent","recipientPeppolIdentifier"]},"PeppolDocumentValidationResponse":{"type":"object","properties":{"type":{"type":"string","description":"Document type name","example":"INVOICE"},"fullType":{"type":"string","description":"Document type identifiers","example":"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:www.cenbii.eu:transaction:biitrns010:ver2.0:extended:urn:www.peppol.eu:bis:peppol4a:ver2.0::2.1"},"currentSpecValidationResult":{"$ref":"#/components/schemas/ValidationResultResponse","description":"Result of the validation with the current version of the spec"},"futureSpecValidationResult":{"$ref":"#/components/schemas/ValidationResultResponse","description":"Result of the validation with the future version of the spec (if any)"}},"required":["currentSpecValidationResult","fullType","type"]},"PeppolDocumentValidationErrorCode":{"type":"object","properties":{"status":{"type":"string","description":"Error code","enum":["NOT_AVAILABLE_IN_PROD","UNRECOGNIZED_DOCUMENT_TYPE","VALIDATION_FAILURE"]},"message":{"type":"string","description":"Error message"}},"required":["message","status"]},"PeppolSendDocumentErrorCode":{"type":"object","properties":{"status":{"type":"string","description":"Error code","enum":["INVALID_DOCUMENT","RECIPIENT_NOT_IN_PEPPOL","RECIPIENT_SMP_UNAVAILABLE","RECIPIENT_AP_UNAVAILABLE"]},"message":{"type":"string","description":"Error message"}},"required":["message","status"]},"PeppolFailedDependencyErrorCode":{"type":"object","properties":{"status":{"type":"string","description":"Error code","enum":["REMOTE_AP_UNAVAILABLE, RECIPIENT_SMP_UNAVAILABLE"]},"message":{"type":"string","description":"Error message"}},"required":["message","status"]},"PeppolDocumentAckCallback":{"type":"object","properties":{"integratorVAT":{"type":"string","deprecated":true,"description":"The VAT number of the integrator","example":"BE0000000097"},"recipientPeppolIdentifier":{"type":"string","description":"PEPPOL identifier of the participant","example":"9956:0630675588"},"peppolFileContent":{"type":"string","format":"Base64","description":"Document content"},"changeType":{"type":"string","description":"Callback type","enum":["TRANSPORT_ACK_RECEIVED","INVOICE_RESPONSE_RECEIVED"],"example":"TRANSPORT_ACK_RECEIVED"},"executionTimestamp":{"type":"string","format":"date-time","description":"Callback execution timestamp","example":"2019-05-31 17:23:45","pattern":"yyyy-MM-dd HH:mm:ss"}},"required":["changeType","executionTimestamp","peppolFileContent","recipientPeppolIdentifier"]},"PeppolValidationCallback":{"type":"object","properties":{"integratorVAT":{"type":"string","deprecated":true,"description":"The VAT number of the integrator","example":"BE0000000097"},"recipientPeppolIdentifier":{"type":"string","description":"PEPPOL identifier of the participant","example":"9956:0630675588"},"peppolFileContent":{"type":"string","format":"Base64","description":"Document content"},"changeType":{"type":"string","description":"Callback type","enum":["FUTURE_VALIDATION_FAILED"],"example":"FUTURE_VALIDATION_FAILED"},"validationError":{"type":"string","description":"Validation error message"},"executionTimestamp":{"type":"string","format":"date-time","description":"Callback execution timestamp","example":"2019-05-31 17:23:45","pattern":"yyyy-MM-dd HH:mm:ss"}},"required":["changeType","executionTimestamp","peppolFileContent","recipientPeppolIdentifier","validationError"]},"PeppolDocumentOutcomeCallback":{"type":"object","properties":{"operationId":{"type":"string","description":"Outcome Operation ID"},"documentId":{"type":"string","description":"Outcome Document ID"},"status":{"$ref":"#/components/schemas/Code","description":"Outcome Status","enum":["RECIPIENT_NOT_IN_PEPPOL","PARTICIPANT_NOT_REGISTERED_TO_CALLER","FAILED_TO_PRODUCE_SBDH","DUPLICATED_DOCUMENT","TECHNICAL_ERROR","OK"],"example":"OK"},"message":{"type":"string","description":"Outcome message"},"executionTimestamp":{"type":"string","format":"date-time","description":"Callback execution timestamp","example":"2019-05-31 17:23:45","pattern":"yyyy-MM-dd HH:mm:ss"}},"required":["executionTimestamp","operationId","status"]},"MercuriusSendDocumentErrorCode":{"type":"object","properties":{"status":{"type":"string","description":"Error code","enum":["INVALID_DOCUMENT","NOT_REGISTERED_TO_CALLER"]},"message":{"type":"string","description":"Error message"}},"required":["message","status"]},"MercuriusParticipantRegistrationRequest":{"type":"object","properties":{"peppolIdentifier":{"type":"string","description":"PEPPOL identifier","example":"0208:0630675588"}},"required":["peppolIdentifier"]},"MercuriusRegisterParticipantErrorCode":{"type":"object","properties":{"status":{"type":"string","deprecated":true,"description":"Replaced by code"},"code":{"type":"string","description":"Error code","enum":["ALREADY_REGISTERED_TO_DIGITEAL"]},"message":{"type":"string","description":"Error message"}},"required":["code","message"]},"TransferRefundRequest":{"type":"object","description":"The details of the transfer payment to be refunded.","properties":{"communication":{"type":"string","description":"Communication of the refund payment","example":"Refund from payment {transfer payment subject} of {date} to {transfer payment creator}"},"contributions":{"type":"array","description":"Specific contributions of each creditor","items":{"$ref":"#/components/schemas/MarketplaceContributionRefund"}}}},"TransferOfFundsCallbackV2":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment","description":"Payment details"},"paymentRequest":{"$ref":"#/components/schemas/PaymentRequest","description":"Payment request details"},"invoice":{"$ref":"#/components/schemas/Invoice","description":"Invoice details"},"transfer":{"$ref":"#/components/schemas/Transfer","description":"Transfer details"},"terminal":{"$ref":"#/components/schemas/Terminal","description":"Terminal details"},"executionTimestamp":{"type":"string","format":"date-time","description":"Callback execution timestamp","example":"2019-05-31 17:23:45","pattern":"yyyy-MM-dd HH:mm:ss"},"errorCode":{"type":"string","description":"Callback error code\nSet only if the callback status is error","example":"CODE"},"errorMessage":{"type":"string","description":"Callback error message\nSet only if the callback status is error","example":"error message"}},"required":["executionTimestamp","payment"]},"TransferOfFundsCallback":{"type":"object","properties":{"paymentStatus":{"type":"string","description":"The status of the payment","enum":["INITIATED","INITIATION_ERROR","WITHDRAWAL_ERROR","WITHDRAWAL_SUCCESS","REIMBURSMENT_FROM_DIGITEAL","REIMBURSMENT_FROM_REQUESTOR","REIMBURSEMENT_RECEIVED_FROM_CREDITOR","TRANSFERRED","TRANSFER_PAYMENT_RECEIVED","TRANSFER_PAYMENT_STARTED","TRANSFER_PAYMENT_COMPLETED","TRANSFER_REIMBURSEMENT_STARTED","TRANSFER_REIMBURSEMENT_COMPLETED","BULK_PAYOUT","FUNDS_RECEIVED_IN_BUFFER"],"example":"INITIATED"},"paymentRequestInformation":{"$ref":"#/components/schemas/PaymentRequestInformation","description":"Represents the basic invoice information"},"executionTimestamp":{"type":"string","description":"The execution timestamp of the notification (format yyyy-MM-dd HH:mm:ss)","example":"2019-05-31 17:23:45"},"originFirstName":{"type":"string","description":"The first name of the ultimate debtor or its contact person (if it is a company)","example":"John"},"originLastName":{"type":"string","description":"The last name of the ultimate debtor or its contact person (if it is a company)","example":"Doe"},"originCompanyName":{"type":"string","description":"The name of the ultimate debtor company (if it is a company)","example":"MyCompany"},"originVATNumber":{"type":"string","description":"The VAT number of the ultimate debtor (if it is a company)","example":"BE0000000196"},"originBankAccount":{"type":"string","description":"The bank account of the ultimate debtor","example":"BE41816373160590"},"targetBankAccount":{"type":"string","description":"The bank account of the ultimate creditor","example":"BE17999000004821"},"paymentMethod":{"type":"string","description":"Possible values are STANDARD, DIRECT, BANCONTACT, IDEAL, VISA, MASTERCARD, CARTE_BLEUE","enum":["BANCONTACT","CARTE_BLEUE","IDEAL","INTERNAL","MAESTRO","MASTERCARD","PAYCONIQ","SCT","STANDARD","VISA","GOOGLE_PAY","PIS_STANDARD","PIS_PREMIUM","PIS_PREMIUM_INSTANT","APPLE_PAY"],"example":"VISA"},"bankTransactionID":{"type":"string","description":"The unique identifier of the payment known by the requester","example":"e529f8b4790f11e7b5a5be2e44b06b52"},"parentBankTransactionID":{"type":"string","description":"The unique identifier of the payment known by the requester","example":"b229f8b4790f11e7b5a5be2e44b06b55"},"transferID":{"type":"string","description":"The unique identifier of the trusted transfer known by the requester","example":"f529f8b4790f11e7b5a5be2e44b06b53"},"transferReference":{"type":"string","description":"Custom reference of the transfer","example":"CustomReference"},"invoiceUUID":{"type":"string","description":"UUID of the invoice","example":"a529f8b4790f11e7b5a5be2e44b06b54"},"errorCode":{"type":"string","description":"Error code indication","example":"SOME_CODE"},"errorMessage":{"type":"string","description":"Detailed error message","example":"An error message"}},"required":["executionTimestamp","originBankAccount","originFirstName","originLastName","paymentMethod","paymentRequestInformation","paymentStatus"]},"PaymentCreationRequest":{"type":"object","description":"Payment request data with mandatory confirmationURL and errorURL","properties":{"creationDate":{"type":"string","format":"date","description":"The date the bill was emitted. The default value is today. The expected format is YYYY-MM-DD","example":"2019-12-31"},"language":{"type":"string","description":"The language of the client (NL, FR or EN)","example":"EN"},"secondaryLanguage":{"type":"string","description":"A secondary language of the client","example":"NL"},"currency":{"type":"string","description":"The currency of the amount to be paid based on the ISO 4217-alpha standard. The default value is EUR","example":"EUR"},"purpose":{"type":"string","description":"The purpose based on the ISO 20022 standard","example":"GDDS"},"creditorReference":{"type":"string","description":"The structured reference used by the biller to reconcile the payment. This is also called the structured communication in Belgium. Both BBA (Belgium) and ISO (International) types are supported. It can be left empty if the remittanceInfo is defined","example":"000600232562"},"remittanceInfo":{"type":"string","description":"An unstructured string that is used as communication in the payment. This information is only used if there is no creditorReference. It can be left empty if the creditorReference is defined","example":"Invoice 1","maxLength":140,"minLength":0},"customerFirstName":{"type":"string","description":"Client first name","example":"Jean","maxLength":255,"minLength":0},"customerLastName":{"type":"string","description":"Client last name","example":"Dujardin","maxLength":255,"minLength":0},"customerVAT":{"type":"string","description":"Client VAT number (if applicable) with the country code","example":"BE0000000097"},"customerEmail":{"type":"string","description":"email address. This is important to provide so that we can match this customer to the DigiTeal registered users.","example":"john.doe@me.com","maxLength":255,"minLength":0},"customerMobile":{"type":"string","description":"the mobile phone of the customer with the national prefix","example":"+32123456789","maxLength":255,"minLength":0},"customerAddressStreet":{"type":"string","description":"street name of the client address","example":"Rue de la Paix","maxLength":250,"minLength":0},"customerAddressNumber":{"type":"string","description":"street number","example":14,"maxLength":250,"minLength":0},"customerAddressZip":{"type":"string","description":"Zipcode","example":1000,"maxLength":20,"minLength":0},"customerAddressCity":{"type":"string","description":"City","example":"Bruxelles","maxLength":250,"minLength":0},"customerAddressCountry":{"type":"string","description":"Country (ISO 3166-1 alpha-2)","example":"BE","maxLength":250,"minLength":0},"iban":{"type":"string","description":"IBAN number, if you have registered multiple IBAN numbers on your account then this field is required!","example":"BE40251230861709"},"bic":{"type":"string","description":"BIC number","example":"GKCCBEBB"},"requesterID":{"type":"integer","format":"int64","description":"The id of the Requester. The requesterID, the requesterVAT, the requesterIdentificationNumber or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication","example":1234},"requesterVAT":{"type":"string","description":"The VAT number of the Requester. The requesterID, the requesterVAT, the requesterIdentificationNumber or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication","example":"BE0000000196"},"requesterIdentificationNumber":{"type":"string","description":"The national identification number of the Requester. The requesterID, the requesterVAT, the requesterIdentificationNumber or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"requesterEmail":{"type":"string","description":"The email of the requester. The requesterID, the requesterVAT, the requesterIdentificationNumber or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication","example":"requestor@company.com","maxLength":255,"minLength":0},"expectingDocumentAttached":{"type":"boolean","description":"True if documents should be attached to this invoice, false if no document should be attached. Default is true.","example":true},"amountInCents":{"type":"string","description":"amount expressed in cents that has to be paid","example":1234},"minAmountInCents":{"type":"integer","format":"int64","description":"The minimum amount to pay (in cents, cannot be used at the same time as amountInCents)","example":500},"maxAmountInCents":{"type":"integer","format":"int64","description":"The maximum amount to pay (in cents, cannot be used at the same time as amountInCents)","example":50000},"suggestedAmountInCents":{"type":"integer","format":"int64","description":"The suggested amount to pay (in cents, cannot be used at the same time as amountInCents)","example":50000},"validityInMinutes":{"type":"integer","format":"int32","description":"Defines the validity of the payment request in minutes. Default value 10min","example":10},"customerInternalId":{"type":"string","description":"The id used by the requester his internal billing system. This is mandatory when creating an invoice","example":"TEST12345","maxLength":255,"minLength":0},"multiple":{"type":"boolean","description":"True if you want to accept multiple payments with this description. Default value is false.","example":false},"confirmationURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when the payment has been completed successfully (mandatory in case of interactive payment). Maximum length of 255 characters.","example":"https://api.myservice.com/paymentConfirmed"},"errorURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when the payment has not been completed successfully (mandatory in case of interactive payment). Maximum length of 255 characters.","example":"https://api.myservice.com/paymentError"},"cancelURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when the payment is cancelled (reverts to errorURL if it is not present). Maximum length of 255 characters.","example":"https://api.myservice.com/paymentCancelled"},"paymentInternalId":{"type":"string","description":"The internal identifier of the payment as known by the creditor. Max length of 255"},"paymentMethod":{"type":"string","description":"The payment method that is to be used. If it is defined, only that payment method will be available. If left empty, all the payment methods supported by the creditor will be available to the user.","enum":["DIGITEAL_STANDARD","PIS_STANDARD","BANCONTACT","IDEAL","VISA","MASTERCARD","CARTE_BLEUE","MAESTRO","PAYCONIQ"],"example":"BANCONTACT","pattern":"(DIGITEAL_STANDARD)|(PIS_STANDARD)|(BANCONTACT)|(IDEAL)|(VISA)|(MASTERCARD)|(CARTE_BLEUE)|(MAESTRO)|(PAYCONIQ)"},"allowedPaymentMethods":{"type":"string","description":"A list of comma separated values of payment method that we want to only allow for a specific payment","example":"VISA,MASTERCARD,BANCONTACT"},"qrCode":{"type":"boolean","description":"If true, the QR code (for Bancontact payment method), will be displayed for example to enable the payment by a third party and not the user.","example":false},"mobile":{"type":"boolean","description":"True if this is a payment to be executed on a mobile device. False by default","example":true},"emailOptin":{"type":"boolean","description":"Triggers the email optin retrieval in the payment flow.","example":true},"expiryDateTime":{"type":"string","description":"The exact instant the payment is due.","example":"2025-11-14T10:30:00.123Z"},"feeInCents":{"type":"string","description":"The applied fees expressed in cents.","example":250},"feeDescription":{"type":"string","description":"A description for the applied fee.","example":"Fine for late payment."},"paymentRequestUUID":{"type":"string","format":"uuid","description":"The internal identifier of the SinglePaymentRequest, associated to the payment as known by the creditor.","example":"550e8400-e29b-41d4-a716-446655440000","maxLength":255}},"required":["amountInCents","confirmationURL","customerInternalId","errorURL"]},"TrustedPaymentRequest":{"type":"object","description":"contains the trusted payment information","properties":{"amountInCents":{"type":"integer","format":"int64","description":"Amount expressed in cents that has to be paid. If this is not provided for a confirmation-based trusted payment, the total amount of the trusted payment will be requested.","example":1234},"creditorReference":{"type":"string","description":"Creditor reference of the trusted payment as determined by Digiteal. This will not be used if the transferId(s) is/are provided.","example":"RF84U6"},"creditorReferences":{"type":"array","description":"Creditor references of the trusted payment as determined by Digiteal. This will not be used if the transferId(s) is/are provided.","items":{"type":"string"}},"confirmationURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when the payment has been completed successfully. Maximum length of 255 characters.","example":"https://api.myservice.com/paymentConfirmed"},"errorURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when an error occurred during the payment. Maximum length of 255 characters.","example":"https://api.myservice.com/paymentError"},"cancelURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when the payment was cancelled. If not present, it will revert to the errorURL. Maximum length of 255 characters.","example":"https://api.myservice.com/paymentCancelled"},"transferId":{"type":"string","format":"uuid","description":"Uuid of the trusted payment as determined by Digiteal. If this value is used the creditor reference(s) are ignored.","example":"e529f8b4790f11e7b5a5be2e44b06b52"},"transferIds":{"type":"array","description":"Uuids of the trusted payment as determined by Digiteal. If this value is used the creditor reference(s) and transferId are ignored.","items":{"type":"string","format":"uuid"}},"contributions":{"type":"array","description":"Contributions to the trusted payments as determined. If this value is used the creditor reference(s), transferId and transferIds are ignored. Available since 1.42.","items":{"$ref":"#/components/schemas/TrustedPaymentContribution"}},"language":{"type":"string","description":"The language of the client (NL, FR or EN)","example":"EN"}}},"SctPaymentRequestInput":{"type":"object","description":"Input used to create an SCT payment","properties":{"debtorIban":{"type":"string","description":"Represents the debtor's iban. It must be a valid IBAN","example":"BE81429126789924"},"creditorIban":{"type":"string","description":"Represents the creditor's iban. It must be a valid IBAN","example":"BE81429126789924"},"amountInCents":{"type":"integer","format":"int64","description":"Represents amount of the payment. The value is in cents and it must be positive","example":100},"creditorReference":{"type":"string","description":"The structured reference used to reconcile the payment. This is also called the structured communication in Belgium. Both BBA (Belgium) and ISO (International) types are supported. It can be left empty if the remittanceInfo is defined","example":"000600232562"},"remittanceInfo":{"type":"string","description":"An unstructured string that is used as communication in the payment. This information is only used if there is no creditorReference. It can be left empty if the creditorReference is defined","example":"Invoice 1"},"executionDate":{"type":"string","description":"Represents the date when the payment should be executed. It must use the ISO format and can not be in the past. By default, the payment will be executed ASAP.","example":"2021-12-20"}},"required":["amountInCents","creditorIban","debtorIban"]},"SctPaymentRequestResponse":{"type":"object","properties":{"status":{"type":"string","enum":["EXECUTED","PLANNED"]},"paymentID":{"type":"string","format":"uuid","description":"Represents the payment's ID","example":"b0aecc22-05b9-11ec-9a03-0242ac130003"}},"required":["paymentID","status"]},"InvoicePaymentRequest":{"type":"object","description":"contains the requesterID and the internal id of the invoice","properties":{"invoiceInternalId":{"type":"string","description":"The internal identifier of the invoice as know by the issuer.","example":"Bill1234"},"requesterID":{"type":"string","description":"The id of the Requester. Needs to be filled in if the payment is generated through another provider","example":12},"confirmationURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when the payment has been completed successfully. Maximum length of 255 characters.","example":"https://api.myservice.com/paymentConfirmed"},"errorURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when an error occurred during the payment. Maximum length of 255 characters.","example":"https://api.myservice.com/paymentError"},"cancelURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when the payment was cancelled. If not present, it will revert to the errorURL. Maximum length of 255 characters.","example":"https://api.myservice.com/paymentCancelled"},"uuid":{"type":"string","description":"Uuid of the invoice as determined by Digiteal. If this value is used the invoiceInternalId are ignored.","example":"e529f8b4790f11e7b5a5be2e44b06b52"},"language":{"type":"string","description":"The language of the client (NL, FR or EN)","example":"EN"}},"required":["confirmationURL","errorURL"]},"PaymentCardTokenReserveFundsRequest":{"type":"object","properties":{"mit":{"type":"boolean","default":false,"description":"Enable [MIT](https://digiteal.readme.io/docs/card-token#mit)","example":true},"notificationUrl":{"type":"string","format":"url","description":"Url used to notify the reservation result","example":"https://notification.com","maxLength":255,"minLength":0},"requestId":{"type":"string","description":"Identification used for your reference","example":"customReference","maxLength":255,"minLength":0},"customer":{"$ref":"#/components/schemas/PaymentCardTokenCustomer"},"companyIdentificationNumber":{"type":"string","description":"Creditor of the transaction\nThe company must be registered on Digiteal and linked to your integrator account\n[Format](https://docs.digiteal.eu/technical/index.html#company_national_identifiers)","example":"BE:VAT:BE0000000097"},"token":{"type":"string","description":"PKey generated by a Token Service Provider or Permanent token generated by Digiteal","example":"55976a05f40c4b26b867f7d5a20f0319","maxLength":255,"minLength":0},"amountInCents":{"type":"string","description":"Amount to be reserved on the card","example":100,"minimum":0},"transferId":{"type":"string","description":"Link the transaction to a [transfer](https://digiteal.readme.io/docs/card-token#transfer)","example":"8081e5f6-2c29-4e5e-8d22-42a4321e3101"},"3dsConfig":{"$ref":"#/components/schemas/Config3ds"}},"required":["amountInCents","companyIdentificationNumber","token"]},"PaymentCardTokenReserveFundsResponse":{"type":"object","properties":{"successful":{"type":"boolean","description":"Successful if the funds are available and can be reserved on the card","example":true},"reservationId":{"type":"string","description":"Identification of the reservation\nSet only if the operation is successful","example":"33cf7421074548039f0eb3bca927a89a"},"errorCode":{"type":"string","description":"Reason code for the operation failure\nSet only if the operation is not successful","example":"02"},"errorMessage":{"type":"string","description":"Reason message for the operation failure\nSet only if the operation is not successful","example":"the operation failed"},"card":{"$ref":"#/components/schemas/PaymentCard","description":"Non sensitive card information\nSet only if the operation is successful"},"3dsRedirectUrl":{"type":"string","format":"uri","description":"Redirect URL to the 3DS challenge web page\nSet only if a challenge is requested by the acquirer","example":"https://redirecturl.com"}},"required":["successful"]},"PaymentCardTokenReserveFundsErrorCode":{"type":"object","properties":{"code":{"type":"string","description":"Error code","enum":["COMPANY_NOT_FOUND","INVALID_TOKEN","CUSTOMER_NAME_REQUIRED","CARD_SCHEME_NOT_SUPPORTED","INVALID_CVV","MIT_NOT_ACCEPTED","MISSING_WEBHOOK"]},"message":{"type":"string","description":"Error message"}},"required":["code","message"]},"PaymentCardTokenReservationCallback":{"type":"object","properties":{"successful":{"type":"boolean","description":"Successful if the funds are available and can be reserved on the card","example":true},"reservationId":{"type":"string","description":"Identification of the reservation\nSet only if the operation is successful","example":"33cf7421074548039f0eb3bca927a89a"},"errorCode":{"type":"string","description":"Reason code for the operation failure\nSet only if the operation is not successful","example":"02"},"errorMessage":{"type":"string","description":"Reason message for the operation failure\nSet only if the operation is not successful","example":"the operation failed"},"card":{"$ref":"#/components/schemas/PaymentCard","description":"Non sensitive card information\nSet only if the operation is successful"},"requestId":{"type":"string","description":"Identification used for your reference","example":"customReference","maxLength":255,"minLength":0}},"required":["successful"]},"PaymentCardTokenCreationRequest":{"type":"object","properties":{"companyIdentificationNumber":{"type":"string","description":"The creditor of the transaction\nThe company must be registered on Digiteal and linked to your integrator account\n[Format](https://docs.digiteal.eu/technical/index.html#company_national_identifiers)","example":"BE:VAT:BE0000000097"},"tokenProviderKey":{"type":"string","description":"PKey generated by a Token Service Provider","example":"8384fb5366e74679b91a712dc04ec6d4","maxLength":255,"minLength":0},"forceValidation":{"type":"boolean","default":false,"description":"[Force the validation of the cardholder identity](https://digiteal.readme.io/docs/card-token#force-validation)","example":true},"notificationUrl":{"type":"string","format":"url","description":"Url used to notify the token creation result","example":"https://notification.com","maxLength":255,"minLength":0},"requestId":{"type":"string","description":"Identification used for your reference","example":"customReference","maxLength":255,"minLength":0},"customer":{"$ref":"#/components/schemas/PaymentCardTokenCustomer"},"3dsConfig":{"$ref":"#/components/schemas/Config3dsToken"}},"required":["companyIdentificationNumber","tokenProviderKey"]},"PaymentCardTokenCreationResponse":{"type":"object","properties":{"successful":{"type":"boolean","description":"Successful if a token is created","example":true},"token":{"type":"string","description":"Permanent token\nSet only if the operation is successful","example":"55976a05f40c4b26b867f7d5a20f0319"},"card":{"$ref":"#/components/schemas/PaymentCard","description":"Non sensitive card information\nSet only if the operation is successful"},"errorCode":{"type":"string","description":"Reason code for the operation failure\nSet only if the operation is not successful","example":"02"},"errorMessage":{"type":"string","description":"Reason message for the operation failure\nSet only if the operation is not successful","example":"the operation failed"},"3dsRedirectUrl":{"type":"string","format":"uri","description":"Redirect URL to the 3DS challenge web page\nSet only if a challenge is requested by the acquirer","example":"https://redirecturl.com"}},"required":["successful"]},"PaymentCardTokenCreationErrorCode":{"type":"object","properties":{"code":{"type":"string","description":"Error code","enum":["COMPANY_NOT_FOUND","INVALID_TOKEN_PROVIDER_KEY","CARD_SCHEME_NOT_SUPPORTED","CUSTOMER_NAME_REQUIRED","INVALID_CVV","MISSING_WEBHOOK"]},"message":{"type":"string","description":"Error message"}},"required":["code","message"]},"PaymentCardTokenCreationCallback":{"type":"object","properties":{"customerInternalId":{"type":"string","deprecated":true},"successful":{"type":"boolean","description":"Successful if a token is created","example":true},"token":{"type":"string","description":"Permanent token\nSet only if the operation is successful","example":"55976a05f40c4b26b867f7d5a20f0319"},"card":{"$ref":"#/components/schemas/PaymentCard","description":"Non sensitive card information\nSet only if the operation is successful"},"errorCode":{"type":"string","description":"Reason code for the operation failure\nSet only if the operation is not successful","example":"02"},"errorMessage":{"type":"string","description":"Reason message for the operation failure\nSet only if the operation is not successful","example":"the operation failed"},"requestId":{"type":"string","description":"Identification used for your reference","example":"customReference","maxLength":255,"minLength":0}},"required":["successful"]},"PaymentCardTokenProcessPaymentRequest":{"type":"object","properties":{"companyIdentificationNumber":{"type":"string","description":"The creditor of the transaction\nThe company must be registered on Digiteal and linked to your integrator account\n[Format](https://docs.digiteal.eu/technical/index.html#company_national_identifiers)","example":"BE:VAT:BE0000000097"},"reservationId":{"type":"string","description":"Identification of the reservation to use","example":"33cf7421074548039f0eb3bca927a89a"},"amountInCents":{"type":"string","description":"Amount to be charged on the reserved funds","example":100,"minimum":0},"creditorReference":{"type":"string","description":"Structured communication","example":"000600232562"},"remittanceInfo":{"type":"string","description":"Unstructured communication\nOnly used if the creditorReference is null","example":"Unstructured communication"}},"required":["amountInCents","companyIdentificationNumber","reservationId"]},"PaymentCardTokenProcessPaymentResponse":{"type":"object","properties":{"successful":{"type":"boolean","description":"Successful if the funds are properly charged","example":true},"paymentId":{"type":"string","format":"uuid","description":"Identification of the payment\nSet only if the operation is successful","example":"ee20a124743240b49880-3be74335c07e"},"errorCode":{"type":"string","description":"Reason code for the operation failure\nSet only if the operation is not successful","example":"02"},"errorMessage":{"type":"string","description":"Reason message for the operation failure\nSet only if the operation is not successful","example":"the operation failed"}},"required":["successful"]},"PaymentCardTokenProcessPaymentErrorCode":{"type":"object","properties":{"code":{"type":"string","description":"Error code","enum":["COMPANY_NOT_FOUND","INVALID_TOKEN","INVALID_RESERVATION_ID","RESERVATION_ID_EXPIRED"]},"message":{"type":"string","description":"Error message"}},"required":["code","message"]},"PaymentInitiatedCallbackV2":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment","description":"Payment details"},"paymentRequest":{"$ref":"#/components/schemas/PaymentRequest","description":"Payment request details"},"invoice":{"$ref":"#/components/schemas/Invoice","description":"Invoice details"},"transfer":{"$ref":"#/components/schemas/Transfer","description":"Transfer details"},"terminal":{"$ref":"#/components/schemas/Terminal","description":"Terminal details"},"executionTimestamp":{"type":"string","format":"date-time","description":"Callback execution timestamp","example":"2019-05-31 17:23:45","pattern":"yyyy-MM-dd HH:mm:ss"},"errorCode":{"type":"string","description":"Callback error code\nSet only if the callback status is error","example":"CODE"},"errorMessage":{"type":"string","description":"Callback error message\nSet only if the callback status is error","example":"error message"},"code":{"type":"string","description":"Callback code","enum":["INITIATED","INITIATION_ERROR"],"example":"INITIATED"}},"required":["code","executionTimestamp","payment"]},"PaymentReceivedInTransitCallback":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment","description":"Payment details"},"paymentRequest":{"$ref":"#/components/schemas/PaymentRequest","description":"Payment request details"},"invoice":{"$ref":"#/components/schemas/Invoice","description":"Invoice details"},"transfer":{"$ref":"#/components/schemas/Transfer","description":"Transfer details"},"terminal":{"$ref":"#/components/schemas/Terminal","description":"Terminal details"},"executionTimestamp":{"type":"string","format":"date-time","description":"Callback execution timestamp","example":"2019-05-31 17:23:45","pattern":"yyyy-MM-dd HH:mm:ss"},"errorCode":{"type":"string","description":"Callback error code\nSet only if the callback status is error","example":"CODE"},"errorMessage":{"type":"string","description":"Callback error message\nSet only if the callback status is error","example":"error message"},"code":{"type":"string","description":"Callback code","enum":["RECEIVED_IN_TRANSIT"],"example":"RECEIVED_IN_TRANSIT"}},"required":["code","executionTimestamp","payment"]},"BulkPayoutCallbackV2":{"type":"object","properties":{"payouts":{"type":"array","description":"Payout entries","items":{"$ref":"#/components/schemas/BulkEntry"}},"executionTimestamp":{"type":"string","format":"date-time","description":"Callback execution timestamp","example":"2019-05-31 17:23:45","pattern":"yyyy-MM-dd HH:mm:ss"},"id":{"type":"string","format":"uuid","description":"Payout identifier","example":"e529f8b4790f11e7b5a5be2e44b06b52"},"code":{"type":"string","description":"Callback code","enum":["BULK_PAYOUT"],"example":"BULK_PAYOUT"}},"required":["code","executionTimestamp","payouts"]},"PaymentCardTokenCreationFromPsRequest":{"type":"object","properties":{"companyIdentificationNumber":{"type":"string","description":"The creditor of the transaction\nThe company must be registered on Digiteal and linked to your integrator account\n[Format](https://docs.digiteal.eu/technical/index.html#company_national_identifiers)","example":"BE:VAT:BE0000000097"},"paymentServiceToken":{"type":"string","description":"Temporary token generated by a Payment Service","example":"8384fb5366e74679b91a712dc04ec6d4"},"notificationUrl":{"type":"string","format":"url","description":"Url used to notify the token creation result","example":"https://notification.com","maxLength":255,"minLength":0},"customerInternalId":{"type":"string","description":"Identification used for your reference","example":"customReference","maxLength":255,"minLength":0}},"required":["companyIdentificationNumber","customerInternalId","notificationUrl","paymentServiceToken"]},"PaymentCardTokenCreationPsResponse":{"type":"object","properties":{"successful":{"type":"boolean","description":"Successful if a token is created","example":true},"token":{"type":"string","description":"Permanent token\nSet only if the operation is successful","example":"55976a05f40c4b26b867f7d5a20f0319"},"card":{"$ref":"#/components/schemas/PaymentCard","description":"Non sensitive card information\nSet only if the operation is successful"},"errorCode":{"type":"string","description":"Reason code for the operation failure\nSet only if the operation is not successful","example":"02"},"errorMessage":{"type":"string","description":"Reason message for the operation failure\nSet only if the operation is not successful","example":"the operation failed"}},"required":["successful"]},"PaymentCardTokenCreationPsErrorCode":{"type":"object","properties":{"code":{"type":"string","description":"Error code","enum":["COMPANY_NOT_FOUND"]},"message":{"type":"string","description":"Error message"}},"required":["code","message"]},"PaymentCardTokenCancelReservationRequest":{"type":"object","properties":{"companyIdentificationNumber":{"type":"string","description":"The creditor of the transaction\nThe company must be registered on Digiteal and linked to your integrator account\n[Format](https://docs.digiteal.eu/technical/index.html#company_national_identifiers)","example":"BE:VAT:BE0000000097"},"reservationId":{"type":"string","description":"Identification of the reservation to cancel","example":"33cf7421074548039f0eb3bca927a89a","maxLength":255,"minLength":0}},"required":["companyIdentificationNumber","reservationId"]},"PaymentCardTokenCancelReservationResponse":{"type":"object","properties":{"successful":{"type":"boolean","description":"Successful if the funds are properly released","example":true},"errorCode":{"type":"string","description":"Reason code for the operation failure\nSet only if the operation is not successful","example":"02"},"errorMessage":{"type":"string","description":"Reason message for the operation failure\nSet only if the operation is not successful","example":"the operation failed"}},"required":["successful"]},"PaymentCardTokenCancelReservationErrorCode":{"type":"object","properties":{"code":{"type":"string","description":"Error code","enum":["COMPANY_NOT_FOUND","INVALID_TOKEN","INVALID_RESERVATION_ID","RESERVATION_ID_EXPIRED","INVALID_TRANSFER_ID"]},"message":{"type":"string","description":"Error message"}},"required":["code","message"]},"MandateAuthorizationRequest":{"type":"object","properties":{"debtor":{"$ref":"#/components/schemas/Debtor","description":"Debtor's information"},"creditor":{"$ref":"#/components/schemas/Creditor","description":"Creditor's information"},"mandateNumber":{"type":"string","description":"Unique mandate number","example":1234,"maxLength":50,"minLength":0},"redirectUrls":{"$ref":"#/components/schemas/RedirectUrl","description":"Set of [urls used for redirection](https://digiteal.readme.io/docs/mandate-authorization#redirect-urls) after completing the request flow"},"notificationUrl":{"type":"string","format":"url","description":"Url used to notify the authorization result","example":"https://notification.com"},"requestId":{"type":"string","description":"Identification used for your reference","example":"customReference","maxLength":255,"minLength":0},"preselectedCountry":{"type":"string","format":"iso-3166-2","description":"Preselected country used to skip the country selection page","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW","ZZ"],"example":"BE"}},"required":["creditor","debtor","mandateNumber"]},"MandateAuthorizationResponse":{"type":"object","properties":{"redirectUrl":{"type":"string","format":"url"}},"required":["redirectUrl"]},"MandateAuthorizationRequestErrorCode":{"type":"object","properties":{"code":{"type":"string","description":"Error code","enum":["INVALID_MANDATE_KEY","MISSING_WEBHOOK"]},"message":{"type":"string","description":"Error message"}},"required":["code","message"]},"MandateAuthorizationCallback":{"type":"object","properties":{"sddCreditorIdentifier":{"type":"string","description":"Creditor's SDD identifier","example":"BE53ZZZ0630675588","maxLength":255,"minLength":0},"mandateNumber":{"type":"string","description":"Unique mandate number","example":1234,"maxLength":50,"minLength":0},"status":{"type":"string","description":"Mandate authorization status","enum":["SUCCESS","CANCEL","ERROR","FAIL"],"example":"SUCCESS"},"timestamp":{"type":"string","format":"date-time","description":"Callback timestamp","example":"2007-12-03T10:15:30","pattern":"yyyy-MM-dd'T'HH:mm:ss"},"requestId":{"type":"string","description":"Identification used for your reference","example":"customReference","maxLength":255,"minLength":0},"iban":{"type":"string","format":"IBAN","description":"Collected debtor's IBAN","example":"BE40251230861709"},"code":{"type":"string","description":"Mandate authorization status code","enum":["MANDATE_CONSENT","AIS_CONSENT","BANK_ENV","INVALID_IBAN","TIMEOUT","SECURITY_REASON"],"example":"INVALID_IBAN"},"accountOwnerName":{"type":"string","description":"Account owner name"}},"required":["mandateNumber","sddCreditorIdentifier","status","timestamp"]},"TerminalKYCInfo":{"type":"object","properties":{"companyIdentifier":{"type":"string","minLength":1},"terminals":{"type":"array","description":"Terminal info","items":{"$ref":"#/components/schemas/TerminalInfo"}}},"required":["companyIdentifier"]},"PersonCustomerKYCInfo":{"type":"object","description":"Customer person KYC details","properties":{"customerInfo":{"$ref":"#/components/schemas/CustomerInfo","description":"Information about the customer"},"customerPerson":{"$ref":"#/components/schemas/PersonKYCInfo","description":"Customer person KYC information"},"contractApproval":{"$ref":"#/components/schemas/ContractApproval","description":"Customer contrat approval"}},"required":["customerInfo","customerPerson"]},"CompanyCustomerKYCInfo":{"type":"object","description":"Customer company KYB details","properties":{"customerInfo":{"$ref":"#/components/schemas/CustomerInfo","description":"Information about the customer"},"customerCompany":{"$ref":"#/components/schemas/CompanyKYCInfo","description":"Customer company KYC information"},"contractApproval":{"$ref":"#/components/schemas/ContractApproval","description":"Customer contract approval"}},"required":["customerCompany","customerInfo"]},"InvoiceCreationRequest":{"type":"object","properties":{"creationDate":{"type":"string","format":"date","description":"The date the bill was emitted. The default value is today. The expected format is YYYY-MM-DD","example":"2019-12-31"},"language":{"type":"string","description":"The language of the client (NL, FR or EN)","example":"EN"},"secondaryLanguage":{"type":"string","description":"A secondary language of the client","example":"NL"},"currency":{"type":"string","description":"The currency of the amount to be paid based on the ISO 4217-alpha standard. The default value is EUR","example":"EUR"},"purpose":{"type":"string","description":"The purpose based on the ISO 20022 standard","example":"GDDS"},"creditorReference":{"type":"string","description":"The structured reference used by the biller to reconcile the payment. This is also called the structured communication in Belgium. Both BBA (Belgium) and ISO (International) types are supported. It can be left empty if the remittanceInfo is defined","example":"000600232562"},"remittanceInfo":{"type":"string","description":"An unstructured string that is used as communication in the payment. This information is only used if there is no creditorReference. It can be left empty if the creditorReference is defined","example":"Invoice 1","maxLength":140,"minLength":0},"customerFirstName":{"type":"string","description":"Client first name","example":"Jean","maxLength":255,"minLength":0},"customerLastName":{"type":"string","description":"Client last name","example":"Dujardin","maxLength":255,"minLength":0},"customerVAT":{"type":"string","description":"Client VAT number (if applicable) with the country code","example":"BE0000000097"},"customerEmail":{"type":"string","description":"email address. This is important to provide so that we can match this customer to the DigiTeal registered users.","example":"john.doe@me.com","maxLength":255,"minLength":0},"customerMobile":{"type":"string","description":"the mobile phone of the customer with the national prefix","example":"+32123456789","maxLength":255,"minLength":0},"customerAddressStreet":{"type":"string","description":"street name of the client address","example":"Rue de la Paix","maxLength":250,"minLength":0},"customerAddressNumber":{"type":"string","description":"street number","example":14,"maxLength":250,"minLength":0},"customerAddressZip":{"type":"string","description":"Zipcode","example":1000,"maxLength":20,"minLength":0},"customerAddressCity":{"type":"string","description":"City","example":"Bruxelles","maxLength":250,"minLength":0},"customerAddressCountry":{"type":"string","description":"Country (ISO 3166-1 alpha-2)","example":"BE","maxLength":250,"minLength":0},"iban":{"type":"string","description":"IBAN number, if you have registered multiple IBAN numbers on your account then this field is required!","example":"BE40251230861709"},"bic":{"type":"string","description":"BIC number","example":"GKCCBEBB"},"requesterID":{"type":"integer","format":"int64","description":"The id of the Requester. The requesterID, the requesterVAT, the requesterIdentificationNumber or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication","example":1234},"requesterVAT":{"type":"string","description":"The VAT number of the Requester. The requesterID, the requesterVAT, the requesterIdentificationNumber or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication","example":"BE0000000196"},"requesterIdentificationNumber":{"type":"string","description":"The national identification number of the Requester. The requesterID, the requesterVAT, the requesterIdentificationNumber or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"requesterEmail":{"type":"string","description":"The email of the requester. The requesterID, the requesterVAT, the requesterIdentificationNumber or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication","example":"requestor@company.com","maxLength":255,"minLength":0},"expectingDocumentAttached":{"type":"boolean","description":"True if documents should be attached to this invoice, false if no document should be attached. Default is true.","example":true},"amountInCents":{"type":"string","description":"amount expressed in cents that has to be paid","example":1234,"pattern":"-?\\d+((\\.|,)\\d{1,2})?"},"dueDate":{"type":"string","format":"date","description":"The date before which the payment must be performed. If it is provided, it can be used to show which bills are overdue or will soon be overdue. The payment slip will display a memo-date one week before the due date if that date is still in the future at generation time. The expected format is YYYY-MM-DD","example":"2019-12-31"},"publicationStatus":{"type":"string","description":"An invoice can have one of two statusses:PUBLISHED (default value) : if generated the payment request can no longer be modified DRAFT : if generated the payment request can still be updated.","enum":["PUBLISHED, DRAFT"],"example":"PUBLISHED","pattern":"(PUBLISHED)|(DRAFT)"},"size":{"type":"integer","format":"int32","description":"Indicates the size of the image you want to receive in pixels.","example":600},"customerInternalId":{"type":"string","description":"The id used by the requester his internal billing system. This is mandatory when creating an invoice","example":"TEST12345","maxLength":255,"minLength":0},"format":{"type":"string","description":"Type of the image you want to receive, default value = QR","enum":["PAYMENT_SLIP, PAYMENT_SLIP_WITH_QR, QR, QR_BE, QR_NL, QR_EXPLAINED, PAYMENT_SLIP_WITH_BANNER, BANNER, BANNER2, BANNER3, BANNER4, BANNER5, BANNER6, QR_TEXT, QR_URL, NONE"],"example":"QR","pattern":"(PAYMENT_SLIP)|(PAYMENT_SLIP_WITH_QR)|(QR)|(QR_BE)|(QR_NL)|(QR_EXPLAINED)|(PAYMENT_SLIP_WITH_BANNER)|(BANNER)|(BANNER2)|(BANNER3)|(BANNER4)|(BANNER5)|(BANNER6)|(QR_TEXT)|(QR_URL)|(NONE)"},"invoiceInternalId":{"type":"string","description":"The internal identifier of the invoice as known by the issuer. It must be unique per issuer.","example":"Bill1234","maxLength":255,"minLength":0},"imageFormat":{"type":"string","description":"Format of the image you want to receive, default value = PNG","enum":["PNG, BMP"],"example":"PNG","pattern":"(PNG)|(BMP)"},"emailOptin":{"type":"boolean","description":"Triggers the email optin retrieval in the payment flow.","example":true},"languages":{"type":"array","items":{"type":"string","enum":["FR","EN","ES","NL","DE"]}}},"required":["amountInCents","customerInternalId","dueDate","invoiceInternalId"]},"VerificationRequest":{"type":"object","description":"The details of the bank account to be verified.","properties":{"iban":{"type":"string","description":"The International Bank Account Number (IBAN) of the account holder.","example":"BE68539007547034","pattern":"^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$"},"name":{"type":"string","description":"The full name of the account holder. The name or the identifier must be present, and are mutually exclusive.","example":"Jan Peeter","maxLength":140,"minLength":0},"identifier":{"$ref":"#/components/schemas/Identifier"}},"required":["iban"]},"VerificationResponse":{"type":"object","description":"The result of the verification check.","properties":{"vopMatchResult":{"$ref":"#/components/schemas/VopMatchResult"},"bankAccountHolder":{"$ref":"#/components/schemas/BankAccountHolder"},"bank":{"$ref":"#/components/schemas/BankDetails"}}},"Error":{"type":"object","description":"A standard error response.","properties":{"errorCode":{"type":"string","description":"A unique code for the error."},"message":{"type":"string","description":"A human-readable description of the error."}},"required":["errorCode","message"]},"CreditNoteCreationRequest":{"type":"object","description":"Data necessary to create the credit note","properties":{"creationDate":{"type":"string","format":"date","description":"The date the bill was emitted. The default value is today. The expected format is YYYY-MM-DD","example":"2019-12-31"},"language":{"type":"string","description":"The language of the client (NL, FR or EN)","example":"EN"},"secondaryLanguage":{"type":"string","description":"A secondary language of the client","example":"NL"},"amountInCents":{"type":"string","description":"amount expressed in cents that has to be paid","example":1234},"size":{"type":"integer","format":"int32","description":"Indicates the size of the image you want to receive in pixels.","example":600},"format":{"type":"string","description":"format of the image you want to receive, default value = QR","enum":["PAYMENT_SLIP, PAYMENT_SLIP_WITH_QR, QR, QR_BE, QR_NL, QR_EXPLAINED, PAYMENT_SLIP_WITH_BANNER, BANNER, BANNER2, BANNER3, BANNER4, BANNER5, BANNER6, QR_TEXT, QR_URL, NONE"],"example":"QR","pattern":"(PAYMENT_SLIP)|(PAYMENT_SLIP_WITH_QR)|(QR)|(QR_BE)|(QR_NL)|(QR_EXPLAINED)|(PAYMENT_SLIP_WITH_BANNER)|(BANNER)|(BANNER2)|(BANNER3)|(BANNER4)|(BANNER5)|(BANNER6)|(QR_TEXT)|(QR_URL)|(NONE)"},"creditNoteInternalId":{"type":"string","description":"the internal identifier of the credit note as know to the emitter","example":"CreditNote1234"},"invoiceUUID":{"type":"string","format":"uuid","description":"the UUID of the related invoice","example":"e529f8b4790f11e7b5a5be2e44b06b52"}},"required":["amountInCents","creditNoteInternalId","invoiceUUID"]},"AutoPaymentRequest":{"type":"object","properties":{"creationDate":{"type":"string","format":"date","description":"The date the bill was emitted. The default value is today. The expected format is YYYY-MM-DD","example":"2019-12-31"},"language":{"type":"string","description":"The language of the client (NL, FR or EN)","example":"EN"},"secondaryLanguage":{"type":"string","description":"A secondary language of the client","example":"NL"},"currency":{"type":"string","description":"The currency of the amount to be paid based on the ISO 4217-alpha standard. The default value is EUR","example":"EUR"},"purpose":{"type":"string","description":"The purpose based on the ISO 20022 standard","example":"GDDS"},"creditorReference":{"type":"string","description":"The structured reference used by the biller to reconcile the payment. This is also called the structured communication in Belgium. Both BBA (Belgium) and ISO (International) types are supported. It can be left empty if the remittanceInfo is defined","example":"000600232562"},"remittanceInfo":{"type":"string","description":"An unstructured string that is used as communication in the payment. This information is only used if there is no creditorReference. It can be left empty if the creditorReference is defined","example":"Invoice 1","maxLength":140,"minLength":0},"customerFirstName":{"type":"string","description":"Client first name","example":"Jean","maxLength":255,"minLength":0},"customerLastName":{"type":"string","description":"Client last name","example":"Dujardin","maxLength":255,"minLength":0},"customerVAT":{"type":"string","description":"Client VAT number (if applicable) with the country code","example":"BE0000000097"},"customerEmail":{"type":"string","description":"email address. This is important to provide so that we can match this customer to the DigiTeal registered users.","example":"john.doe@me.com","maxLength":255,"minLength":0},"customerMobile":{"type":"string","description":"the mobile phone of the customer with the national prefix","example":"+32123456789","maxLength":255,"minLength":0},"customerAddressStreet":{"type":"string","description":"street name of the client address","example":"Rue de la Paix","maxLength":250,"minLength":0},"customerAddressNumber":{"type":"string","description":"street number","example":14,"maxLength":250,"minLength":0},"customerAddressZip":{"type":"string","description":"Zipcode","example":1000,"maxLength":20,"minLength":0},"customerAddressCity":{"type":"string","description":"City","example":"Bruxelles","maxLength":250,"minLength":0},"customerAddressCountry":{"type":"string","description":"Country (ISO 3166-1 alpha-2)","example":"BE","maxLength":250,"minLength":0},"iban":{"type":"string","description":"IBAN number, if you have registered multiple IBAN numbers on your account then this field is required!","example":"BE40251230861709"},"bic":{"type":"string","description":"BIC number","example":"GKCCBEBB"},"requesterID":{"type":"integer","format":"int64","description":"The id of the Requester. The requesterID, the requesterVAT, the requesterIdentificationNumber or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication","example":1234},"requesterVAT":{"type":"string","description":"The VAT number of the Requester. The requesterID, the requesterVAT, the requesterIdentificationNumber or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication","example":"BE0000000196"},"requesterIdentificationNumber":{"type":"string","description":"The national identification number of the Requester. The requesterID, the requesterVAT, the requesterIdentificationNumber or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"requesterEmail":{"type":"string","description":"The email of the requester. The requesterID, the requesterVAT, the requesterIdentificationNumber or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication","example":"requestor@company.com","maxLength":255,"minLength":0},"expectingDocumentAttached":{"type":"boolean","description":"True if documents should be attached to this invoice, false if no document should be attached. Default is true.","example":true},"amountInCents":{"type":"string","description":"amount expressed in cents that has to be paid","example":1234,"minLength":1},"customerInternalId":{"type":"string","description":"The id used by the requester his internal billing system. This is mandatory when creating an invoice","example":"TEST12345","maxLength":255,"minLength":0},"transferID":{"type":"string","format":"uuid","description":"The transfer unique identifier if this autopayment is meant to fund a transfer","example":"e529f8b4790f11e7b5a5be2e44b06b52"}},"required":["amountInCents","customerInternalId"]},"AutoPaymentResult":{"type":"object","properties":{"status":{"type":"string","description":"Status of the auto payment action. This can either be EXECUTED (the payment has been directly executed), PLANNED (the client has an active auto payment configuration and the threshold has not been exceeded), THRESHOLD_EXCEEDED (the limit set by the user has already been reached, the client has been notified of the issue), NA (not applicable, the client has no auto pay configuration) and HIGH_RISK (Digiteal evaluated that the payment is too risky to be executed automatically, for example because the amount is too high)","enum":["EXECUTED","PLANNED","THRESHOLD_EXCEEDED","HIGH_RISK","NA"],"example":"EXECUTED"},"originBankAccount":{"type":"string","description":"the bank account from where the money has been transferred","example":"BE40251230861709"},"paymentID":{"type":"string","description":"The unique identifier of the payment known by the requester","example":"e529f8b4790f11e7b5a5be2e44b06b52"},"paymentConfirmationDate":{"type":"string","description":"the date on which the payment has been confirmed","example":"2019-04-15"},"paymentRequestDate":{"type":"string","description":"the date on which the payment request has been sent","example":"2019-04-30"},"comment":{"type":"string","description":"Comment","example":"A comment"}}},"ClientUpdateRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1}},"required":["name"]},"PaymentUpdateRequest":{"type":"object","properties":{"state":{"type":"string"}}},"GetUrlRequest":{"type":"object","properties":{"paymentUuid":{"type":"string"},"paymentMethod":{"type":"string"},"amount":{"type":"string"},"communication":{"type":"string"},"language":{"type":"string"}}},"InitiateEmbeddedPaymentMSPRequest":{"type":"object","properties":{"paymentUuid":{"type":"string"},"paymentMethod":{"type":"string"},"amountInCents":{"type":"integer","format":"int64"},"language":{"type":"string"},"token":{"type":"string"},"communication":{"type":"string"},"browser":{"$ref":"#/components/schemas/Browser"},"customerEmail":{"type":"string"},"originator":{"type":"string"}},"required":["amountInCents","paymentMethod","paymentUuid","token"]},"GetMspResponseRequest":{"type":"object","properties":{"paymentUuid":{"type":"string"},"paymentMethod":{"type":"string"},"language":{"type":"string"},"paymentData":{"$ref":"#/components/schemas/PaymentData"},"amount":{"type":"string"}}},"KybRequest":{"type":"object","properties":{"complete":{"type":"boolean"},"company":{"$ref":"#/components/schemas/Company"}},"required":["company"]},"SinglePaymentRequestUpdateRequest":{"type":"object","properties":{"bank-id":{"type":"string","writeOnly":true},"bankId":{"type":"string"}}},"OpenBankingCompanyConfigAdminUpdateRequest":{"type":"object","properties":{"customDomain":{"type":"string"},"hasLimitedCountries":{"type":"boolean"},"limitedCountries":{"type":"array","items":{"$ref":"#/components/schemas/CountryCode"}},"transactionValidationActivated":{"type":"boolean"},"amountDaysTransactionValidation":{"type":"integer","format":"int32"}}},"QRInformation":{"type":"object","properties":{"mail":{"type":"string"},"uuid":{"type":"string","format":"uuid"},"communication":{"type":"string"},"emitterName":{"type":"string"},"amount":{"type":"string"},"dueDate":{"type":"string"},"digitealOnly":{"type":"boolean"},"user":{"type":"boolean"}}},"ViesCompanyInfoResponse":{"type":"object","properties":{"vatNumber":{"type":"string"},"name":{"type":"string"},"address":{"type":"string"},"alreadyRegistered":{"type":"boolean"},"maskedEmailAddress":{"type":"string"}}},"PagedResourcesAssemblerPaymentDetails":{"type":"object","properties":{"forceFirstAndLastRels":{"type":"boolean","writeOnly":true}}},"Count":{"type":"object","properties":{"total":{"type":"integer","format":"int64"}}},"MfaInfo":{"type":"object","properties":{"totp_activated":{"type":"boolean"},"eotp_activated":{"type":"boolean"}}},"DigitealForestKPI":{"type":"object","properties":{"nbrPlantedTrees":{"type":"number","format":"double"},"nbrSheetsOfPaper":{"type":"integer"},"tonsOfCO2":{"type":"number","format":"double"}}},"UserData":{"type":"object","properties":{"userProfile":{"$ref":"#/components/schemas/UserProfile"},"basicUser":{"$ref":"#/components/schemas/BasicUser"}}},"BasicUser":{"type":"object","properties":{"login":{"type":"string"},"language":{"type":"string","enum":["FR","EN","ES","NL","DE"]},"canSend":{"type":"boolean"},"name":{"type":"string"},"companyState":{"type":"string"},"companyPack":{"type":"string"},"person":{"type":"boolean"},"checkState":{"type":"string"},"hasActiveBankAccount":{"type":"boolean"},"hasBankAccountToActivate":{"type":"boolean"},"completedQuestions":{"type":"boolean"},"updatedConditions":{"type":"boolean"},"alreadyApprovedConditions":{"type":"boolean"},"hasPin":{"type":"boolean"},"passwordSet":{"type":"boolean"},"permissionsEnable":{"type":"boolean"},"personExpired":{"type":"boolean"},"personExpiredWaitValidation":{"type":"boolean"},"nbrFreeTrustedPayments":{"type":"integer","format":"int32"},"paymentDone":{"type":"boolean"},"friendsInvited":{"type":"boolean"},"applicationRecommended":{"type":"boolean"},"donationDone":{"type":"boolean"},"customerRelationshipCreated":{"type":"boolean"},"mandateValidated":{"type":"boolean"},"kycCompleted":{"type":"boolean"},"activeSectorsProvided":{"type":"boolean"},"idDocumentProvided":{"type":"boolean"},"profileCompletionTip":{"type":"string","enum":["VALIDATE_EMAIL","COMPLETE_KYC","PAY_INVOICE","OPTIN","DONATE","GIVE_FIVE_STARS_IN_STORE","INVITE_THREE_FRIENDS_FROM_SAME_SUPPLIER"]},"profileCompletionPercentage":{"type":"integer","format":"int32"},"profileStars":{"type":"integer","format":"int32"},"profileBadge":{"type":"string","enum":["SEED","SPROUT_TREE_SMALL","SPROUT_TREE_MEDIUM","SPROUT_TREE","SHRUB","TREE"]},"brandingType":{"type":"string","enum":["DIGITEAL","ZOFINANCIALS","TERMS_TECH"]},"dataReviewIsRequired":{"type":"boolean"},"id":{"type":"integer","format":"int64"}}},"AlertOverview":{"type":"object","properties":{"invoiceCount":{"type":"integer","format":"int64"},"mandateActivation":{"type":"boolean"},"activatePinCode":{"type":"boolean"},"pinCodeReset":{"type":"boolean"},"pincodeBlocked":{"type":"boolean"},"activatePayment":{"type":"boolean"},"firstConnectionOnMobile":{"type":"boolean"},"personExpired":{"type":"boolean"},"kycIsValid":{"type":"boolean"},"total":{"type":"integer","format":"int64"},"newAlerts":{"type":"boolean"}}},"TransactionsSearchCriteriaRequest":{"type":"object","properties":{"executionDate":{"type":"string","format":"date"},"executionDateFirst":{"type":"string","format":"date"},"executionDateLast":{"type":"string","format":"date"},"amount":{"type":"number","format":"double"},"amountMin":{"type":"number","format":"double"},"amountMax":{"type":"number","format":"double"},"counterpartIBAN":{"type":"string"},"userIBAN":{"type":"string"},"status":{"type":"string"},"paymentMethod":{"type":"string"},"transactionId":{"type":"string","format":"uuid"},"customerExternalId":{"type":"string"},"communication":{"type":"string"},"counterpartName":{"type":"string"}}},"PagedResourcesAssemblerTransactionResponse":{"type":"object","properties":{"forceFirstAndLastRels":{"type":"boolean","writeOnly":true}}},"CustomerDataReviewPersonResponse":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"isPep":{"type":"boolean"},"pepExplanation":{"type":"string"},"sectors":{"type":"array","items":{"type":"string"}},"sectorOtherValue":{"type":"string"}}},"ProfileQuestions":{"type":"object","properties":{"complete":{"type":"boolean"},"completeOnNewWebApp":{"type":"boolean"},"askedIdFront":{"type":"boolean","writeOnly":true},"askedIdBack":{"type":"boolean","writeOnly":true},"askedIdProfile":{"type":"boolean","writeOnly":true},"askedIdCertificate":{"type":"boolean","writeOnly":true},"askedIdUnknown":{"type":"boolean","writeOnly":true}}},"KycSteps":{"type":"object","properties":{"askedPEP":{"type":"boolean"},"askedSectors":{"type":"boolean"},"askedLogin":{"type":"boolean"},"askedIban":{"type":"boolean"},"askedAddress":{"type":"boolean"},"askedGender":{"type":"boolean"},"askedBirthDay":{"type":"boolean"},"askedUBO":{"type":"boolean"},"askedNrn":{"type":"boolean"}}},"InitialData":{"type":"object","properties":{"eidLocation":{"type":"string"},"countryCodes":{"type":"array","items":{"$ref":"#/components/schemas/CountryCode"}},"personContracts":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ContractDetails"}}},"companyContracts":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ContractDetails"}}}}},"SectorDetails":{"type":"object","properties":{"technicalKey":{"type":"string"},"translationKey":{"type":"string"},"parent":{}}},"CustomerDataReviewCompanyResponse":{"type":"object","properties":{"defaultAddress":{"$ref":"#/components/schemas/Address"},"billingAddress":{"$ref":"#/components/schemas/Address"},"sectors":{"type":"array","items":{"type":"string"}},"contactPersonFirstName":{"type":"string"},"contactPersonLastName":{"type":"string"},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/Ubo"}},"sectorOtherValue":{"type":"string"}}},"B2BPaymentButtonRequest":{"type":"object","properties":{"language":{"type":"string","description":"The language of the client (NL, FR or EN). The default is EN.","example":"EN"},"creditorVAT":{"type":"string","description":"The VAT number of the creditor","example":"BE0000000097"},"creditorName":{"type":"string","description":"The name of the creditor","example":"MyTelacom","minLength":1},"debtorVAT":{"type":"string","description":"The VAT number of the debtor","example":"BE0000000196"},"creditorReference":{"type":"string","description":"The structured reference used by the biller to reconcile the payment. This is also called the structured communication in Belgium. Both BBA (Belgium) and ISO (International) types are supported. It can be left empty if the remittanceInfo is defined","example":"000600232562"},"remittanceInfo":{"type":"string","description":"An unstructured string that is used as communication in the payment. This information is only used if there is nol creditorReference. It can be left empty if the creditorReference is defined","example":"Bill1234"},"creditorEmail":{"type":"string","description":"The email address of the creditor","example":"john.doe@me.com"},"creditorIBAN":{"type":"string","description":"The IBAN of the creditor for this payment","example":"BE40251230861709"},"amountInCents":{"type":"integer","format":"int64","description":"Amount expressed in cents to be paid","example":1234},"currency":{"type":"string","description":"The currency of the amount to be paid based on the ISO 4217-alpha standard. The default value is EUR","example":"EUR"},"errorURL":{"type":"string","description":"URL where the user will be redirected in case a error occurred during the payment. Maximum length of 255 characters.","example":"https://api.myservice.com/paymentError"},"cancelURL":{"type":"string","description":"URL where the user will be redirected in case a cancel occurred during the payment. Maximum length of 255 characters.","example":"https://api.myservice.com/paymentCancelled"},"confirmationURL":{"type":"string","description":"URL where the user will be redirected when the payment will be confirmed by the debtor. Maximum length of 255 characters.","example":"https://api.myservice.com/paymentConfirmed"}},"required":["amountInCents","creditorEmail","creditorIBAN","creditorName","creditorVAT","debtorVAT"]},"ExtractDataDTO":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"birthDay":{"type":"string","format":"date"},"birthPlace":{"type":"string"},"nationality":{"type":"string"},"cardNumber":{"type":"string"},"nationalIdentificationNumber":{"type":"string"},"validityStart":{"type":"string","format":"date"},"validityEnd":{"type":"string","format":"date"},"language":{"type":"string","enum":["FR","EN","ES","NL","DE"]},"dateExtraction":{"type":"string","format":"date"},"gender":{"type":"string","enum":["UNKNOWN","MALE","FEMALE","NA"]},"iban":{"type":"string"}}},"PaymentScreenDetails":{"type":"object","properties":{"paymentState":{"type":"string"},"paid":{"type":"boolean"},"amount":{"type":"string"},"currency":{"type":"string"},"forcedPaymentMethod":{"type":"string","enum":["BANCONTACT","CARTE_BLEUE","IDEAL","INTERNAL","MAESTRO","MASTERCARD","PAYCONIQ","SCT","STANDARD","VISA","GOOGLE_PAY","PIS_STANDARD","PIS_PREMIUM","PIS_PREMIUM_INSTANT","APPLE_PAY"]},"allowedPaymentMethods":{"type":"array","items":{"type":"string","enum":["BANCONTACT","CARTE_BLEUE","IDEAL","INTERNAL","MAESTRO","MASTERCARD","PAYCONIQ","SCT","STANDARD","VISA","GOOGLE_PAY","PIS_STANDARD","PIS_PREMIUM","PIS_PREMIUM_INSTANT","APPLE_PAY"]}},"minAmount":{"type":"number","format":"double"},"maxAmount":{"type":"number","format":"double"},"suggestedAmount":{"type":"number","format":"double"},"suggestedExecutionDate":{"type":"string"},"maximumExecutionDate":{"type":"string"},"requester":{"type":"string"},"requesterId":{"type":"integer","format":"int64"},"receiverAccount":{"type":"string"},"logo":{"type":"string"},"smallLogo":{"type":"string"},"paymentUUID":{"type":"string","format":"uuid"},"communication":{"type":"string"},"userBankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/BankAccountSelection"}},"differentUser":{"type":"boolean"},"linkCustomer":{"type":"boolean"},"debtorEmail":{"type":"string"},"pspKey":{"type":"string"},"showQRCode":{"type":"boolean"},"requestEmailOptin":{"type":"boolean"},"expiryDateTime":{"type":"string","format":"date-time"},"fee":{"type":"string"},"feeDescription":{"type":"string"},"singlePaymentRequest":{"type":"boolean"}}},"ActivatedPaymentMethodResponse":{"type":"object","properties":{"paymentMethod":{"type":"string","enum":["BANCONTACT","CARTE_BLEUE","IDEAL","INTERNAL","MAESTRO","MASTERCARD","PAYCONIQ","SCT","STANDARD","VISA","GOOGLE_PAY","PIS_STANDARD","PIS_PREMIUM","PIS_PREMIUM_INSTANT","APPLE_PAY"]},"psp":{"type":"string","enum":["BUCKAROO","MULTISAFEPAY","FINARO"]},"pspGatewayId":{"type":"string"}}},"PisResponse":{"type":"object","properties":{"redirectUrl":{"type":"string"}}},"CountryCode":{"type":"object","properties":{"representation":{"type":"string"},"inEEA":{"type":"boolean"},"belgian":{"type":"boolean"}}},"PagedResourcesAssemblerIssuerDetails":{"type":"object","properties":{"forceFirstAndLastRels":{"type":"boolean","writeOnly":true}}},"PagedModelEntityModelIssuerDetails":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/EntityModelIssuerDetails"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"PagedResourcesAssemblerSendInvoiceDetails":{"type":"object","properties":{"forceFirstAndLastRels":{"type":"boolean","writeOnly":true}}},"PagedModelEntityModelSendInvoiceDetails":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/EntityModelSendInvoiceDetails"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"SendInvoiceFullDetails":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"invoiceInternalIdentifier":{"type":"string"},"amount":{"type":"string"},"currency":{"type":"string"},"dueDate":{"type":"string"},"creationDate":{"type":"string"},"purpose":{"type":"string"},"communication":{"type":"string"},"paidAutomatically":{"type":"boolean"},"documentsDetails":{"type":"array","items":{"$ref":"#/components/schemas/DocumentDetails"}},"requestedOn":{"type":"string","format":"date-time"},"customerFirstName":{"type":"string"},"customerLastName":{"type":"string"},"customerVAT":{"type":"string"},"customerEmail":{"type":"string"},"customerMobile":{"type":"string"},"customerInternalId":{"type":"string"},"customerAddressStreet":{"type":"string"},"customerAddressNumber":{"type":"string"},"customerAddressZip":{"type":"string"},"customerAddressCity":{"type":"string"},"customerAddressCountry":{"type":"string"}}},"PagedResourcesAssemblerInvoiceMinimalDetails":{"type":"object","properties":{"forceFirstAndLastRels":{"type":"boolean","writeOnly":true}}},"InvoiceSearch":{"type":"object","properties":{"iban":{"type":"string"},"reference":{"type":"string"},"emitterName":{"type":"string"},"paymentStatus":{"type":"string"},"paymentWithOptin":{"type":"string","enum":["OPTIN","DECLINED","UNKNOWN"],"writeOnly":true},"user":{"type":"string"},"abstractPersonId":{"type":"integer","format":"int64"},"fromDate":{"type":"string","format":"date"},"toDate":{"type":"string","format":"date"},"fromDueDate":{"type":"string","format":"date"},"toDueDate":{"type":"string","format":"date"},"action":{"type":"string"},"read":{"type":"boolean"},"invoiceStatuses":{"type":"string"}}},"PagedModelEntityModelInvoiceMinimalDetails":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/EntityModelInvoiceMinimalDetails"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"InvoiceFullDetails":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"emitterName":{"type":"string"},"emitterLogo":{"type":"string"},"emitterSmallLogo":{"type":"string"},"amount":{"type":"string"},"status":{"type":"string"},"dueDate":{"type":"string"},"digitealCreationDate":{"type":"string"},"digitealPublicationDate":{"type":"string"},"remaining":{"type":"integer","format":"int64"},"read":{"type":"boolean"},"scheduled":{"type":"boolean"},"paymentDate":{"type":"string"},"communication":{"type":"string"},"bic":{"type":"string"},"invoiceInternalId":{"type":"string"},"customerInternalID":{"type":"string"},"iban":{"type":"string"},"emitterId":{"type":"integer","format":"int64"},"optin":{"type":"boolean"},"documentsDetail":{"type":"array","items":{"$ref":"#/components/schemas/DocumentDetails"}},"deliveryMethod":{"type":"string"},"customerEmail":{"type":"string"},"autoPaymentActivable":{"type":"boolean"},"companyInActive":{"type":"boolean"},"expired":{"type":"boolean"}}},"PagedResourcesAssemblerEventDetails":{"type":"object","properties":{"forceFirstAndLastRels":{"type":"boolean","writeOnly":true}}},"EventSearch":{"type":"object","properties":{"eventType":{"type":"string","enum":["INVOICE_RECEIVED","CREDIT_NOTE_RECEIVED","INVOICE_REMINDER","BANK_ERROR","INVOICE_REIMBURSED","PAYMENT_REQUEST_REIMBURSED","PAYMENT_REQUEST_CREATION","DOCUMENT_ADD","COMMENT","INVOICE_PAYMENT","INVOICE_SET_AS_PAID","INVOICE_SET_AS_UNPAID","INVOICE_AUTO_PAYMENT","CHECKOUT_PAYMENT","CHECKOUT_AUTO_PAYMENT","OPTIN"]},"emitterName":{"type":"string"},"eventStatus":{"type":"string"},"fromDate":{"type":"string","format":"date-time"},"toDate":{"type":"string","format":"date-time"},"invoiceID":{"type":"string","format":"uuid"}}},"PagedResourcesAssembler":{"type":"object","properties":{"forceFirstAndLastRels":{"type":"boolean","writeOnly":true}}},"AutoPayOverview":{"type":"object","properties":{"average":{"type":"number","format":"double"},"max":{"type":"number","format":"double"},"points":{"type":"array","items":{"$ref":"#/components/schemas/PaymentChartPoint"}},"active":{"type":"boolean"},"customerID":{"type":"integer","format":"int64"},"executionTypes":{"type":"array","items":{"type":"string","enum":["IMMEDIATE","ONE_WEEK_BEFORE_DUE_DATE","DUE_DATE"]}},"periodicities":{"type":"array","items":{"type":"string","enum":["MONTH","TRIMESTER","SEMESTER","YEAR"]}},"bankAccounts":{"type":"array","items":{"$ref":"#/components/schemas/BankAccountSelection"}},"autoPayConfig":{"$ref":"#/components/schemas/AutoPayConfig"}}},"AutoPayCandidate":{"type":"object","properties":{"emitterID":{"type":"integer","format":"int64"},"emitterName":{"type":"string"},"emitterLogo":{"type":"string"},"customerID":{"type":"integer","format":"int64"},"customerInternalID":{"type":"string"},"fullName":{"type":"string"}}},"Logo":{"type":"object","properties":{"url":{"type":"string"},"companyId":{"type":"integer","format":"int64"}}},"PaymentDetails":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"requestedExecutionDate":{"type":"string"},"amount":{"type":"string"},"debtorIban":{"type":"string"},"debtorIbanName":{"type":"string"},"debtorCardNumber":{"type":"string"},"debtorLogo":{"type":"string"},"debtorType":{"type":"string","enum":["COMPANY","PERSON","UNKNOWN"]},"creditorIban":{"type":"string"},"requester":{"type":"string"},"requesterLogo":{"type":"string"},"customer":{"type":"string"},"customerID":{"type":"string"},"scheduled":{"type":"boolean"},"refundAvailable":{"type":"boolean"},"state":{"type":"string"},"stateType":{"type":"string"},"reference":{"type":"string"},"receive":{"type":"boolean"},"creditor":{"type":"boolean"},"receivedOnDigiteal":{"type":"boolean"},"paymentMethodName":{"type":"string"},"paymentInternalId":{"type":"string"},"confirmationTimeStamp":{"type":"string"}}},"DashboardDetails":{"type":"object","properties":{"nbrCustomers":{"type":"integer","format":"int32"},"nbrOptins":{"type":"integer","format":"int32"},"nbrInvoicesPublished":{"type":"integer","format":"int32"},"nbrInvoicesPaid":{"type":"integer","format":"int32"},"nbrInvoicesPaidByDigiteal":{"type":"integer","format":"int32"},"nbrInvoicesManuallyPaid":{"type":"integer","format":"int32"},"nbrInvoicesToPay":{"type":"integer","format":"int32"},"nbrInvoicesWithNoOptin":{"type":"integer","format":"int32"},"optinAndPayments":{"type":"array","items":{"$ref":"#/components/schemas/OptinAndPaymentPerMonth"}}}},"PageInvoiceDashboardDetails":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceDashboardDetails"}},"number":{"type":"integer","format":"int32"},"pageable":{"$ref":"#/components/schemas/PageableObject"},"first":{"type":"boolean"},"last":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"sort":{"$ref":"#/components/schemas/SortObject"},"empty":{"type":"boolean"}}},"InvoiceDashboardFullDetails":{"type":"object","properties":{"iban":{"type":"string"},"amountInCents":{"type":"integer","format":"int64"},"dueDate":{"type":"string"},"communication":{"type":"string"},"documentsDetails":{"type":"array","items":{"$ref":"#/components/schemas/DocumentDetails"}},"customerFirstName":{"type":"string"},"customerLastName":{"type":"string"},"customerInternalId":{"type":"string"},"customerAddressStreet":{"type":"string"},"customerAddressNumber":{"type":"string"},"customerAddressZip":{"type":"string"},"customerAddressCity":{"type":"string"},"customerAddressCountry":{"type":"string"}}},"PersonInfo":{"type":"object","properties":{"status":{"type":"string","description":"represents the status of the person within Digiteal: NOT_FOUND: No user with this email address registered in Digiteal, COMPANY: This email address is linked to a company, NOT_ACTIVATED: his email address has not been confirmed, ACTIVATED: his email address has been confirmed but he did not finish the KYC, DEACTIVATED: he deleted his account in Digiteal, PENDING: he finished his KYC and his information is being reviewed by Digiteal, OK: His KYC has been checked, he is ready to perform payments, EXPIRED: His KYC information has expired.","enum":["NOT_FOUND","COMPANY","NOT_ACTIVATED","ACTIVATED","DEACTIVATED","PENDING","OK","EXPIRED","UNKNOWN"],"example":"OK"},"id":{"type":"integer","format":"int64","description":"The Digiteal ID of the company","example":12},"email":{"type":"string","description":"email address of the person","example":"john.doe@yopmail.com"},"idDocumentValidityEnd":{"type":"string","format":"date","description":"The date the id document will expire. None if the date is unknown or no id document was provided. Format: dd/MM/yyyy","example":"31/12/2019"}}},"CompanyDTO":{"type":"object","properties":{"status":{"type":"string","description":"represents the status of the company within Digiteal: NONE = unknown, NOT_ACTIVATED = Digiteal's terms and conditions have not been accepted yet, ON_HOLD = not active as issuer , PROD = active as issuer","enum":["NOT_FOUND","NOT_ACTIVATED","ON_HOLD","PROD","DEACTIVATED"],"example":"PROD"},"vatNumber":{"type":"string","description":"VAT number of the concerned company","example":"BE0000000097"},"identificationNumber":{"type":"string","description":"Identification number of the company (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"id":{"type":"integer","format":"int64","description":"The Digiteal ID of the company","example":1234},"integratorId":{"type":"integer","format":"int64","description":"The Digiteal ID of the integrator company","example":1001},"companyName":{"type":"string","description":"Name of the company","example":"Your Telecom"},"ibans":{"type":"array","description":"Verified IBANs of the bank accounts associated to the company.","items":{"type":"string"}},"paymentMethods":{"type":"array","description":"Activated payment methods","items":{"type":"string","enum":["APPLE_PAY","BANCONTACT","CARTE_BLEUE","DIRECT","GOOGLE_PAY","IDEAL","INTERNAL","MAESTRO","MASTERCARD","PAYCONIQ","PIS_STANDARD","SCT","STANDARD","VISA"]}},"canSendFunds":{"type":"boolean","description":"The company can send funds. It can do this once the company has been validated and at least one IBAN is validated too.","example":true},"canReceiveFunds":{"type":"boolean","description":"The company can receive funds. It can do this once all the conditions to send funds are met, that the company has a paying profile and that there is at least one activated payment method.","example":true},"email":{"type":"string","description":"contact email address of the company","example":"my.company@yopmail.com"}},"required":["identificationNumber"]},"DetailedCompanyDTO":{"type":"object","properties":{"status":{"type":"string","description":"represents the status of the company within digiteal: NONE = unknown, NOT_ACTIVATED = Digiteal's terms and conditions have not been accepted yet, ON_HOLD = not active as issuer , PROD = active as issuer","enum":["NOT_FOUND","NOT_ACTIVATED","ON_HOLD","PROD","DEACTIVATED"],"example":"PROD"},"vatNumber":{"type":"string","description":"VAT number of the concerned company","example":"BE0000000097"},"identificationNumber":{"type":"string","description":"Identification number of the company (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"id":{"type":"integer","format":"int64","description":"The Digiteal ID of the company","example":1234},"integratorId":{"type":"integer","format":"int64","description":"The Digiteal ID of the integrator company","example":1001},"companyName":{"type":"string","description":"Name of the company","example":"Your Telecom"},"mcc":{"type":"string","description":"MCC","example":7372},"ibans":{"type":"array","description":"Verified IBANs of the bank accounts associated to the company.","items":{"type":"string"}},"paymentMethods":{"type":"array","description":"Activated payment methods","items":{"type":"string","enum":["APPLE_PAY","BANCONTACT","CARTE_BLEUE","DIRECT","GOOGLE_PAY","IDEAL","INTERNAL","MAESTRO","MASTERCARD","PAYCONIQ","PIS_STANDARD","SCT","STANDARD","VISA"]}},"canSendFunds":{"type":"boolean","description":"The company can send funds. It can do this once the company has been validated and at least one IBAN is validated too.","example":true},"canReceiveFunds":{"type":"boolean","description":"The company can receive funds. It can do this once all the conditions to send funds are met, that the company has a paying profile and that there is at least one activated payment method.","example":true},"email":{"type":"string","description":"contact email address of the company","example":"my.company@yopmail.com"},"creationDate":{"type":"string","format":"date","description":"The date when the company was created. The expected format is YYYY-MM-DD","example":"2012-12-31"},"contactPerson":{"$ref":"#/components/schemas/PersonKYCInfo","description":"Contact person of the company. This person must have the right to register the company in Digiteal. This person must either represent the company or have a delegation of power to register the company."},"pack":{"type":"string","description":"The pack chosen by the company to register. The DISCOVER pack is free but it does not enable collecting funds. The first pack to enable collecting funds is the START pack.","enum":["DISCOVER","START","GO","POC","UNKNOWN"],"example":"START"},"address":{"$ref":"#/components/schemas/AddressDetails","description":"The main address of the company."},"ubos":{"type":"array","description":"The UBOs of the company","items":{"$ref":"#/components/schemas/UboDTO"}},"ibansToValidate":{"type":"array","description":"IBANs of the bank accounts associated to the company. You do not need to have verified that the company has access to these IBANs, Digiteal will take care of that. If you are sure, provide them in the ibans property.","items":{"type":"string"}},"customerRelationship":{"$ref":"#/components/schemas/CustomerRelationshipDTO","description":"Information about the customer"},"contractApprovalDate":{"type":"string","format":"date","description":"Customer contrat approval"}},"required":["contactPerson","customerRelationship","identificationNumber"]},"UserInfo":{"type":"object","properties":{"type":{"type":"string","description":"COMPANY, PERSON or NONE if this email is not linked to a user that confirmed his email address","enum":["COMPANY","PERSON","NONE"],"example":"COMPANY"},"companyStatus":{"type":"string","description":"represents the status of the company within digiteal: NONE = unknown, NOT_ACTIVATED = Digiteal's terms and conditions have not been accepted yet, ON_HOLD = not active as issuer , PROD = active as issuer","enum":["NOT_FOUND","NOT_ACTIVATED","ON_HOLD","PROD","DEACTIVATED"],"example":"PROD"},"vatNumber":{"type":"string","description":"VAT number of the concerned company","example":"BE0000000097"},"id":{"type":"integer","format":"int64","description":"The Digiteal ID of the company","example":12},"personStatus":{"type":"string","description":"represents the status of the person within Digiteal: NOT_FOUND: No user with this email address registered in Digiteal, COMPANY: This email address is linked to a company, NOT_ACTIVATED: his email address has not been confirmed, ACTIVATED: his email address has been confirmed but he did not finish the KYC, DEACTIVATED: he deleted his account in Digiteal, PENDING: he finished his KYC and his information is being reviewed by Digiteal, OK: His KYC has been checked, he is ready to perform payments, EXPIRED: His KYC information has expired.","enum":["NOT_FOUND","COMPANY","NOT_ACTIVATED","ACTIVATED","DEACTIVATED","PENDING","OK","EXPIRED","UNKNOWN"],"example":"OK"},"email":{"type":"string","description":"email address of the person/company","example":"john.doe@yopmail.com"}}},"PaymentRequestDTO":{"type":"object","properties":{"billId":{"type":"string","description":"The internal identifier of the invoice as know by the issuer.","example":"Bill1234"},"bic":{"type":"string","description":"BIC number","example":"GKCCBEBB"},"billerName":{"type":"string","description":"The name of the Requester","example":"BE0000000196"},"billerVAT":{"type":"string","description":"The VAT number of the Requester. The requesterID, the requesterVAT or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication","example":"BE0000000196"},"iban":{"type":"string","description":"IBAN number, if you have registered multiple IBAN numbers on your account then this field is required!","example":"BE40251230861709"},"amount":{"type":"number","format":"double","description":"amount expressed in euros that has to be paid","example":1234},"currency":{"type":"string","description":"The currency of the amount to be paid based on the ISO 4217-alpha standard. The default value is EUR","example":"EUR"},"billDate":{"type":"string","format":"date","description":"The date the bill was created","example":"2019-10-31"},"dueDate":{"type":"string","format":"date","description":"The due date of the bill","example":"2019-11-15"},"purpose":{"type":"string","description":"The purpose based on the ISO 20022 standard","example":"GDDS"},"creditorReference":{"type":"string","description":"The structured reference used by the biller to reconcile the payment. This is also called the structured communication in Belgium. Both BBA (Belgium) and ISO (International) types are supported. It can be left empty if the remittanceInfo is defined","example":"000600232562"},"remittanceInfo":{"type":"string","description":"An unstructured string that is used as communication in the payment. This information is only used if there is no creditorReference. It can be left empty if the creditorReference is defined","example":"Invoice 1"},"debtorName":{"type":"string","description":"Client last name or company name","example":"Dujardin"},"debtorFirstName":{"type":"string","description":"Client first name","example":"Jean"},"debtorVAT":{"type":"string","description":"Client VAT number (if applicable) with the country code","example":"BE0000000097"},"debtorEmail":{"type":"string","description":"email address. This is important to provide so that we can match this customer to the DigiTeal registered users.","example":"john.doe@me.com"},"debtorMobilePhoneNumber":{"type":"string","description":"the mobile phone of the customer with the national prefix","example":"+32123456789"},"debtorId":{"type":"string","description":"The id used by the requester his internal billing system. This is mandatory when creating an invoice","example":"TEST12345"},"debtorStreetName":{"type":"string","description":"street name of the client address","example":"Rue de la Paix"},"debtorHouseNumber":{"type":"string","description":"street number","example":14},"debtorZipCode":{"type":"string","description":"Zipcode","example":1000},"debtorCity":{"type":"string","description":"City","example":"Bruxelles"},"debtorCountry":{"type":"string","description":"Country (ISO 3166-1 alpha-2)","example":"BE"},"language":{"type":"string","description":"The language of the client (nl, fr or en)","example":"en"},"secondaryLanguage":{"type":"string","description":"A secondary language of the client","example":"nl"},"format":{"type":"string","description":"Format of the image you want to receive, default value = payment_slip","enum":["PAYMENT_SLIP","PAYMENT_SLIP_WITH_QR","QR","QR_BE","QR_NL","QR_EXPLAINED","PAYMENT_SLIP_WITH_BANNER","BANNER","BANNER2","BANNER3","BANNER4","BANNER5","BANNER6","QR_TEXT","QR_URL","NONE"],"example":"PAYMENT_SLIP","pattern":"(PAYMENT_SLIP)|(PAYMENT_SLIP_WITH_QR)|(QR)|(QR_BE)|(QR_NL)|(QR_EXPLAINED)|(PAYMENT_SLIP_WITH_BANNER)|(BANNER)|(BANNER2)|(BANNER3)|(BANNER4)|(BANNER5)|(BANNER6)|(QR_TEXT)|(QR_URL)|(NONE)"},"size":{"type":"integer","format":"int32","description":"The width of the image to generate (minimum 250, maximum 4000)","example":400,"minimum":250},"requestorEmail":{"type":"string","description":"The email of the requester. The requesterID, the requesterVAT or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication","example":"requestor@company.com"},"requestStatus":{"type":"string","description":"The status of the payment. Accepted values are DRAFT and PUBLISHED (default).","example":"PUBLISHED"},"directPayment":{"type":"boolean","description":"True if the payment of this invoice should be performed through a PIS, false if it should not. Default is false.","example":false},"paymentInternalId":{"type":"string","description":"The internal identifier of the payment as known by the creditor","example":"Payment1234"},"multiple":{"type":"boolean","description":"True if you want to accept multiple payments with this description. Default value is true.","example":true},"languages":{"type":"array","items":{"type":"string","enum":["FR","EN","ES","NL","DE"]}}}},"SinglePaymentSearch":{"type":"object","properties":{"onlyPaid":{"type":"boolean"},"companyVAT":{"type":"string"},"companyID":{"type":"integer","format":"int64"},"creditorReference":{"type":"string"},"remittanceInfo":{"type":"string"},"amountInCents":{"type":"integer","format":"int64"},"iban":{"type":"string"},"paymentInternalId":{"type":"string"}}},"PagedModelEntityModelPaymentDetails":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/EntityModelPaymentDetails"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"PagedResourcesAssemblerCustomerSupplierView":{"type":"object","properties":{"forceFirstAndLastRels":{"type":"boolean","writeOnly":true}}},"PagedModelEntityModelCustomerSupplierView":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/EntityModelCustomerSupplierView"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"ApplicationStatusResponse":{"type":"object","properties":{"application":{"type":"string","enum":["MOBILE"]},"operatingSystem":{"type":"string","enum":["IOS","ANDROID"]},"oldestSupportedVersion":{"type":"string"},"availableVersion":{"type":"string"}}},"CompanyResponse":{"type":"object","properties":{"name":{"type":"string"},"identificationNumber":{"$ref":"#/components/schemas/CompanyIdentificationNumber"},"language":{"type":"string","enum":["FR","EN","ES","NL","DE"]},"paymentMethods":{"type":"array","items":{"type":"string","enum":["BANCONTACT","CARTE_BLEUE","IDEAL","INTERNAL","MAESTRO","MASTERCARD","PAYCONIQ","SCT","STANDARD","VISA","GOOGLE_PAY","PIS_STANDARD","PIS_PREMIUM","PIS_PREMIUM_INSTANT","APPLE_PAY"]}},"logo":{"type":"string"},"contact":{"$ref":"#/components/schemas/Contact"},"address":{"$ref":"#/components/schemas/Address"},"nextAddress":{"$ref":"#/components/schemas/Address"},"sectors":{"type":"array","items":{"$ref":"#/components/schemas/Sector"}},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/Ubo"}},"bankAccount":{"$ref":"#/components/schemas/BankAccount"},"pack":{"type":"string","enum":["DISCOVER","START","GO","POC","UNKNOWN"]},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentResponse"}},"statusOnline":{"type":"boolean"},"mandates":{"type":"array","items":{"$ref":"#/components/schemas/MandateResponse"}}}},"CompanyPublicInfosResponse":{"type":"object","properties":{"name":{"type":"string"},"logoUrl":{"type":"string","format":"url"},"primaryColor":{"type":"string"},"primaryFontColor":{"type":"string"},"backgroundImageUrl":{"type":"string"},"showWebAppVersion":{"type":"boolean"},"paymentChoiceShowCreditorIban":{"type":"boolean"},"paymentMethods":{"$ref":"#/components/schemas/ActivatedPaymentMethodOrderResponse"}}},"PagedModelEntityModelInvoiceCommentDto":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/EntityModelInvoiceCommentDto"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"SectorDetailsInput":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"}}},"PagedResourcesAssemblerPersonListItem":{"type":"object","properties":{"forceFirstAndLastRels":{"type":"boolean","writeOnly":true}}},"PersonSearch":{"type":"object","properties":{"value":{"type":"string"},"country":{"type":"string"},"id":{"type":"string"},"registrationDate":{"type":"array","items":{"type":"string"}},"language":{"type":"string"},"login":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"idCheckState":{"type":"string"},"evaluation":{"type":"string"},"birthDay":{"type":"array","items":{"type":"string"}},"birthPlace":{"type":"string"},"nationality":{"type":"string"},"validityEnd":{"type":"array","items":{"type":"string"}},"ubo":{"type":"string"},"customSort":{"type":"string"}}},"PagedResourcesAssemblerPaymentListItem":{"type":"object","properties":{"forceFirstAndLastRels":{"type":"boolean","writeOnly":true}}},"PaymentSearch":{"type":"object","properties":{"abstractPersonId":{"type":"integer","format":"int64"},"reference":{"type":"string"},"amount":{"type":"number","format":"double"},"creditor":{"type":"string"},"debtor":{"type":"string"},"risk":{"type":"integer","format":"int32"},"status":{"type":"string"},"type":{"type":"string","enum":["SPR","INVOICE","TRANSFER_PAYMENT","TRANSFER","REIMBURSEMENT"]},"ibans":{"type":"array","items":{"type":"string"}}}},"PagedModelEntityModelPaymentListItem":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/EntityModelPaymentListItem"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"PaymentMethodAdminResponse":{"type":"object","properties":{"code":{"type":"string"}}},"NationalityDetails":{"type":"object","properties":{"countryCode":{"type":"string"}}},"MccAdminResponse":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"description":{"type":"string"}}},"PageMandateView":{"type":"object","properties":{"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"content":{"type":"array","items":{"$ref":"#/components/schemas/MandateView"}},"number":{"type":"integer","format":"int32"},"pageable":{"$ref":"#/components/schemas/PageableObject"},"first":{"type":"boolean"},"last":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"sort":{"$ref":"#/components/schemas/SortObject"},"empty":{"type":"boolean"}}},"PagedResourcesAssemblerAdminHistoryListItem":{"type":"object","properties":{"forceFirstAndLastRels":{"type":"boolean","writeOnly":true}}},"PagedModelEntityModelAdminHistoryListItem":{"type":"object","properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"content":{"type":"array","items":{"$ref":"#/components/schemas/EntityModelAdminHistoryListItem"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}},"SignedUrl":{"type":"object","properties":{"url":{"type":"string","format":"url"}}},"PagedResourcesAssemblerCompanyListItem":{"type":"object","properties":{"forceFirstAndLastRels":{"type":"boolean","writeOnly":true}}},"CompanySearch":{"type":"object","properties":{"value":{"type":"string"},"checkState":{"type":"string"},"id":{"type":"string"},"registrationDate":{"type":"array","items":{"type":"string"}},"validationTimeStamp":{"type":"array","items":{"type":"string"}},"pack":{"type":"string"},"activationStatus":{"type":"string"},"name":{"type":"string"},"vatNumber":{"type":"string"},"login":{"type":"string"},"emitterStatus":{"type":"string"},"canIntegrate":{"type":"string"},"contactPerson":{"type":"string"},"validationCheckState":{"type":"string"},"evaluation":{"type":"string"},"customSort":{"type":"string"}}},"AmlRiskLevelForcedResponse":{"type":"object","properties":{"activatedLogin":{"type":"string"},"deactivatedLogin":{"type":"string"},"started":{"type":"string","format":"date"},"startedComment":{"type":"string"},"stopped":{"type":"string","format":"date"},"stoppedComment":{"type":"string"}},"required":["activatedLogin","started"]},"DataValidationResultDetails":{"type":"object","properties":{"valid":{"type":"boolean"},"sentToJiraSupport":{"type":"boolean"},"publicRejectedReason":{"type":"string"},"internalNote":{"type":"string"},"name":{"type":"string"},"login":{"type":"string"},"creationDate":{"type":"string","format":"date-time"}}},"SanctionListTestLog":{"type":"object","properties":{"version":{"type":"integer","format":"int32"},"id":{"type":"integer","format":"int64"},"normalizedName":{"type":"string","maxLength":500,"minLength":0},"firstMatchNormalizedName":{"type":"string","maxLength":500,"minLength":0},"matchSummary":{"type":"string","maxLength":2000,"minLength":0},"matchDescription":{"type":"string","maxLength":2000,"minLength":0},"matchCount":{"type":"integer","format":"int32"},"reason":{"type":"string"},"creationTimeStamp":{"type":"string","format":"date-time"}}},"ParticipantSupportedPeppolDocumentTypesResponse":{"type":"object","properties":{"peppolIdentifier":{"type":"string","description":"PEPPOL identifier","example":"0208:0630675588"},"documentTypes":{"type":"array","description":"Document type identifiers","example":["urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:www.cenbii.eu:transaction:biitrns010:ver2.0:extended:urn:www.peppol.eu:bis:peppol4a:ver2.0::2.1"],"items":{"type":"string"}}},"required":["documentTypes","peppolIdentifier"]},"PeppolRegisteredParticipantResponse":{"type":"object","properties":{"peppolIdentifier":{"type":"string","description":"PEPPOL identifier","example":"0208:0202239951"},"name":{"type":"string","description":"Participant name","example":"Proximus"},"countryCode":{"type":"string"},"registrationDate":{"type":"string","format":"date","description":"Date of the registration within Digiteal","example":"2019-09-01","pattern":"yyyy-MM-dd"},"limitedToOutboundTraffic":{"type":"boolean","description":"Is the participant for outbound traffic only"},"contactPerson":{"$ref":"#/components/schemas/PeppolParticipantContactPersonResource","description":"Contact person that Digiteal will contact in case of a registration error"}},"required":["peppolIdentifier","registrationDate"]},"SupportedPeppolDocumentTypesResponse":{"type":"object","properties":{"documentTypes":{"type":"array","description":"Document type identifiers","example":["urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:www.cenbii.eu:transaction:biitrns010:ver2.0:extended:urn:www.peppol.eu:bis:peppol4a:ver2.0::2.1"],"items":{"$ref":"#/components/schemas/SupportedPeppolDocumentType"}}},"required":["documentTypes"]},"PeppolParticipantDetailsResponse":{"type":"object","properties":{"peppolIdentifier":{"type":"string","description":"PEPPOL identifier","example":"0208:0202239951"},"smpHostName":{"type":"string","description":"Registered SMP host name"},"supportedDocumentTypes":{"type":"array","description":"Supported document types","items":{"$ref":"#/components/schemas/PeppolParticipantSupportedDocumentTypeResponse"}},"businessCard":{"$ref":"#/components/schemas/PeppolParticipantBusinessCardResponse","description":"Business card"}},"required":["peppolIdentifier","smpHostName"]},"Username":{"type":"object","properties":{"representation":{"type":"string"}}},"UserIdentifier":{"type":"object","properties":{"identifier":{"type":"integer","format":"int64"}}},"LegalEntityIdentifier":{"type":"object","properties":{"identifier":{"type":"integer","format":"int64"}}},"RequestMetadata":{"type":"object","properties":{"source":{"type":"string"},"agent":{"type":"string"},"requestMoment":{"type":"string","format":"date-time"}}},"PersonIdentifier":{"type":"object","properties":{"identifier":{"type":"integer","format":"int64"}}},"UserMail":{"type":"object","properties":{"valid":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"value":{"type":"string","format":"email","minLength":1}},"required":["value"]},"PeppolParticipantContactPersonResource":{"type":"object","properties":{"firstName":{"type":"string","description":"Contact's first name","example":"John"},"lastName":{"type":"string","description":"Contact's last name","example":"Doe"},"phoneNumber":{"type":"string","description":"Contact's phone number","example":"+321234567"},"email":{"type":"string","description":"Contact's email","example":"john.doe@digiteal.eu"},"language":{"type":"string","format":"bcp-47","default":"en-US","description":"Contact's language","example":"fr-BE"}},"required":["email","language"]},"SectorItem":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"BankAccountSelection":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"bankName":{"type":"string"},"bankIconFileName":{"type":"string"},"mandateState":{"type":"string"},"iban":{"type":"string"}}},"AutowireCapableBeanFactory":{},"Environment":{"type":"object","properties":{"activeProfiles":{"type":"array","items":{"type":"string"}},"defaultProfiles":{"type":"array","items":{"type":"string"}}}},"BeanFactory":{},"HttpStatusCode":{"type":"object","properties":{"error":{"type":"boolean"},"is4xxClientError":{"type":"boolean"},"is5xxServerError":{"type":"boolean"},"is1xxInformational":{"type":"boolean"},"is2xxSuccessful":{"type":"boolean"},"is3xxRedirection":{"type":"boolean"}}},"TaglibDescriptor":{"type":"object","properties":{"taglibURI":{"type":"string"},"taglibLocation":{"type":"string"}}},"JspPropertyGroupDescriptor":{"type":"object","properties":{"buffer":{"type":"string"},"isXml":{"type":"string"},"elIgnored":{"type":"string"},"errorOnELNotFound":{"type":"string"},"pageEncoding":{"type":"string"},"scriptingInvalid":{"type":"string"},"includePreludes":{"type":"array","items":{"type":"string"}},"includeCodas":{"type":"array","items":{"type":"string"}},"deferredSyntaxAllowedAsLiteral":{"type":"string"},"trimDirectiveWhitespaces":{"type":"string"},"errorOnUndeclaredNamespace":{"type":"string"},"defaultContentType":{"type":"string"},"urlPatterns":{"type":"array","items":{"type":"string"}}}},"ApplicationContext":{"type":"object","properties":{"parent":{},"id":{"type":"string"},"displayName":{"type":"string"},"applicationName":{"type":"string"},"startupDate":{"type":"integer","format":"int64"},"autowireCapableBeanFactory":{"$ref":"#/components/schemas/AutowireCapableBeanFactory"},"environment":{"$ref":"#/components/schemas/Environment"},"beanDefinitionCount":{"type":"integer","format":"int32"},"beanDefinitionNames":{"type":"array","items":{"type":"string"}},"parentBeanFactory":{"$ref":"#/components/schemas/BeanFactory"},"classLoader":{"type":"object","properties":{"name":{"type":"string"},"registeredAsParallelCapable":{"type":"boolean"},"parent":{"type":"object","properties":{"name":{"type":"string"},"registeredAsParallelCapable":{"type":"boolean"},"unnamedModule":{"type":"object","properties":{"name":{"type":"string"},"descriptor":{"type":"object","properties":{"open":{"type":"boolean"},"automatic":{"type":"boolean"}}},"named":{"type":"boolean"},"annotations":{"type":"array","items":{}},"declaredAnnotations":{"type":"array","items":{}},"packages":{"type":"array","items":{"type":"string"},"uniqueItems":true},"nativeAccessEnabled":{"type":"boolean"},"layer":{}}},"definedPackages":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"sealed":{"type":"boolean"},"annotations":{"type":"array","items":{}},"declaredAnnotations":{"type":"array","items":{}},"specificationTitle":{"type":"string"},"specificationVersion":{"type":"string"},"specificationVendor":{"type":"string"},"implementationTitle":{"type":"string"},"implementationVersion":{"type":"string"},"implementationVendor":{"type":"string"}}}},"defaultAssertionStatus":{"type":"boolean","writeOnly":true}}},"unnamedModule":{"type":"object","properties":{"name":{"type":"string"},"descriptor":{"type":"object","properties":{"open":{"type":"boolean"},"automatic":{"type":"boolean"}}},"named":{"type":"boolean"},"annotations":{"type":"array","items":{}},"declaredAnnotations":{"type":"array","items":{}},"packages":{"type":"array","items":{"type":"string"},"uniqueItems":true},"nativeAccessEnabled":{"type":"boolean"},"layer":{}}},"definedPackages":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"sealed":{"type":"boolean"},"annotations":{"type":"array","items":{}},"declaredAnnotations":{"type":"array","items":{}},"specificationTitle":{"type":"string"},"specificationVersion":{"type":"string"},"specificationVendor":{"type":"string"},"implementationTitle":{"type":"string"},"implementationVersion":{"type":"string"},"implementationVendor":{"type":"string"}}}},"defaultAssertionStatus":{"type":"boolean","writeOnly":true}}}}},"ServletContext":{"type":"object","properties":{"classLoader":{"type":"object","properties":{"name":{"type":"string"},"registeredAsParallelCapable":{"type":"boolean"},"unnamedModule":{"type":"object","properties":{"name":{"type":"string"},"descriptor":{"type":"object","properties":{"open":{"type":"boolean"},"automatic":{"type":"boolean"}}},"named":{"type":"boolean"},"annotations":{"type":"array","items":{}},"declaredAnnotations":{"type":"array","items":{}},"packages":{"type":"array","items":{"type":"string"},"uniqueItems":true},"nativeAccessEnabled":{"type":"boolean"},"layer":{}}},"definedPackages":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"sealed":{"type":"boolean"},"annotations":{"type":"array","items":{}},"declaredAnnotations":{"type":"array","items":{}},"specificationTitle":{"type":"string"},"specificationVersion":{"type":"string"},"specificationVendor":{"type":"string"},"implementationTitle":{"type":"string"},"implementationVersion":{"type":"string"},"implementationVendor":{"type":"string"}}}},"defaultAssertionStatus":{"type":"boolean","writeOnly":true}}},"majorVersion":{"type":"integer","format":"int32"},"minorVersion":{"type":"integer","format":"int32"},"sessionCookieConfig":{"$ref":"#/components/schemas/SessionCookieConfig"},"virtualServerName":{"type":"string"},"attributeNames":{},"contextPath":{"type":"string"},"initParameterNames":{},"servletRegistrations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServletRegistration"}},"effectiveMajorVersion":{"type":"integer","format":"int32"},"effectiveMinorVersion":{"type":"integer","format":"int32"},"serverInfo":{"type":"string"},"servletContextName":{"type":"string"},"filterRegistrations":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/FilterRegistration"}},"sessionTrackingModes":{"type":"array","items":{"type":"string","enum":["COOKIE","URL","SSL"]},"uniqueItems":true,"writeOnly":true},"defaultSessionTrackingModes":{"type":"array","items":{"type":"string","enum":["COOKIE","URL","SSL"]},"uniqueItems":true},"effectiveSessionTrackingModes":{"type":"array","items":{"type":"string","enum":["COOKIE","URL","SSL"]},"uniqueItems":true},"jspConfigDescriptor":{"$ref":"#/components/schemas/JspConfigDescriptor"},"sessionTimeout":{"type":"integer","format":"int32"},"requestCharacterEncoding":{"type":"string"},"responseCharacterEncoding":{"type":"string"}}},"DefaultHttpStatusCode":{"allOf":[{"$ref":"#/components/schemas/HttpStatusCode"}]},"HttpStatus":{"allOf":[{"$ref":"#/components/schemas/HttpStatusCode"}],"enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"SessionCookieConfig":{"type":"object","properties":{"name":{"type":"string"},"path":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"comment":{"type":"string","deprecated":true},"maxAge":{"type":"integer","format":"int32"},"httpOnly":{"type":"boolean"},"secure":{"type":"boolean"},"domain":{"type":"string"}}},"ServletRegistration":{"type":"object","properties":{"mappings":{"type":"array","items":{"type":"string"}},"runAsRole":{"type":"string"},"name":{"type":"string"},"className":{"type":"string"},"initParameters":{"type":"object","additionalProperties":{"type":"string"}}}},"FilterRegistration":{"type":"object","properties":{"servletNameMappings":{"type":"array","items":{"type":"string"}},"urlPatternMappings":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"className":{"type":"string"},"initParameters":{"type":"object","additionalProperties":{"type":"string"}}}},"JspConfigDescriptor":{"type":"object","properties":{"taglibs":{"type":"array","items":{"$ref":"#/components/schemas/TaglibDescriptor"}},"jspPropertyGroups":{"type":"array","items":{"$ref":"#/components/schemas/JspPropertyGroupDescriptor"}}}},"PisAdditionalStepsAddressRequest":{"type":"object","properties":{"addressType":{"type":"string"},"streetName":{"type":"string"},"houseNumber":{"type":"string"},"zipCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"}}},"PisDebtorAdditionalStepsRequest":{"type":"object","properties":{"name":{"type":"string"},"iban":{"type":"string"},"address":{"$ref":"#/components/schemas/PisAdditionalStepsAddressRequest"},"clientId":{"type":"string"},"psuId":{"type":"string"},"username":{"type":"string"},"email":{"type":"string"},"fiscalCode":{"type":"string"},"ndgCode":{"type":"string"},"userCode":{"type":"string"},"keyDate":{"type":"string"}}},"AisAdditionalStepsRequest":{"type":"object","properties":{"iban":{"type":"string"},"clientId":{"type":"string"},"psuId":{"type":"string"},"username":{"type":"string"},"fiscalCode":{"type":"string"},"ndgCode":{"type":"string"},"userCode":{"type":"string"},"keyDate":{"type":"string"}}},"PapiTimeBasedTransferPayment":{"type":"object","properties":{"percentage":{"type":"number"},"iban":{"type":"string"},"communication":{"type":"string"}}},"Payment":{"type":"object","properties":{"amountInCents":{"type":"integer","format":"int64","description":"The amount of the payment in cents. The currency is EUR.","example":5000000},"conditional":{"type":"boolean","description":"True if the payment should be executed only after all the deciding actors have agreed. Otherwise, the payment will be executed as soon as the funds have been collected, for example as an advance payment. Default is true.","example":true},"hidden":{"type":"boolean","description":"True if the payment should not be visible to the actors, for example in case of a commission that should not be disclosed to the customer. Otherwise, the payment details will be visible to all the actors.","example":false},"creditorEmail":{"type":"string","description":"The email address of the creditor. The default IBAN of the creditor will be used. Please only provide a single identifier in this entity: creditorEmail, creditorVatNumber, creditorIdentificationNumber or creditorIBAN.","example":"john.doe@gmail.com"},"creditorVatNumber":{"type":"string","description":"The VAT number of the creditor. The default IBAN of the creditor will be used. Please only provide a single identifier in this entity: creditorEmail, creditorVatNumber, creditorIdentificationNumber or creditorIBAN.","example":"BE0000000097"},"creditorIdentificationNumber":{"type":"string","description":"Identification number of the creditor. The default IBAN of the creditor will be used. Please only provide a single identifier in this entity: creditorEmail, creditorVatNumber, creditorIdentificationNumber or creditorIBAN (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"creditorIBAN":{"type":"string","description":"The IBAN of the creditor. This IBAN should be linked to one of the actors. Please only provide a single identifier in this entity: creditorEmail, creditorVatNumber, creditorIdentificationNumber or creditorIBAN.","example":"BE40251230861709"},"communication":{"type":"string","description":"The communication that will be used in the payment. This will be visible in the bank statements of the creditor. Please use only ASCII characters here. Non ASCII will be simplified or removed to be sent through the banking channels.","example":"000600232562"},"comment":{"type":"string","description":"A comment about this payment. This will not be visible to the creditor.","example":"A comment"},"subPayments":{"description":"The optional sub payments that compose this payment. The amount of the sub payments will be deducted from this payment. So in case of a parent payment of 50€ and a subpayment of 20€. The payout for the parent payment will be of only 30€ (50€-20€).","example":[]},"notifyOfPaymentReceived":{"type":"boolean","description":"Notifications should be sent when there is a pay-in to this Digitrust. True by default."},"reference":{"type":"string","description":"A reference provided by the creator for this payment. This will not be visible to the creditor.","example":"Ref1234"}},"required":["amountInCents","communication"]},"Actor":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the actor. Please only provide a single identifier in this entity: email, vatNumber, identificationNumber, mandateId or digitealIdentifier.","example":"john.doe@gmail.com"},"vatNumber":{"type":"string","description":"The VAT number of the actor. Please only provide a single identifier in this entity: email, vatNumber, identificationNumber, mandateId or digitealIdentifier.","example":"BE0000000097"},"identificationNumber":{"type":"string","description":"Identification number of the actor.  Please only provide a single identifier in this entity: email, vatNumber, identificationNumber, mandateId or digitealIdentifier (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"mandateId":{"type":"integer","format":"int64","description":"The Digiteal identifier of the mandate used to identity this actor.  Please only provide a single identifier in this entity: email, vatNumber, identificationNumber, mandateId or digitealIdentifier.","example":123456},"digitealIdentifier":{"type":"integer","format":"int64","description":"The Digiteal identifier of the person/company. Please only provide a single identifier in this entity: email, vatNumber, identificationNumber, mandateId or digitealIdentifier.","example":12345678},"iban":{"type":"string","description":"The IBAN of the actor. This IBAN can later be used in the payments.","example":"BE40251230861709"},"name":{"type":"string","description":"The name of the actor","example":"John Doe"},"language":{"type":"string","description":"The language of this actor (EN, NL or FR). Default value is EN.","example":"EN"},"type":{"type":"string","description":"The type of this actor.","enum":["BUYER","SELLER","_3RD_PARTY"],"example":"SELLER"},"decide":{"type":"boolean","description":"True if this actor should decide if this Digitrust should be executed or not. False if he does not decide. True by default.","example":true}},"required":["type"]},"AutoPayConfig":{"type":"object","properties":{"customerInternalID":{"type":"string"},"emitterName":{"type":"string"},"bankAccount":{"$ref":"#/components/schemas/BankAccountSelection"},"configID":{"type":"string","format":"uuid"},"customerID":{"type":"integer","format":"int64"},"treshold":{"type":"number","format":"double"},"emitterID":{"type":"integer","format":"int64"},"emitterLogo":{"type":"string"},"periodicity":{"type":"string","enum":["MONTH","TRIMESTER","SEMESTER","YEAR"]},"executionType":{"type":"string","enum":["IMMEDIATE","ONE_WEEK_BEFORE_DUE_DATE","DUE_DATE"]},"status":{"type":"string","enum":["WAITING_FOR_KYC","SUSPENDED","DELETED","ACTIVE"]},"transferId":{"type":"string","format":"uuid"}}},"EmitterUserDetails":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"customerId":{"type":"string"},"mail":{"type":"string"},"optin":{"type":"string"}}},"ActivatedPaymentMethodOrderRequest":{"type":"object","properties":{"paymentMethod_1":{"type":"string"},"paymentMethod_2":{"type":"string"},"paymentMethod_3":{"type":"string"},"paymentMethod_4":{"type":"string"},"paymentMethod_5":{"type":"string"},"paymentMethod_6":{"type":"string"},"paymentMethod_7":{"type":"string"},"paymentMethod_8":{"type":"string"},"paymentMethod_9":{"type":"string"},"paymentMethod_10":{"type":"string"}}},"ActivatedPaymentMethodOrder":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"companyId":{"type":"integer","format":"int64"},"paymentMethod_1":{"type":"string"},"paymentMethod_2":{"type":"string"},"paymentMethod_3":{"type":"string"},"paymentMethod_4":{"type":"string"},"paymentMethod_5":{"type":"string"},"paymentMethod_6":{"type":"string"},"paymentMethod_7":{"type":"string"},"paymentMethod_8":{"type":"string"},"paymentMethod_9":{"type":"string"},"paymentMethod_10":{"type":"string"}}},"AMLEvaluationRiskDetails":{"type":"object","properties":{"type":{"type":"string"},"point":{"type":"integer","format":"int32"}}},"EvaluationDetails":{"type":"object","properties":{"evaluation":{"type":"integer","format":"int32"},"since":{"type":"string","format":"date-time"},"until":{"type":"string","format":"date-time"},"decision":{"type":"string"},"riskEvaluationDetailsList":{"type":"array","items":{"$ref":"#/components/schemas/AMLEvaluationRiskDetails"}}}},"MandateDetails":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"documentUUID":{"type":"string","format":"uuid"},"iban":{"type":"string"},"bic":{"type":"string"},"name":{"type":"string"},"reference":{"type":"boolean"},"creationTimeStamp":{"type":"string","format":"date-time"},"validationTimeStamp":{"type":"string","format":"date-time"},"deletionTimeStamp":{"type":"string","format":"date-time"},"state":{"type":"string"},"blocked":{"type":"boolean"},"remaining":{"type":"integer","format":"int32"}}},"CompanyProfileDetails":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64"},"name":{"type":"string"},"dbaName":{"type":"string"},"businessModelDescription":{"type":"string"},"creationDate":{"type":"string","format":"date"},"identificationNumber":{"type":"string"},"logo":{"type":"string"},"smallLogo":{"type":"string"},"publicListed":{"type":"boolean"},"defaultAddress":{"$ref":"#/components/schemas/AddressDetails"},"billingAddress":{"$ref":"#/components/schemas/AddressDetails"},"monthlyTurnOver":{"type":"integer","format":"int64"},"mccList":{"type":"array","items":{"$ref":"#/components/schemas/MccResponse"}},"websites":{"type":"array","items":{"type":"string"}}}},"IntegrationDetails":{"type":"object","properties":{"invoiceIntegratorListItem":{"$ref":"#/components/schemas/CompanyListItem"},"transferIntegratorListItem":{"$ref":"#/components/schemas/CompanyListItem"},"invoiceIntegrator":{"type":"boolean"},"invoiceIntegrationClients":{"type":"array","items":{"$ref":"#/components/schemas/CompanyListItem"}},"transferIntegrationClients":{"type":"array","items":{"$ref":"#/components/schemas/CompanyListItem"}},"peppolIntegrator":{"type":"boolean"}}},"ContactPersonItem":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"}}},"MccResponse":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"description":{"type":"string"}}},"CompanyListItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"registrationDate":{"type":"string","format":"date-time"},"validationTimeStamp":{"type":"string","format":"date-time"},"pack":{"type":"string"},"activationStatus":{"type":"string"},"idCompanyProfile":{"type":"integer","format":"int64"},"name":{"type":"string"},"vatNumber":{"type":"string"},"identificationNumber":{"type":"string"},"login":{"type":"string"},"deletedUser":{"type":"boolean"},"emitterStatus":{"type":"string"},"canIntegrate":{"type":"boolean"},"contactPerson":{"$ref":"#/components/schemas/ContactPersonItem"},"validationCheckState":{"type":"string"},"evaluation":{"type":"integer","format":"int32"}}},"ValidationResultDetails":{"type":"object","properties":{"valid":{"type":"boolean"},"name":{"type":"string"},"comment":{"type":"string"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ValidationTestReasonResultDetails"}}}},"ValidationTestReasonResultDetails":{"type":"object","properties":{"valid":{"type":"boolean"},"reason":{"type":"string"},"textClient":{"type":"string"},"textOcr":{"type":"string"},"comment":{"type":"string"},"document":{"$ref":"#/components/schemas/DocumentDetails"}}},"TimeBasedTransferPayment":{"type":"object","properties":{"communication":{"type":"string","description":"Communication associated with this payment","example":"commission"},"percentage":{"type":"number","description":"Percentage of the trusted payment that will be transferred to this creditor. Default is 100. The percentage can contain at most 6 numbers behind the decimal point","example":100},"creditorIBAN":{"type":"string","description":"IBAN value of the creditor on which the the amount will be wired when the minimum requirements are met.","example":"BE40251230861709"}},"required":["creditorIBAN"]},"ConfirmationBasedTransferPaymentUpdate":{"type":"object","properties":{"reference":{"type":"string","description":"The reference of the transfer payment to update","example":"Ref1234"},"subReference":{"type":"string","description":"The reference of the sub transfer payment to add if any (used to reference a partial payout)","example":"Ref1234 1/2"},"amountInCents":{"type":"integer","format":"int64","description":"The updated amount of the payment in cents. The currency is EUR.","example":5000000},"communication":{"type":"string","description":"The updated communiation to be used in this transfer. If no communication or a null communication are provided, the previous communication is kept.","example":"A new communication"},"creditorIBAN":{"type":"string","description":"The IBAN of the creditor account. If no IBAN is provided, the creditor will not be updated.","example":"BE01234567890123"}},"required":["amountInCents","reference"]},"Sector":{"type":"object","properties":{"type":{"type":"string","description":"Type of sector","enum":["AGRIBUSINESS","BANK","WOOD","CONSTRUCTION","CHEMISTRY","TRADE","PUBLISHING","ELECTRONICS","STUDIES","PHARMACEUTICAL","COMPUTER","MACHINERY","METALLURGY","PLASTIC","LIBERAL_PROFESSION","BUSINESS_SERVICES","TEXTILE","TRANSPORT","TRADING_ON_INTERNET","HORECA","CARWASH","USED_PARTS","PHONE_SHOP","ART_SALES","DIAMONDS","ENERGY","TELECOM","E_GAMING","GAMES_CHANCE","LAWYER","ACCOUNTANT","DOCTOR","TAXIS","ARCHITECT","BAILIFF","NOTARY","EDUCATION","HEALTH","PUBLIC","RETIREE","OTHER"],"example":"STUDIES"},"details":{"type":"string","description":"The name of the sector if OTHER was chosen or details about the chosen sector.","example":"Part-time"}},"required":["type"]},"ContractApproval":{"type":"object","properties":{"userAgent":{"type":"string","description":"User agent of the customer when he approved the contracts","example":"Mozilla/5.0 (Linux; Android 7.0; SM-G892A Build/NRD90M; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/60.0.3112.107 Mobile Safari/537.36"},"ipAddress":{"type":"string","description":"IP address of the customer when he approved the contracts"},"approvalDate":{"type":"string","format":"date","description":"The date when the customer approved the Digiteal contracts. The expected format is YYYY-MM-DD","example":"2019-11-30"}},"required":["approvalDate","ipAddress","userAgent"]},"CustomerNotificationSettings":{"type":"object","properties":{"issuer":{"type":"boolean","description":"Should we notify the user when he has a new issuer (true by default)","example":true},"autoPayment":{"type":"boolean","description":"Should we notify the user when an autopayment was performed  (true by default)","example":true},"autoPaymentThreshold":{"type":"boolean","description":"Should we notify the user when an autopayment was not performed because it was above the threshold (true by default)","example":true},"paymentIssue":{"type":"boolean","description":"Should we notify the user when a payment issue occurred (true by default)","example":true},"push":{"type":"boolean","description":"Should we notify the user through push notifications (if he has installed the Digiteal app, true by default)","example":true},"mail":{"type":"boolean","description":"Should we notify the user through email notifications (true by default)","example":true}}},"PersonKYCInfo":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the person","example":"John"},"lastName":{"type":"string","description":"Last name of the person","example":"Doe"},"pep":{"type":"boolean","description":"Is the person politically exposed ?","example":true},"pepCustomerExplanation":{"type":"string","description":"How is the person politically exposed ? This explanation should be provided only if the person is politically exposed.","example":"Prime minister of New Zeland"},"birthDay":{"type":"string","format":"date","description":"The date the person was born. The person should be at least 16 years old. The expected format is YYYY-MM-DD.","example":"1990-12-31"},"birthPlace":{"type":"string","description":"The place where the person was born (city and country).","example":"Cook, NZ"},"gender":{"type":"string","description":"The gender of the person: MALE, FEMALE, UNKNOWN or NA","enum":["MALE","FEMALE","UNKNOWN","NA"],"example":"MALE"},"email":{"type":"string","description":"Email address of the person","example":"john.doe@gmail.com"},"language":{"type":"string","description":"Language of the person. Authorized values are EN, FR, NL. Default value is 'EN'","example":"EN"},"integratorVATNumber":{"type":"string","description":"The VAT number of the invoice/payment integrator of this person if any. This value is overridden by the integratorIdentificationNumber so use one or the other.","example":"BE0000000097"},"integratorIdentificationNumber":{"type":"string","description":"Identification number of the invoice/payment integrator of this person if any. This value overrides the integratorVATNumber so use one or the other (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"digitrustIntegratorVATNumber":{"type":"string","description":"The VAT number of the DigiTrust integrator of this person if any. This value is overridden by the digitrustIntegratorIdentificationNumber so use one or the other.","example":"BE0000000097"},"digitrustIntegratorIdentificationNumber":{"type":"string","description":"Identification number of the DigiTrust integrator of this person if any. This value overrides the digitrustIntegratorVATNumber so use one or the other (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"ibans":{"type":"array","description":"IBANs of the bank accounts associated to the person. You must have verified that the person has access to these IBANs. If you are not sure, provide them in the ibansToValidate property.","items":{"type":"string"}},"ibansToValidate":{"type":"array","description":"IBANs of the bank accounts associated to the person. You do not need to have verified that the person has access to these IBANs, Digiteal will take care of that. If you are sure, provide them in the ibans property.","items":{"type":"string"}},"sectors":{"type":"array","description":"Sectors where the person is active","items":{"$ref":"#/components/schemas/Sector"}},"nationalities":{"type":"array","description":"Nationalities of the person. The nationalities are represented by the two letter country codes as defined in ISO 3166-1 alpha-2.","items":{"type":"string"}},"address":{"$ref":"#/components/schemas/AddressDetails","description":"Address of residence of the person"},"idDocumentValidityEnd":{"type":"string","format":"date","description":"Date of the end of validity of the provided id documents of the person","example":"2030-12-31"},"phoneNumber":{"type":"string","description":"Phone number","example":"+3247777777"}},"required":["email"]},"BasicPersonKYCInfo":{"type":"object","properties":{"firstName":{"type":"string","description":"First name of the person","example":"John"},"lastName":{"type":"string","description":"Last name of the person","example":"Doe"},"pep":{"type":"boolean","description":"Is the person politically exposed ?","example":true},"pepCustomerExplanation":{"type":"string","description":"How is the person politically exposed ? This explanation should be provided only if the person is politically exposed.","example":"Prime minister of New Zeland"},"birthDay":{"type":"string","format":"date","description":"The date the person was born. The person should be at least 16 years old. The expected format is YYYY-MM-DD.","example":"1990-12-31"},"birthPlace":{"type":"string","description":"The place where the person was born (city and country).","example":"Cook, NZ"},"gender":{"type":"string","description":"The gender of the person: MALE, FEMALE, UNKNOWN or NA","enum":["MALE","FEMALE","UNKNOWN","NA"],"example":"MALE"}}},"TerminalInfo":{"type":"object","properties":{"deviceBrand":{"type":"string","description":"Terminal's brand. If your brand is not activated, contact support@digiteal.eu","enum":["PAYTER","NEXGO","PAX","MINESEC"],"example":"NEXGO","minLength":1},"deviceModel":{"type":"string","description":"If your model is not activated, contact support@digiteal.eu","enum":["N6","N62","N86","N96","APOLLO","A920_PRO","IM30","A35","SOFTPOS","UN20"],"example":"N6","minLength":1,"title":"Terminal's model"},"iban":{"type":"string","description":"Terminal's associated iban. If field left empty, the company default iban will be used"}},"required":["deviceBrand","deviceModel"]},"CompanyKYCInfo":{"type":"object","properties":{"vatNumber":{"type":"string","description":"VAT number of the company (either Vat number or Identification number should be provided)","example":"BE0000000097"},"identificationNumber":{"type":"string","description":"Identification number of the company (either Vat number or Identification number should be provided) (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"companyName":{"type":"string","description":"Name of the company","example":"Your Telecom"},"companyDbaName":{"type":"string","description":"DBA name of the company","example":"Your Telecom"},"businessDescription":{"type":"string","description":"Business model description","example":"My business description"},"monthlyTurnOver":{"type":"integer","format":"int64","description":"Monthly turn over","example":1000},"website":{"type":"string","description":"Website","example":"www.example.com"},"creationDate":{"type":"string","format":"date","description":"The date when the company was created. The expected format is YYYY-MM-DD","example":"2012-12-31"},"contactPerson":{"$ref":"#/components/schemas/PersonKYCInfo","description":"Contact person of the company. This person must have the right to register the company in Digiteal. This person must either represent the company or have a delegation of power to register the company."},"integratorVATNumber":{"type":"string","description":"The VAT number of the invoice/payment integrator of this company if any. This value is overridden by the integratorIdentificationNumber so use one or the other.\", exampl","example":"BE0000000097"},"integratorIdentificationNumber":{"type":"string","description":"Identification number of the invoice/payment integrator of this company if any. This value overrides the integratorVATNumber so use one or the other (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"digitrustIntegratorVATNumber":{"type":"string","description":"The VAT number of the DigiTrust integrator of this company if any. This value is overridden by the digitrustIntegratorIdentificationNumber so use one or the other.","example":"BE0000000097"},"digitrustIntegratorIdentificationNumber":{"type":"string","description":"Identification number of the DigiTrust integrator of this company if any. This value overrides the digitrustIntegratorVATNumber so use one or the other (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"pack":{"type":"string","description":"The pack chosen by the company to register. The DISCOVER pack is free but it does not enable collecting funds. The first pack to enable collecting funds is the START pack.","enum":["DISCOVER","START","GO","POC","UNKNOWN"],"example":"START"},"settlementGrouping":{"type":"string","description":"Settlement grouping strategy. This defines how the funds should be settled to the bank account of the creditor. PER_TX means that each transactions leads to a specific settlement. You will then have one line in your bank statement per transaction. PER_DAY, PER_WEEK and PER_MONTH means that the settlements will be grouped per day/week/month. Default is PER_TX.","enum":["PER_TX","PER_DAY","PER_WEEK","PER_MONTH"],"example":"PER_TX"},"address":{"$ref":"#/components/schemas/AddressDetails","description":"The main address of the company."},"sectors":{"type":"array","description":"Sectors where the company is active","items":{"$ref":"#/components/schemas/Sector"}},"ubos":{"type":"array","description":"The UBOs of the company","items":{"$ref":"#/components/schemas/BasicPersonKYCInfo"}},"ibans":{"type":"array","description":"IBANs of the bank accounts associated to the company. You must have verified that the company has access to these IBANs. If you are not sure, provide them in the ibansToValidate property.","items":{"type":"string"}},"ibansToValidate":{"type":"array","description":"IBANs of the bank accounts associated to the company. You do not need to have verified that the company has access to these IBANs, Digiteal will take care of that. If you are sure, provide them in the ibans property.","items":{"type":"string"}},"paymentMethods":{"type":"array","description":"Payment methods to activate. If you wish to activate PIS_STANDARD (PSD2 payment initiation), VISA, MASTERCARD, CARTE_BLEUE, MAESTRO or PAYCONIQ, please contact support@digiteal.eu. By default, only DIGITEAL_STANDARD is actvated.","items":{"type":"string","enum":["BANCONTACT","CARTE_BLEUE","IDEAL","MAESTRO","MASTERCARD","PAYCONIQ","DIGITEAL_STANDARD","VISA","GOOGLE_PAY","PIS_STANDARD","PIS_PREMIUM","PIS_PREMIUM_INSTANT","APPLE_PAY"]}},"terminals":{"type":"array","description":"Terminal information to activate","items":{"$ref":"#/components/schemas/TerminalInfo"}}},"required":["companyDbaName","companyName","contactPerson","identificationNumber","vatNumber"]},"ValidationResultResponse":{"type":"object","properties":{"specVersion":{"type":"string","description":"Version of the spec used for validation","example":"3.0.18"},"status":{"type":"string","description":"Error code","enum":["OK","WARNING","ERROR"]},"errors":{"type":"array","description":"Errors","items":{"$ref":"#/components/schemas/ValidationError"}},"warnings":{"type":"array","description":"Warnings","items":{"$ref":"#/components/schemas/ValidationError"}}},"required":["specVersion","status"]},"ValidationError":{"type":"object","properties":{"id":{"type":"string","description":"ID of the error","example":"PEPPOL-EN16931-R003"},"fieldName":{"type":"string","description":"Field name related to the error","example":"/*:Invoice[namespace-uri()='urn:oasis:names:specification:ubl:schema:xsd:Invoice-2'][1]"},"location":{"type":"string","description":"Location of the error in the file","example":"invoice.xml line 20 column 165"},"description":{"type":"string","description":"Textual description of the error","example":"A buyer reference or purchase order reference MUST be provided."},"level":{"type":"string","description":"Level of the error","example":"FATAL_ERROR"},"test":{"type":"string","description":"Test in error","example":"cbc:BuyerReference or cac:OrderReference/cbc:ID"},"linkedExceptionMessage":{"type":"string","description":"Linked exception message","example":"net.sf.saxon.trans.XPathException: A function that computes atomic values should use xsl:sequence rather than xsl:value-of"}}},"Code":{},"MarketplaceContributionRefund":{"type":"object","properties":{"contributorIban":{"type":"string","description":"Iban of the creditor used to retrieve the funds. Must be identical to the Iban used in the payment to the creditor.","example":"BE40251230861709"},"amountInCents":{"type":"string","description":"Amount to be refunded. The default value is the full amount of the payment to the creditor.","example":1234},"currency":{"type":"string","default":"EUR","description":"The currency of the amount to be refunded based on the ISO 4217-alpha standard. The default value is EUR","example":"EUR"},"communication":{"type":"string","description":"Communication of the refund payment specific for the creditor.","example":"Refund from payment {transfer payment subject} of {date} from {debtor}"},"reference":{"type":"string","description":"Identifier of the payment to the creditor to be refunded"}},"required":["contributorIban"]},"PaymentRequest":{"type":"object","properties":{"paymentRequestId":{"type":"string","format":"uuid","deprecated":true,"description":"Payment request identifier","example":"8081e5f6-2c29-4e5e-8d22-42a4321e3101"},"paymentInternalId":{"type":"string","description":"Identification of the payment used for your reference (as defined by the creditor)","example":"customReference"},"customerInternalId":{"type":"string","description":"Identification of the customer (as defined by the creditor)","example":"client1234"}},"required":["paymentRequestId"]},"Invoice":{"type":"object","properties":{"invoiceId":{"type":"string","format":"uuid","description":"Invoice identifier","example":"8081e5f6-2c29-4e5e-8d22-42a4321e3101"},"clientId":{"type":"string","description":"Client identifier","example":34},"dueDate":{"type":"string","format":"date","description":"Due date","example":"2019-06-15","pattern":"yyyy-MM-dd"}},"required":["clientId","invoiceId"]},"Transfer":{"type":"object","properties":{"transferId":{"type":"string","format":"uuid","description":"Transfer identifier","example":"8081e5f6-2c29-4e5e-8d22-42a4321e3101"},"parentPaymentId":{"type":"string","format":"uuid","description":"Parent payment identifier","example":"b229f8b4790f11e7b5a5be2e44b06b55"},"requestorIdentificationNumber":{"type":"string","description":"Requestor identification number\n[Format](https://docs.digiteal.eu/technical/index.html#company_national_identifiers)","example":"BE:VAT:BE0000000097"},"reference":{"type":"string","description":"Custom reference","example":"CustomReference"}},"required":["requestorIdentificationNumber"]},"Terminal":{"type":"object","properties":{"requestId":{"type":"string","description":"Request id"},"subMerchantId":{"type":"string","description":"Sub-merchant id"},"posDeviceId":{"type":"string","description":"Terminal id"}}},"PaymentRequestInformation":{"type":"object","properties":{"paymentID":{"type":"string","description":"The unique identifier of the payment known by the requester","example":"e529f8b4790f11e7b5a5be2e44b06b52"},"destinationBankAccount":{"type":"string","description":"The IBAN to which the payment has been executed","example":"BE41816373160590"},"requestorID":{"type":"integer","format":"int64","description":"The id of the requester that issued the invoice","example":12},"requestorVAT":{"type":"string","description":"The VAT number of the requester that issued the invoice","example":"BE0000000097"},"requestorNationalIdentifier":{"type":"string","description":"The national identifier of the requester that issued the invoice","example":"BE:VAT:BE0000000097"},"clientID":{"type":"string","description":"Client id (known to the requestor) of the person","example":34},"amountInCents":{"type":"integer","format":"int64","description":"The amount of the invoice in cents","example":1234},"currency":{"type":"string","description":"The currency of the payment (ISO 4217 Currency Codes)","example":"EUR"},"paymentRequestDate":{"type":"string","description":"The date on which the invoice has been sent","example":"2019-05-31"},"paymentRequestDuedate":{"type":"string","description":"The due date of the invoice","example":"2019-06-15"},"purpose":{"type":"string","description":"The purpose based on the ISO 20022 standard","example":"GDDS"},"creditorReference":{"type":"string","description":"The reference used by the biller to reconcile the payment. This is also called the structured communication in Belgium. It can be left empty if the remittanceInfo is defined","example":"000600232562"},"remittanceInfo":{"type":"string","description":"An unstructured string that is used as communication in the payment. This information is only used if there is nol creditorReference. It can be left empty if the creditorReference is defined","example":"Invoice1234"},"paymentInternalId":{"type":"string","description":"The internal identifier of the payment as known by the creditor","example":"Payment1234"}},"required":["amountInCents","clientID","currency","destinationBankAccount","paymentID","requestorID","requestorNationalIdentifier"]},"TrustedPaymentContribution":{"type":"object","properties":{"amountInCents":{"type":"integer","format":"int64","description":"Amount expressed in cents that has to be paid. If this is not provided for a confirmation-based trusted payment, the total amount of the trusted payment will be requested.","example":1234},"transferId":{"type":"string","format":"uuid","description":"Uuid of the trusted payment as determined by Digiteal. If this value is used the creditor reference(s) are ignored.","example":"e529f8b4790f11e7b5a5be2e44b06b52"}}},"PaymentCard":{"type":"object","description":"Payment card","properties":{"maskedNumber":{"type":"string","description":"Masked card number","example":"4001********7193"},"validityMonth":{"type":"string","description":"Card validity month","example":12},"validityYear":{"type":"string","description":"Card validity year","example":24},"scheme":{"type":"string","description":"Card scheme","enum":["VISA","MASTERCARD","MAESTRO","CARTE_BLEUE"],"example":"VISA"},"type":{"type":"string","description":"Card type","enum":["DEBIT","CREDIT"],"example":"DEBIT"},"brand":{"type":"string","description":"Card brand","example":"Visa Classic"},"product":{"type":"string","description":"Credit card product (CONSUMER or CORPORATE)","enum":["CONSUMER","CORPORATE"],"example":"CONSUMER"}},"required":["maskedNumber","scheme","validityMonth","validityYear"]},"PaymentCardTokenCustomer":{"type":"object","description":"Cardholder details","properties":{"name":{"type":"string","description":"Cardholder's full name. Should contains first and last name of the cardholder.\nRequired if this information was not provided at PKey creation or if the 3dsConfig is defined.","example":"John Doe","maxLength":255,"minLength":0},"emailAddress":{"type":"string","format":"email","description":"Cardholder's email.\n Required if the 3dsConfig is defined.","example":"john@doe.com","maxLength":255,"minLength":0},"streetNumber":{"type":"string","description":"Cardholder's address street number","example":6,"maxLength":255,"minLength":0},"streetName":{"type":"string","description":"Cardholder's address street name","example":"Rue Email Francqui","maxLength":255,"minLength":0},"city":{"type":"string","description":"Cardholder's address city name","example":"Mont-Saint-Guibert","maxLength":255,"minLength":0},"countryCode":{"type":"string","format":"iso-3166-2","description":"Cardholder's address country code","example":"BE"}}},"Config3ds":{"type":"object","description":"[3D secure](https://digiteal.readme.io/docs/card-token#3d-secure) configuration\nRequired if not MIT","properties":{"redirectUrl":{"type":"string","format":"uri","description":"Url to redirect to after the 3DS challenge completion","example":"https://redirecturl.com","maxLength":255,"minLength":0},"language":{"type":"string","format":"bcp-47","description":"Display language for the 3DS challenge web page","example":"fr-FR"},"ipAddress":{"type":"string","format":"ipv4","description":"IP address of the customer's device","example":"192.0.2.146","maxLength":255,"minLength":0},"userAgent":{"type":"string","description":"User agent of the customer's device","example":"Browser","maxLength":255,"minLength":0},"fingerPrintStatus":{"type":"string","description":"Status of the fingerprint request at PKey creation. Required only if the token is a PKey.","enum":["NOT_REQUIRED","REQUIRED_ASKED","REQUIRED_NOT_ASKED"],"example":"NOT_REQUIRED"}},"required":["ipAddress","language","redirectUrl","userAgent"]},"Config3dsToken":{"type":"object","description":"[3D secure](https://digiteal.readme.io/docs/card-token#3d-secure) configuration","properties":{"redirectUrl":{"type":"string","format":"uri","description":"Url to redirect to after the 3DS challenge completion","example":"https://redirecturl.com","maxLength":255,"minLength":0},"language":{"type":"string","format":"bcp-47","description":"Display language for the 3DS challenge web page","example":"fr-FR"},"ipAddress":{"type":"string","format":"ipv4","description":"IP address of the customer's device","example":"192.0.2.146","maxLength":255,"minLength":0},"userAgent":{"type":"string","description":"User agent of the customer's device","example":"Browser","maxLength":255,"minLength":0},"fingerPrintStatus":{"type":"string","description":"Status of the fingerprint request at PKey creation","enum":["NOT_REQUIRED","REQUIRED_ASKED","REQUIRED_NOT_ASKED"],"example":"NOT_REQUIRED"}},"required":["fingerPrintStatus","language","redirectUrl"]},"BulkEntry":{"type":"object","properties":{"payment":{"$ref":"#/components/schemas/Payment","description":"Payment details"},"paymentRequest":{"$ref":"#/components/schemas/PaymentRequest","description":"Payment request details"},"invoice":{"$ref":"#/components/schemas/Invoice","description":"Invoice details"},"transfer":{"$ref":"#/components/schemas/Transfer","description":"Transfer details"},"type":{"type":"string","description":"Entry type","enum":["PAYOUT","REFUND"],"example":"PAYOUT"},"direction":{"type":"string","description":"Entry direction","enum":["DEBIT","CREDIT"],"example":"CREDIT"}},"required":["direction","payment","type"]},"Address":{"type":"object","properties":{"streetNumber":{"type":"string","description":"Debtor's address street number","example":6,"maxLength":50,"minLength":0},"streetName":{"type":"string","description":"Debtor's address street name","example":"Rue Emile Francqui","maxLength":255,"minLength":0},"city":{"type":"string","description":"Debtor's address city","example":"Mont-Saint-Guibert","maxLength":50,"minLength":0},"postCode":{"type":"string","description":"Debtor's address post code","example":1435,"maxLength":10,"minLength":0},"country":{"type":"string","format":"iso-3166-2","description":"Debtor's address country","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW","ZZ"],"example":"BE"}},"required":["city","country","postCode","streetName","streetNumber"]},"Debtor":{"type":"object","properties":{"firstName":{"type":"string","description":"Debtor's first name","example":"John","maxLength":50,"minLength":0},"lastName":{"type":"string","description":"Debtor's last name","example":"Doe","maxLength":50,"minLength":0},"language":{"type":"string","format":"bcp-47","description":"Debtor's language","example":"fr-BE"},"iban":{"type":"string","format":"iban","description":"Debtor's iban","example":"BE40251230861709"},"address":{"$ref":"#/components/schemas/Address","description":"Debtor's address"}},"required":["firstName","language","lastName"]},"Creditor":{"type":"object","properties":{"vatNumber":{"type":"string","description":"Creditor's vat number","example":"BE0630675588"},"name":{"type":"string","description":"Creditor's full name","example":"Digiteal","maxLength":255,"minLength":0},"iban":{"type":"string","format":"iban","description":"Creditor's iban","example":"BE40251230861709"},"sddCreditorIdentifier":{"type":"string","description":"Creditor's SDD identifier","example":"BE53ZZZ0630675588","maxLength":255,"minLength":0}},"required":["name","sddCreditorIdentifier"]},"RedirectUrl":{"type":"object","properties":{"successUrl":{"type":"string","format":"uri","example":"https://success.com"},"failureUrl":{"type":"string","format":"uri","example":"https://failure.com"},"errorUrl":{"type":"string","format":"uri","example":"https://error.com"},"cancelUrl":{"type":"string","format":"uri","example":"https://cancel.com"}}},"CustomerInfo":{"type":"object","properties":{"vatNumber":{"type":"string","description":"VAT number of the supplier company. If it is not provided, the requester will be considered the supplier of the person/company to register.","example":"BE0000000097"},"customerId":{"type":"string","description":"Identifier of the customer used in the company","example":"Customer1234"},"product":{"type":"string","description":"Product for which this pre-registration is initiated. Default is INVOICING.","enum":["INVOICING, PAYMENT, DIGITRUST, PEPPOL, TERMS_TECH, ZOFINANCIALS"],"example":"INVOICING"},"notificationSettings":{"$ref":"#/components/schemas/CustomerNotificationSettings","description":"Notification settings for this customer (these will be used only if this is a new user of Digiteal)"},"welcomeMessage":{"type":"string","description":"Specific welcome message that will be sent by email. Please be careful to send a message in the language of the customer.","example":"YourTelecom invites you to use Digiteal to pay all your invoices in one click."},"returnURL":{"type":"string","description":"Defines the url where Digiteal has to redirect the user when the customer has set his password. Maximum length of 255 characters.","example":"https://www.myportal.com/digitealRegistrationConfirmed"},"complete":{"type":"boolean","description":"Defines if the pre-registration contains enough data to be evaluated by Digiteal's compliance dept. Default value is true. The evaluation will only take place if the contract approval data is provided.","example":true}},"required":["customerId"]},"Identifier":{"type":"object","description":"The identifier (legal entity only). The name or the identifier must be present, and are mutually exclusive.","properties":{"type":{"type":"string","description":"The identifier type of the account holder. Can be LEI, BIC, or an [ISO 20022 ExternalOrganisationIdentification1Code type](https://www.iso20022.org/catalogue-messages/additional-content-messages/external-code-sets):  * `LEI`: Legal Entity Identifier  * `BIC`: Bank Identifier Code  * `BANK`: Bank Party Identification  * `BDID`: Business Domain Identifier  * `BOID`: Business Other Identification  * `CBID`: Central Bank Identification Number  * `CHID`: Clearing Identification Number  * `CINC`: Certificate of Incorporation Number  * `COID`: Country Identification Code  * `CUST`: Customer Number  * `DUNS`: Data Universal Numbering System  * `EMPL`: Employer Identification Number  * `GS1G`: GS1GLN Identifier  * `SREN`: SIREN  * `SRET`: SIRET  * `TXID`: Tax Identification Number (VAT) ","enum":["LEI","BIC","BANK","BDID","BOID","CBID","CHID","CINC","COID","CUST","DUNS","EMPL","GS1G","SREN","SRET","TXID"],"example":"LEI"},"value":{"type":"string","description":"The identifier number of the account holder.","example":"9845000A44AB9CA606059845000A44AB9CA60605","maxLength":256,"minLength":1}},"required":["type","value"]},"VopMatchResult":{"type":"object","description":"Result of the Verification of Payee (VoP) performed on the account holder.","properties":{"result":{"type":"string","description":"The result of the VoP check.  * `MATCH`: your request matches perfectly the holder of the account  * `CLOSE_MATCH`: your request matches almost the holder of the account (name match only)  * `NO_MATCH`: your request does not match the holder of the account  * `VOP_NOT_SUPPORTED`: the account holder bank does not support VoP requests  * `ERROR`: an error has occured and we were not able to perform  the VoP request ","enum":["MATCH","CLOSE_MATCH","NO_MATCH","NO_AP","VOP_NOT_SUPPORTED","ERROR"],"example":"CLOSE_MATCH"}},"required":["result"]},"BankAccountHolder":{"type":"object","description":"Details of the verified account holder. Provided on a 'MATCH' or 'CLOSE_MATCH'.","properties":{"name":{"type":"string","description":"The actual or corrected account holder name.","example":"Jan Peeters","maxLength":140,"minLength":0},"identifier":{"$ref":"#/components/schemas/Identifier"}}},"BankDetails":{"type":"object","description":"Details of the account holder's bank.","properties":{"bic":{"type":"string","description":"The Business Identifier Code (BIC) of the account holder's bank.","example":"GEBABEBB","pattern":"^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$"},"name":{"type":"string","description":"The name of the account holder's bank.","example":"BNP Paribas Fortis"}}},"Browser":{"type":"object","properties":{"javaScriptEnabled":{"type":"boolean"},"javaEnabled":{"type":"boolean"},"cookiesEnabled":{"type":"boolean"},"language":{"type":"string"},"screenColorDepth":{"type":"string"},"screenHeight":{"type":"string"},"screenWidth":{"type":"string"},"timeZone":{"type":"string"},"userAgent":{"type":"string"},"platform":{"type":"string"}}},"PaymentData":{"type":"object","properties":{"gateway":{"type":"string"},"payload":{"type":"string"}}},"Contact":{"type":"object","properties":{"gender":{"type":"string","enum":["UNKNOWN","MALE","FEMALE","NA"]},"firstName":{"type":"string","maxLength":250,"minLength":0},"lastName":{"type":"string","maxLength":250,"minLength":0},"birthDate":{"type":"string","format":"date"},"nationalities":{"type":"array","items":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW","ZZ"]}},"idValidityDate":{"type":"string","format":"date"},"pep":{"$ref":"#/components/schemas/Pep"}}},"Ubo":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"birthDate":{"type":"string","format":"date"},"birthPlace":{"type":"string"},"pep":{"type":"boolean"}}},"Pep":{"type":"object","properties":{"exposed":{"type":"boolean"},"reason":{"type":"string","maxLength":250,"minLength":0}}},"Company":{"type":"object","properties":{"contact":{"$ref":"#/components/schemas/Contact"},"address":{"$ref":"#/components/schemas/Address"},"sectors":{"type":"array","items":{"$ref":"#/components/schemas/Sector"}},"ubos":{"type":"array","items":{"$ref":"#/components/schemas/Ubo"}},"pack":{"type":"string","enum":["DISCOVER","START","GO","POC","UNKNOWN"]},"statusOnline":{"type":"boolean"}}},"Link":{"type":"object","properties":{"rel":{"type":"string"},"href":{"type":"string"},"hreflang":{"type":"string"},"media":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"deprecation":{"type":"string"},"profile":{"type":"string"},"name":{"type":"string"}}},"EntityModelIssuerDetails":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","minLength":1},"language":{"type":"string","enum":["FR","EN","ES","NL","DE"]},"logo":{"type":"string"},"smallLogo":{"type":"string"},"vatNumber":{"type":"string"},"identificationNumber":{"type":"string","minLength":1},"streetName":{"type":"string"},"houseNumber":{"type":"string"},"zipCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"bankAccountDetails":{"type":"array","items":{"$ref":"#/components/schemas/BankAccountDetails"}},"status":{"type":"string","enum":["NONE","PROD","ONHOLD","ONHOLD_PEPPOL","MERGED"]},"validationCheckState":{"type":"string","enum":["PENDING","RENEWED","OK","FAILED","NONE","EXPIRED","DELETED"]},"userDetails":{"$ref":"#/components/schemas/EmitterUserDetails"},"hasNewOptins":{"type":"boolean"},"pack":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}},"required":["identificationNumber","name"]},"PageMetadata":{"type":"object","properties":{"size":{"type":"integer","format":"int64"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int64"},"number":{"type":"integer","format":"int64"}}},"CustomerDetails":{"type":"object","properties":{"name":{"type":"string"},"firstName":{"type":"string"},"vat":{"type":"string"},"email":{"type":"string"},"mobilePhoneNumber":{"type":"string"},"id":{"type":"string"},"addressDetails":{"$ref":"#/components/schemas/AddressDetails"},"empty":{"type":"boolean"}}},"EntityModelSendInvoiceDetails":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"dateReceived":{"type":"string"},"dueDate":{"type":"string"},"expired":{"type":"boolean"},"internalId":{"type":"string"},"customer":{"$ref":"#/components/schemas/CustomerDetails"},"status":{"type":"string"},"amount":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"EntityModelInvoiceMinimalDetails":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"emitterName":{"type":"string"},"emitterLogo":{"type":"string"},"emitterSmallLogo":{"type":"string"},"amount":{"type":"string"},"status":{"type":"string"},"dueDate":{"type":"string"},"digitealCreationDate":{"type":"string"},"digitealPublicationDate":{"type":"string"},"remaining":{"type":"integer","format":"int64"},"read":{"type":"boolean"},"scheduled":{"type":"boolean"},"paymentDate":{"type":"string"},"communication":{"type":"string"},"expired":{"type":"boolean"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"PaymentChartPoint":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"date":{"type":"string"}}},"EntityModelAutoPayConfig":{"type":"object","properties":{"customerInternalID":{"type":"string"},"emitterName":{"type":"string"},"bankAccount":{"$ref":"#/components/schemas/BankAccountSelection"},"configID":{"type":"string","format":"uuid"},"customerID":{"type":"integer","format":"int64"},"treshold":{"type":"number","format":"double"},"emitterID":{"type":"integer","format":"int64"},"emitterLogo":{"type":"string"},"periodicity":{"type":"string","enum":["MONTH","TRIMESTER","SEMESTER","YEAR"]},"executionType":{"type":"string","enum":["IMMEDIATE","ONE_WEEK_BEFORE_DUE_DATE","DUE_DATE"]},"status":{"type":"string","enum":["WAITING_FOR_KYC","SUSPENDED","DELETED","ACTIVE"]},"transferId":{"type":"string","format":"uuid"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"OptinAndPaymentPerMonth":{"type":"object","properties":{"date":{"type":"string"},"nbrInvoices":{"type":"integer","format":"int64"},"nbrOptins":{"type":"integer","format":"int64"},"nbrPayments":{"type":"integer","format":"int64"}}},"InvoiceDashboardDetails":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"dateReceived":{"type":"string"},"dueDate":{"type":"string"},"expired":{"type":"boolean"},"internalId":{"type":"string"},"customer":{"$ref":"#/components/schemas/CustomerDetails"},"status":{"type":"string","enum":["NOT_PUBLISHED","PAID","NOT_PAID"]},"amount":{"type":"string"}}},"PageableObject":{"type":"object","properties":{"offset":{"type":"integer","format":"int64"},"paged":{"type":"boolean"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"sort":{"$ref":"#/components/schemas/SortObject"},"unpaged":{"type":"boolean"}}},"SortObject":{"type":"object","properties":{"empty":{"type":"boolean"},"sorted":{"type":"boolean"},"unsorted":{"type":"boolean"}}},"UboDTO":{"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the UBO.","example":"Jean"},"lastName":{"type":"string","description":"The last name of the UBO","example":"Dupont"},"pepRelated":{"type":"boolean","description":"True if the UBO is a PEP or PEP related","example":false}}},"CustomerRelationshipDTO":{"type":"object","properties":{"supplierIdentificationNUmber":{"type":"string","description":"Identification number of the supplier company (see the <a href='https://docs.digiteal.eu/technical/index.html#company_national_identifiers'>company identification number documentation</a>)","example":"BE:VAT:BE0000000097"},"customerId":{"type":"string","description":"Identifier of the customer used in the company","example":"Customer1234"}},"required":["customerId","supplierIdentificationNUmber"]},"EntityModelPaymentDetails":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"requestedExecutionDate":{"type":"string"},"amount":{"type":"string"},"debtorIban":{"type":"string"},"debtorIbanName":{"type":"string"},"debtorCardNumber":{"type":"string"},"debtorLogo":{"type":"string"},"debtorType":{"type":"string","enum":["COMPANY","PERSON","UNKNOWN"]},"creditorIban":{"type":"string"},"requester":{"type":"string"},"requesterLogo":{"type":"string"},"customer":{"type":"string"},"customerID":{"type":"string"},"scheduled":{"type":"boolean"},"refundAvailable":{"type":"boolean"},"state":{"type":"string"},"stateType":{"type":"string"},"reference":{"type":"string"},"receive":{"type":"boolean"},"creditor":{"type":"boolean"},"receivedOnDigiteal":{"type":"boolean"},"paymentMethodName":{"type":"string"},"paymentInternalId":{"type":"string"},"confirmationTimeStamp":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"EntityModelCustomerSupplierView":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"logo":{"type":"string"},"smallLogo":{"type":"string"},"name":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"CompanyIdentificationNumber":{"type":"object","properties":{"representation":{"type":"string"},"extension":{"type":"string"},"vatSchemeId":{"type":"boolean"},"numberPart":{"type":"string"},"countrySpecific":{"type":"boolean"},"specificCountryCode":{"$ref":"#/components/schemas/CountryCode"}}},"BankAccount":{"type":"object","properties":{"iban":{"type":"string"},"name":{"type":"string"}}},"DocumentResponse":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"type":"string","enum":["b_doc_type_role","b_doc_type_id_card","b_doc_type_company_status","backend-code.invoice-document.type","b_doc_type_eid","b_doc_type_other","l_b2b_mandate","l_b2c_mandate","l_official_publication","l_authorized_signature","b_doc_type_passport","b_doc_type_visa","b_doc_type_driver_licence","b_doc_type_card_bank"]},"subType":{"type":"string","enum":["FRONT","BACK","FRONT_BACK","PROFILE","CERTIFICATE","UNKNOWN","OLD","RIB","BANK_SWITCHING"]},"name":{"type":"string"},"mediaType":{"type":"string"},"size":{"type":"integer","format":"int64"},"blurry":{"type":"boolean"}}},"MandateResponse":{"type":"object","properties":{"uuid":{"type":"string"},"iban":{"type":"string"},"name":{"type":"string"},"state":{"type":"string"}}},"ActivatedPaymentMethodOrderResponse":{"type":"object","properties":{"paymentMethod_1":{"type":"string"},"paymentMethod_2":{"type":"string"},"paymentMethod_3":{"type":"string"},"paymentMethod_4":{"type":"string"},"paymentMethod_5":{"type":"string"},"paymentMethod_6":{"type":"string"},"paymentMethod_7":{"type":"string"},"paymentMethod_8":{"type":"string"},"paymentMethod_9":{"type":"string"},"paymentMethod_10":{"type":"string"}}},"EntityModelInvoiceCommentDto":{"type":"object","properties":{"commentId":{"type":"string","format":"uuid"},"invoiceId":{"type":"string","format":"uuid"},"date":{"type":"string","format":"date-time"},"comment":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"SectorDetailsOutput":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"parentName":{"type":"string"},"value":{"type":"string"}}},"PaymentState":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"visible":{"type":"boolean"},"error":{"type":"boolean"},"type":{"type":"string","enum":["NOT_PAID","IN_PROGRESS","PAID","REIMBURSED","DONE"]}}},"Currency":{"type":"object","properties":{"version":{"type":"integer","format":"int32"},"id":{"type":"integer","format":"int64"},"code":{"type":"string","maxLength":10,"minLength":0},"name":{"type":"string","maxLength":250,"minLength":0}},"required":["code","name"]},"EntityModelPaymentListItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["SPR","INVOICE","TRANSFER_PAYMENT","TRANSFER","REIMBURSEMENT"]},"state":{"$ref":"#/components/schemas/PaymentState"},"creationTimeStamp":{"type":"string","format":"date-time"},"creditorName":{"type":"string"},"debtorName":{"type":"string"},"executionDate":{"type":"string","format":"date"},"communication":{"type":"string"},"amount":{"type":"number","format":"double"},"currency":{"$ref":"#/components/schemas/Currency"},"riskLevel":{"type":"integer","format":"int32"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"MandateView":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"owner":{"type":"integer","format":"int64"},"iban":{"type":"string"}}},"EntityModelAdminHistoryListItem":{"type":"object","properties":{"creationMoment":{"type":"string","format":"date-time"},"username":{"type":"string"},"description":{"type":"string"},"action":{"type":"string"},"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"PaymentIn":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"The identifier of the pay-in once it has been initiated.","example":"e529f8b4790f11e7b5a5be2e44b06b52"},"amountInCents":{"type":"integer","format":"int64","description":"The amount of the pay-in."},"currency":{"type":"string","description":"The currency of the amount to be paid based on the ISO 4217-alpha standard. The default value is EUR","example":"EUR"},"state":{"type":"string","description":"The state of the pay-in."},"confirmationTimeStamp":{"type":"string","format":"date-time","description":"Confirmation timestamp","example":"2019-05-31 17:23:45","pattern":"yyyy-MM-dd HH:mm:ss"}}},"SupportedPeppolDocumentType":{"type":"object","properties":{"type":{"type":"string","description":"Document type name","example":"INVOICE"},"fullType":{"type":"string","description":"Document type identifiers","example":"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:www.cenbii.eu:transaction:biitrns010:ver2.0:extended:urn:www.peppol.eu:bis:peppol4a:ver2.0::2.1"},"currentSpecVersion":{"type":"string","description":"Current version of the spec used for validation","example":"3.0.18"},"futureSpecVersion":{"type":"string","description":"Future version of the spec used for warnings","example":"3.0.19"}},"required":["currentSpecVersion","fullType","type"]},"PeppolParticipantBusinessEntityResponse":{"type":"object","properties":{"names":{"type":"array","description":"Participant names","items":{"$ref":"#/components/schemas/PeppolParticipantNameResponse"}},"contactPersons":{"type":"array","description":"Contact persons that you should contact in case of questions about the participant in the Peppol network","items":{"$ref":"#/components/schemas/PeppolParticipantContactPersonResponse"}},"countryCode":{"type":"string","description":"Country code"},"geographicInformation":{"type":"string","description":"Geographic information"},"registrationDate":{"type":"string","format":"date","description":"Registration date"},"additionalInformation":{"type":"string","description":"Additional information"}}},"PeppolParticipantNameResponse":{"type":"object","properties":{"name":{"type":"string","description":"Participant name","example":"Proximus"},"language":{"type":"string","format":"bcp-47","default":"en-US","description":"Language of the name","example":"fr-BE"}},"required":["language"]},"PeppolParticipantContactPersonResponse":{"type":"object","properties":{"name":{"type":"string","description":"Contact's name","example":"John Doe"},"phoneNumber":{"type":"string","description":"Contact's phone number","example":"+321234567"},"email":{"type":"string","description":"Contact's email","example":"john.doe@digiteal.eu"}},"required":["email"]},"PeppolParticipantSupportedDocumentTypeResponse":{"type":"object","properties":{"type":{"type":"string","description":"Document type name","example":"INVOICE"},"fullType":{"type":"string","description":"Document type identifiers","example":"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:www.cenbii.eu:transaction:biitrns010:ver2.0:extended:urn:www.peppol.eu:bis:peppol4a:ver2.0::2.1"}},"required":["fullType","type"]},"PeppolParticipantBusinessCardResponse":{"type":"object","properties":{"businessEntities":{"type":"array","description":"Participant's business entities","items":{"$ref":"#/components/schemas/PeppolParticipantBusinessEntityResponse"}}}}},"securitySchemes":{"basic":{"type":"http","scheme":"basic"}}}}