Credit cards (1.0)

Download OpenAPI specification:Download

Credit cards

Create a credit card application for a consumer or freelancer

This endpoint creates a credit card application and assigns it to the person with the person_id specified in the request URL. The application includes all the required information about the customer, such as their self-declared financial information, credit card type and requested limit, which Solaris' credit scorer uses to initiate a series of credit checks.
Note: Solaris will tell you which fields are mandatory based on your use case.

Request
Security:
path Parameters
person_id
required
string
Request Body schema: application/json
product_type
required
string

Indicates the type of credit card to open.

Enum: "CONSUMER_CREDIT_CARD" "FREELANCER_CREDIT_CARD" "BUSINESS_CREDIT_CARD"
external_customer_id
string

Arbitrary ID provided by you (e.g., membership ID).

object

Object containing information about the repayment plan for the credit card.

statement_with_details
boolean

Indicates whether to return the full transaction details in the credit card statements.

required
object (consumer_scoring_options)
Responses
201

The credit card application was created successfully.

400

Validation Error

403

Unathorized action

404

Not found

500

Internal server error.

post/v1/persons/{person_id}/credit_card_applications
Request samples
application/json
{
  • "product_type": "CONSUMER_CREDIT_CARD",
  • "external_customer_id": "CKV1002494",
  • "repayment_options": {
    },
  • "statement_with_details": true,
  • "scoring_options": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "external_customer_id": "string",
  • "customer_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
  • "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
  • "account_iban": "DE53110101013323159108",
  • "reference_account_id": "d1ed02309ca52b5e636e215ff82b2d52sddm",
  • "status": "PENDING",
  • "product_type": "CONSUMER_CREDIT_CARD",
  • "billing_start_date": "2022-07-01",
  • "billing_end_date": "2022-07-28",
  • "qes_at": "2022-07-28",
  • "approved_limit": {
    },
  • "requested_limit": {
    },
  • "current_limit": {
    },
  • "decline_reasons": [
    ],
  • "repayment_options": {
    },
  • "statement_with_details": true,
  • "scoring_options": {
    },
  • "in_dunning": true,
  • "repayment_type_switch_available_date": "2022-07-28",
  • "created_at": "2022-07-28",
  • "active_termination_id": "string"
}

Create a credit card application for a business

This endpoint creates a credit card application and assigns it to the business with the business_id specified in the request URL. The application includes all the required information about the customer, such as their self-declared financial information, credit card type and requested limit, which Solaris' credit scorer uses to initiate a series of credit checks.
Note: Solaris will tell you which fields are mandatory based on your use case.

Request
Security:
path Parameters
business_id
required
string
Request Body schema: application/json
product_type
required
string

Indicates the type of credit card to open.

Enum: "CONSUMER_CREDIT_CARD" "FREELANCER_CREDIT_CARD" "BUSINESS_CREDIT_CARD"
external_customer_id
string

Arbitrary ID provided by you (e.g., membership ID).

object

Object containing information about the repayment plan for the credit card.

statement_with_details
boolean

Indicates whether to return the full transaction details in the credit card statements.

required
object (business_scoring_options)
Responses
201

The credit card application was created successfully.

400

Validation Error

403

Unathorized action

404

Not found

500

Internal server error.

post/v1/businesses/{business_id}/credit_card_applications
Request samples
application/json
{
  • "product_type": "CONSUMER_CREDIT_CARD",
  • "external_customer_id": "CKV1002494",
  • "repayment_options": {
    },
  • "statement_with_details": true,
  • "scoring_options": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "external_customer_id": "string",
  • "customer_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
  • "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
  • "account_iban": "DE53110101013323159108",
  • "reference_account_id": "d1ed02309ca52b5e636e215ff82b2d52sddm",
  • "status": "PENDING",
  • "product_type": "CONSUMER_CREDIT_CARD",
  • "billing_start_date": "2022-07-01",
  • "billing_end_date": "2022-07-28",
  • "qes_at": "2022-07-28",
  • "approved_limit": {
    },
  • "requested_limit": {
    },
  • "current_limit": {
    },
  • "decline_reasons": [
    ],
  • "repayment_options": {
    },
  • "statement_with_details": true,
  • "scoring_options": {
    },
  • "in_dunning": true,
  • "repayment_type_switch_available_date": "2022-07-28",
  • "created_at": "2022-07-28",
  • "active_termination_id": "string"
}

Accept and finalize credit card application

Finalizes the credit card application specified in the request URL. If the request succeeds, then Solaris will create a credit card account for the customer.
Note: Call this endpoint only after the customer has successfully completed the KYC process.

Request
Security:
path Parameters
id
required
string
Responses
200

The credit card application was created successfully.

400

Validation Error

403

Unathorized action

404

Not found

500

Internal server error.

post/v1/credit_card_applications/{id}/finalize
Request samples
curl -i -X POST \
  'https://api.solaris-sandbox.de/v1/credit_card_applications/{id}/finalize'
Response samples
application/json
{
  • "id": "string",
  • "external_customer_id": "string",
  • "customer_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
  • "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
  • "account_iban": "DE53110101013323159108",
  • "reference_account_id": "d1ed02309ca52b5e636e215ff82b2d52sddm",
  • "status": "PENDING",
  • "product_type": "CONSUMER_CREDIT_CARD",
  • "billing_start_date": "2022-07-01",
  • "billing_end_date": "2022-07-28",
  • "qes_at": "2022-07-28",
  • "approved_limit": {
    },
  • "requested_limit": {
    },
  • "current_limit": {
    },
  • "decline_reasons": [
    ],
  • "repayment_options": {
    },
  • "statement_with_details": true,
  • "scoring_options": {
    },
  • "in_dunning": true,
  • "repayment_type_switch_available_date": "2022-07-28",
  • "created_at": "2022-07-28",
  • "active_termination_id": "string"
}

Set limit for credit card account

Attaches a credit limit to the credit card account specified in the request URL by its ID.
Note: You must attach a limit that is less than or equal to the limit approved by Solaris.

Request
Security:
path Parameters
id
required
string
Request Body schema: application/json
object (amount)
Responses
202

The credit card application was created successfully.

400

Validation Error

403

Unathorized action

404

Not found

500

Internal server error.

patch/v1/credit_card_applications/{id}/limit
Request samples
application/json
{
  • "limit": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "external_customer_id": "string",
  • "customer_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
  • "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
  • "account_iban": "DE53110101013323159108",
  • "reference_account_id": "d1ed02309ca52b5e636e215ff82b2d52sddm",
  • "status": "PENDING",
  • "product_type": "CONSUMER_CREDIT_CARD",
  • "billing_start_date": "2022-07-01",
  • "billing_end_date": "2022-07-28",
  • "qes_at": "2022-07-28",
  • "approved_limit": {
    },
  • "requested_limit": {
    },
  • "current_limit": {
    },
  • "decline_reasons": [
    ],
  • "repayment_options": {
    },
  • "statement_with_details": true,
  • "scoring_options": {
    },
  • "in_dunning": true,
  • "repayment_type_switch_available_date": "2022-07-28",
  • "created_at": "2022-07-28",
  • "active_termination_id": "string"
}

Get a list of credit card applications

Returns an array containing all credit card applications created for your customers.

Request
Security:
query Parameters
page[size]
integer
Default: 10

Indicates the number of entries to return on each results page.

page[number]
integer
Default: 1

Indicates the number of results pages to return.

filter[id]
string

Filter the results by resource ID.

filter[customer_id]
string

Filter the results by customer ID.

filter[external_customer_id]
string

Filter the results by external customer ID.

filter[product_type]
string

Filter the results by product type.

filter[status]
string

Filter the results by status.

sort
string

Sort the results by created_at or updated_at.

Responses
200

Extended response for credit card application.

400

Validation Error

403

Unathorized action

500

Internal server error.

get/v1/credit_card_applications
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/credit_card_applications?page%5Bsize%5D=10&page%5Bnumber%5D=1&filter%5Bid%5D=string&filter%5Bcustomer_id%5D=string&filter%5Bexternal_customer_id%5D=string&filter%5Bproduct_type%5D=string&filter%5Bstatus%5D=string&sort=string'
Response samples
application/json
{
  • "id": "string",
  • "external_customer_id": "string",
  • "customer_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
  • "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
  • "account_iban": "DE53110101013323159108",
  • "reference_account_id": "d1ed02309ca52b5e636e215ff82b2d52sddm",
  • "status": "PENDING",
  • "product_type": "CONSUMER_CREDIT_CARD",
  • "billing_start_date": "2022-07-01",
  • "billing_end_date": "2022-07-28",
  • "approved_limit": {
    },
  • "requested_limit": {
    },
  • "current_limit": {
    },
  • "decline_reasons": [
    ],
  • "repayment_options": {
    },
  • "statement_with_details": true,
  • "scoring_options": {
    },
  • "in_dunning": true,
  • "repayment_type_switch_available_date": "2022-07-28",
  • "created_at": "2022-07-28",
  • "default_interest_account_id": "e48c29b85992b8772eb7ddd518490920cacc",
  • "interest_storing_account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
  • "latest_repayment_type_switch_date": "2022-07-28",
  • "qes_at": "2022-07-28",
  • "active_termination_id": "string"
}

Get a credit card application

Returns the credit card application specified in the request URL by its ID.

Request
Security:
path Parameters
id
required
string
Responses
200

Extended response for credit card application.

403

Unathorized action

404

Not found

500

Internal server error.

get/v1/credit_card_applications/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/credit_card_applications/{id}'
Response samples
application/json
{
  • "id": "string",
  • "external_customer_id": "string",
  • "customer_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
  • "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
  • "account_iban": "DE53110101013323159108",
  • "reference_account_id": "d1ed02309ca52b5e636e215ff82b2d52sddm",
  • "status": "PENDING",
  • "product_type": "CONSUMER_CREDIT_CARD",
  • "billing_start_date": "2022-07-01",
  • "billing_end_date": "2022-07-28",
  • "approved_limit": {
    },
  • "requested_limit": {
    },
  • "current_limit": {
    },
  • "decline_reasons": [
    ],
  • "repayment_options": {
    },
  • "statement_with_details": true,
  • "scoring_options": {
    },
  • "in_dunning": true,
  • "repayment_type_switch_available_date": "2022-07-28",
  • "created_at": "2022-07-28",
  • "default_interest_account_id": "e48c29b85992b8772eb7ddd518490920cacc",
  • "interest_storing_account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
  • "latest_repayment_type_switch_date": "2022-07-28",
  • "qes_at": "2022-07-28",
  • "active_termination_id": "string"
}

Update repayment option for a credit card

This endpoint changes the repayment option (i.e., from charge to revolving, or vice versa) for the credit card specified in the request URL by the respective application ID.
Note: The change will only take effect in the next billing cycle.
The API applies the following validation logic:

current_type upcoming_type minimum_amount & minimum_percentage logic description
FULL FULL Absent or null -
FULL PARTIAL Passed or already set Allowed to be done any time in the billing cycle.
A customer must have QES and be not in Dunning.
latest_repayment_type_switch_date will be set to the current date.
Interest calculation for this account will start from the date of the switch.
current_type & upcoming_type will be set to PARTIAL
If there is a PENDING bill then:
it will be closed and a new one is generated for the same bill start_date and end_date.
a new PDF statement is also generated.
PARTIAL PARTIAL Passed or already set -
PARTIAL FULL Passed or already set Allowed only once in a billing cycle.
A customer must have QES and be not in Dunning.
A switch is not allowed if repayment_type_switch_available_date is not today or older.
The upcoming_type will be set to FULL.
Request
Security:
path Parameters
id
required
string
Request Body schema: application/json
object

Object containing updated properties for the credit card's repayment plans.

statement_with_details
boolean

Indicates whether to return the full transaction details in the credit card statements.

Responses
200

The credit card application was created successfully.

400

Validation Error

403

Unathorized action

404

Not found

500

Internal server error.

patch/v1/credit_card_applications/{id}
Request samples
application/json
{
  • "repayment_options": {
    },
  • "statement_with_details": true
}
Response samples
application/json
{
  • "id": "string",
  • "external_customer_id": "string",
  • "customer_id": "0ba2211cab11af6094d60ead81f2bd9dcper",
  • "account_id": "c2a13abed3b0686ab5343aa748d7f2fecacc",
  • "account_iban": "DE53110101013323159108",
  • "reference_account_id": "d1ed02309ca52b5e636e215ff82b2d52sddm",
  • "status": "PENDING",
  • "product_type": "CONSUMER_CREDIT_CARD",
  • "billing_start_date": "2022-07-01",
  • "billing_end_date": "2022-07-28",
  • "qes_at": "2022-07-28",
  • "approved_limit": {
    },
  • "requested_limit": {
    },
  • "current_limit": {
    },
  • "decline_reasons": [
    ],
  • "repayment_options": {
    },
  • "statement_with_details": true,
  • "scoring_options": {
    },
  • "in_dunning": true,
  • "repayment_type_switch_available_date": "2022-07-28",
  • "created_at": "2022-07-28",
  • "active_termination_id": "string"
}

Get a credit card bill

Returns the credit card bill specified in the request URL.

Request
Security:
path Parameters
bill_id
required
string
Responses
200

Bill record for a credit card account

400

Validation Error

403

Unathorized action

404

Not found

500

Internal server error.

get/v1/credit_card_bills/{bill_id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/credit_card_bills/{bill_id}'
Response samples
application/json
{
  • "id": "8d298774499c44349e3f2e98ba408e74",
  • "application_id": "a8cafe0c24e949c78bfbea04cb5b2905ccla",
  • "status": "PENDING",
  • "start_date": "2022-04-01",
  • "end_date": "2022-04-30",
  • "statement_date": "2022-05-01",
  • "due_date": "2022-05-15",
  • "sdd_collection_date": "2022-05-16",
  • "previous_bill_amount": {
    },
  • "current_bill_amount": {
    },
  • "total_outstanding_amount": {
    },
  • "minimum_due_amount": {
    },
  • "outstanding_sddr_amount": {
    },
  • "outstanding_amount": {
    },
  • "repayment_type": "FULL",
  • "minimum_amount": {
    },
  • "minimum_percentage": 3,
  • "grace_period_in_days": 15,
  • "dunning_fees": {
    },
  • "other_fees": {
    },
  • "accumulated_interest_amount": {
    },
  • "postbox_item_id": "c072c6e43f4d486cb553e9cd9fc1bae7pbxi"
}

List all credit card bills

Returns an array containing all credit card bills for all of your customers.

Request
Security:
query Parameters
page[size]
integer
Default: 10

Specifies the number of results to return on each page.

page[number]
integer
Default: 1

Specifies the number of results pages to return.

filter[application_id]
string

Filters the results by credit card application ID (i.e., returns all bills related to a specific credit card).

filter[status]
string

Filters the results by status.

filter[statement_date][min]
string

Returns all credit card bills on or after the provided date.

filter[statement_date][max]
string

Returns all credit card bills with a statement date up to the given date.

Responses
200

List of bills for a credit card account

400

Validation Error

403

Unathorized action

500

Internal server error.

get/v1/credit_card_bills
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/credit_card_bills?page%5Bsize%5D=10&page%5Bnumber%5D=1&filter%5Bapplication_id%5D=string&filter%5Bstatus%5D=string&filter%5Bstatement_date%5D%5Bmin%5D=string&filter%5Bstatement_date%5D%5Bmax%5D=string'
Response samples
application/json
[
  • {
    }
]

Termination requests

Create credit card termination request

Creates a termination request for the credit card application specified in the request URL. See the credit cards guide for more information on how the termination process works.

Request
Security:
path Parameters
application_id
required
string
Request Body schema: application/json
reason
required
string

The reason for the termination.

Value: "CUSTOMER_WISH"
Responses
200

Termination record

403

Unathorized action

500

Internal server error.

post/v1/credit_card_applications/{application_id}/termination_requests
Request samples
application/json
{
  • "reason": "CUSTOMER_WISH"
}
Response samples
application/json
{
  • "id": "ac8df7d811c042faacabd8162de7b789cctr",
  • "application_id": "796ff7b9961c4fe1b4470e45298b5d69ccla",
  • "reason": "CUSTOMER_WISH",
  • "status": "INITIATED",
  • "legally_terminated_at": "2023-08-31",
  • "revocable_until": "2023-08-02",
  • "created_at": "2023-07-28T14:47:00.000Z"
}

Get all credit card termination requests

Returns a list of all credit card termination requests.

Request
Security:
query Parameters
page[size]
integer
Default: 10

Indicates the number of entries to return on each results page.

page[number]
integer
Default: 1

Indicates the number of results pages to return.

sort
string

Sort the results by created_at or updated_at.

Responses
200

List of terminations records

403

Unathorized action

500

Internal server error.

get/v1/credit_card_terminations
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/credit_card_terminations?page%5Bsize%5D=10&page%5Bnumber%5D=1&sort=string'
Response samples
application/json
[
  • {
    }
]

Get credit card termination request

Returns the credit card termination request specified in the request URL.

Request
Security:
path Parameters
id
required
string
Responses
200

Termination record

403

Unathorized action

404

Not found

500

Internal server error.

get/v1/credit_card_terminations/{id}
Request samples
curl -i -X GET \
  'https://api.solaris-sandbox.de/v1/credit_card_terminations/{id}'
Response samples
application/json
{
  • "id": "ac8df7d811c042faacabd8162de7b789cctr",
  • "application_id": "796ff7b9961c4fe1b4470e45298b5d69ccla",
  • "reason": "CUSTOMER_WISH",
  • "status": "INITIATED",
  • "legally_terminated_at": "2023-08-31",
  • "revocable_until": "2023-08-02",
  • "created_at": "2023-07-28T14:47:00.000Z"
}

Revoke a termination request

Revokes the credit card termination request specified in the request URL. Note that you may only revoke a termination request within 5 business days of its creation.

Request
Security:
path Parameters
id
required
string
Responses
200

Termination record

403

Unathorized action

404

Not found

500

Internal server error.

post/v1/credit_card_terminations/{id}/revoke
Request samples
curl -i -X POST \
  'https://api.solaris-sandbox.de/v1/credit_card_terminations/{id}/revoke'
Response samples
application/json
{
  • "id": "ac8df7d811c042faacabd8162de7b789cctr",
  • "application_id": "796ff7b9961c4fe1b4470e45298b5d69ccla",
  • "reason": "CUSTOMER_WISH",
  • "status": "INITIATED",
  • "legally_terminated_at": "2023-08-31",
  • "revocable_until": "2023-08-02",
  • "created_at": "2023-07-28T14:47:00.000Z"
}