Billing accounts

This guide describes how to integrate billing accounts into your banking solution. It includes step-by-step instructions, including the necessary endpoints and webhooks you must implement into your solution.

Introduction

What's a billing account?

A billing account is an internal partner account that enables you to collect fees from your customers via SEPA Direct Debit transfer (SDD), send refunds via SEPA Credit transfer (SCT), and move funds between accounts.

Prerequisites

Before opening a billing account, you must fulfill the following prerequisites:

  1. Solaris must identify your business and all legal representative(s) and authorized person(s) associated with your company according to KYC guidelines.
  2. The legal representative(s) and authorized person(s) associated with you must have their type_of_representation set to ALONE as JOINT type of representation is currently not supported.
attention

A billing account is an internal account for Solaris' partners. You cannot offer billing accounts to your customers.

How to open a billing account?

You must send a request to Solaris to open a billing account, as it is a manual process. The process looks like this:

  1. Contact your Onboarding Project Manager and Technical Solution Engineer to initiate the process and ensure that you meet the prerequisites.
  2. Solaris will send you the necessary documents you must complete and send back to us. These include, but are not limited to:

    • An account opening form
    • FATCA and CRS consent form
    • Solaris' Terms and Conditions
  3. You must fill out the required forms, accept the terms and conditions, and send them back to Solaris.

Once your request is approved, Solaris will open the billing account for you and share with you the following:

  • A separate set of test credentials to test the endpoints related to the billing account.
  • The account_id and iban of the billing account.

How to use a billing account?

Once your billing account is up and running and you have its account_id and iban, implement the following endpoints in your solution to start collecting fees from your customers via SEPA Direct Debit and issue refunds via SEPA Credit Transfer.

SEPA Direct Debit Transfers (SDDs)

Implement the following endpoints to initiate SDDs from your customers' accounts to your billing account.

attention

Before collecting any fees from your customers via SDDs, you must ensure that:

  • Your terms and conditions that your customers signed during the onboarding process include such fees.
  • Your customers must sign a valid SDD mandate to authorize you to debit their accounts. See the relevant guide for more information about SDD mandates.

POST Create a SEPA Direct Debit to a billing account

This endpoint initiates a SEPA Direct Debit transaction from an external account (i.e., the customer's account) to your billing account. You must add the account_id of your billing account in the request URL.

Request URL

Copy
Copied
POST /v1/accounts/{account_id}/transactions/sepa_direct_debit

Response example

Copy
Copied
{
  "id": "074ff24d187a014f42d5694b13e9cf1fctrx",
  "status": "ACCEPTED",
  "reference": "8880a72c-2675-482d-8d88-70a02c608592",
  "amount": {
    "value": 1000,
    "unit": "cents",
    "currency": "EUR"
  },
  "description": "string",
  "collection_date": "2021-02-11T00:00:00.000Z",
  "mandate": {
    "reference": "dsf2r3raedfs3fsf342fctrx",
    "creditor_identifier": "DE98ZZZ09999999999",
    "scheme": "string",
    "sequence_type": "string",
    "signature_date": "2017-10-02T16:12:41Z",
    "debtor_name": "Hans Mustermann",
    "debtor_iban": "DE29300400000180478000",
    "debtor_bic": "COBADEFFXXX"
  },
  "end_to_end_id": "END2ENDREJ"
}

Click here to view the full API reference.

GET Retrieve a SEPA Direct Debit transaction to a billing account

This endpoint returns the details of a single SEPA Direct Debit transaction. You must add the account_id of your billing account and the transaction ID (sepa_direct_debit_id) in the request URL.

Request URL

Copy
Copied
GET /v1/accounts/{account_id/}transactions/sepa_direct_debit/{sepa_direct_debit_id}

Click here to view the full API reference.

SEPA Credit Transfers (SCTs)

Implement the following endpoints to initiate SCTs from your billing account. For example, you can use SCTs to send refunds to your customers and/or move funds to other accounts.

POST Create a SEPA Credit Transfer from a billing account

This endpoint creates a SEPA Credit Transfer from the billing account specified in the request URL to the account set in the request body. First, you must add the account_id of your billing account in the request URL. Then, in the request body, you must add the following properties:

  • recipient_iban
  • recipient_ bic
  • amount
  • description, reference, and end_to_end_id of the transaction.

Request URL

Copy
Copied
POST /v1/accounts/{account_id}/transactions/sepa_credit_transfer

Response example

Copy
Copied
{
  "reference": "",
  "recipient_name": "Hans Mustermann",
  "recipient_iban": "DE32110101001000000029",
  "recipient_bic": "COBADEFFXXX",
  "amount": {
    "value": 1000,
    "currency": "EUR",
    "unit": "cents"
  },
  "description": "Example transaction",
  "end_to_end_id": ""
}

Click here to view the full API reference.

GET Retrieve a SEPA Credit Transfer transaction from a billing account

This endpoint returns the details of a single SEPA Credit Transfer transaction. You must add the account_id of your billing account and the transaction ID id in the request URL.

Request URL

Copy
Copied
GET /v1/accounts/{account_id}/transactions/sepa_credit_transfer/{id}

Click here to view the full API reference

Billing account management

Implement the following endpoints to manage and maintain your billing account.

Useful resources

Check the following links for additional resources around this topic: