Riverty Logo
Riverty LogoFor Developers
Riverty Logo
Documentation
API Specification
Partner & Integrations
My Sandbox
FAQ
Home > API > Customer Account > Apply For Credit

Apply for account credit

Apply for account credit

PATH:

/api/v3/customer-account

REQUEST BODY SCHEMA:

accountLimit
required

number

Account limit

customer
required

customer object

Customer linked with this account

salutation

string

Enum:MrMrsMissDiverse

Salutation.

firstName

string <= 50 characters

First name

lastName

string <= 50 characters

Last name

customerNumber

string <= 100 characters

Customer number

organizationPersonalNo

string

Organization (if customer is organization) or personal (if customer is person) identification number

category
required

string

Enum:CompanyPerson

Customer category.

currency
required

string

Enum:EURNOKSEKDKKCHF

Customer currency

distributionBy

string

Enum:CompanyClient

Specifies who will distribute information (invoices, notices, etc.) to customer

distributionType

string

Enum:PaperEmailSms

Specifies how information (invoices, notices, etc.) will be distributed to customer

email

string

Customer email

address

address object

Customer address details

careOf

string <= 50 characters

Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.

street

string <= 100 characters

Name of street or packstation

streetNumber

string <= 10 characters

Street or packstation number

streetNumberAdditional

string <= 10 characters

Additional street number

postalCode

string <= 10 characters

Postal code

postalPlace

string <= 100 characters

Postal place

countryCode

string

Enum:NOSEFIDKDEATCHNLBE

Country code

phone

string

Customer's primary phone

directPhone

string

Customer's direct phone number (land line)

mobilePhone

string

Customer's mobile phone

firstNoticeDate

string Format: date-time

First notice date

countryCode
required

string

Enum:NOSEFIDKDEATCHNLBE

Country code

conversationLanguage
required

string

Enum:NOSVSEFIDADKENDENLFR

Conversation language. 'SE' and 'DK' are obsolete values, and will be removed in the future. Use 'SV' instead of 'SE', and 'DA' instead of 'DK'.

RESPONSES:

200 OK

RESPONSE SCHEMA:

account

account object

Created account details

accountLimit

number

Amount of granted account limit if account has limit assigned to it

accountNumber

string

Customeraccounts identifier

accountProfile

string

Identifier of a specific accountProfile

accountStatus

string

Enum:OkFirstReminderSecondReminderUnderCancelationSentToDebtCollectionClosedFromDebtCollection

Account status

balance

number

Current ledger balance

bankAccount

string

Bank account, which is linked to this account

customerId

string

Customer ID, which is linked to this account

createdAt

string Format: date-time

Date and time when account was created

isStopped

boolean

Indicates whether account is stopped or not

ocr

string

OCR (Optical Character Recognition) number bound to this account

lastNoticeDate

string Format: date-time

Date of last notice

nextNoticeDate

string Format: date-time

Date of next notice

temporaryExternalProblem

boolean

Indicates whether temporary external problem has happened during account creation or not

customer

customer object

Customer details

customerNumber

string <= 100 characters

Customer number

customerAccountId

string <= 50 characters

Customer account id

firstName

string <= 50 characters

First name

lastName

string <= 50 characters

Last name

addressList

array of addressList

Address list

Array () [
careOf

string <= 50 characters

Care of. Intermediary who is responsible for transferring a piece of mail between the postal system and the final addressee. For example Jane c/o John (“Jane at John's address”). This field has to be used for company, authority and organization names as well - e. g. "Sportverein Blau-Weiß e.V.

street

string <= 100 characters

Name of street or packstation

streetNumber

string <= 10 characters

Street or packstation number

streetNumberAdditional

string <= 10 characters

Additional street number

postalCode

string <= 10 characters

Postal code

postalPlace

string <= 100 characters

Postal place

countryCode

string

Enum:NOSEFIDKDEATCHNLBE

Country code

]
outcome

string

Enum:AcceptedPendingRejectedNotEvaluated

Outcome

riskCheckMessages

array of riskCheckMessages

Risk check messages

Array () [
type

string

Enum:BusinessErrorTechnicalErrorNotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum:UnavailableAskConsumerToConfirmAskConsumerToReEnterDataOfferSecurePaymentMethodsRequiresSsnAskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error

]
400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum:BusinessErrorTechnicalErrorNotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum:UnavailableAskConsumerToConfirmAskConsumerToReEnterDataOfferSecurePaymentMethodsRequiresSsnAskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error

]
401 Authorization has been denied for this request.
500 Internal server error.

Path

post

/api/v3/customer-account

Request samples

  • {
    • "accountLimit": 1.00,
    • "customer": { ... }
      • {
        • "salutation": "string",
        • "firstName": "string",
        • "lastName": "string",
        • "customerNumber": "string",
        • "organizationPersonalNo": "string",
        • "category": "string",
        • "currency": "string",
        • "distributionBy": "string",
        • "distributionType": "string",
        • "email": "string",
        • "address": { ... }
          • {
            • "careOf": "string",
            • "street": "string",
            • "streetNumber": "string",
            • "streetNumberAdditional": "string",
            • "postalCode": "string",
            • "postalPlace": "string",
            • "countryCode": "string"
            }
          ,
        • "phone": "string",
        • "directPhone": "string",
        • "mobilePhone": "string"
        }
      ,
    • "firstNoticeDate": "string",
    • "countryCode": "string",
    • "conversationLanguage": "string"
    }

Response samples

200400
  • {
    • "account": { ... }
      • {
        • "accountLimit": 1.00,
        • "accountNumber": "string",
        • "accountProfile": "string",
        • "accountStatus": "string",
        • "balance": 1.00,
        • "bankAccount": "string",
        • "customerId": "string",
        • "createdAt": "string",
        • "isStopped": true,
        • "ocr": "string",
        • "lastNoticeDate": "string",
        • "nextNoticeDate": "string"
        }
      ,
    • "temporaryExternalProblem": true,
    • "customer": { ... }
      • {
        • "customerNumber": "string",
        • "customerAccountId": "string",
        • "firstName": "string",
        • "lastName": "string",
        • "addressList": [ { ... }
          • {
            • "careOf": "string",
            • "street": "string",
            • "streetNumber": "string",
            • "streetNumberAdditional": "string",
            • "postalCode": "string",
            • "postalPlace": "string",
            • "countryCode": "string"
            }
          ]
        }
      ,
    • "outcome": "string",
    • "riskCheckMessages": [ { ... }
      • {
        • "type": "string",
        • "code": "string",
        • "message": "string",
        • "customerFacingMessage": "string",
        • "actionCode": "string",
        • "fieldReference": "string"
        }
      ]
    }
  • {
    • "type": "string",
    • "code": "string",
    • "message": "string",
    • "customerFacingMessage": "string",
    • "actionCode": "string",
    • "fieldReference": "string"
    }
Riverty Logo
Riverty Logo
About Us
Follow Riverty on LinkedIn
Follow Arvato Financial Solutions
Riverty Status
Riverty Insights
Integrate Riverty
Documentation
Partner & Integrations
API Specification
Release Notes
Riverty Sandbox
Create Account
Login to Sandbox
Riverty 2023