Skip to content
/
SDD Collection Applicatio...

SEPA transfers (1.0)

Download OpenAPI description
sepa-transfers.json
sepa-transfers.yaml
Languages
Servers
Mock Server
https://docs.solarisgroup.com/_mock/api-reference/digital-banking/sepa-transfers/

SEPA Direct Debits

Operations

SEPA Direct Debit Returns

Operations

SEPA Credit Transfers

Operations

(Legacy) Batch Transfer

Operations

SEPA Instant Credit Transfers

Operations

SEPA Instant Outgoing

Operations

(Legacy) Standing orders

Operations

(Legacy) Timed orders

Operations

SDD Collection Limits

Operations

SDD Collection Applications

Operations

Index SDD collection applications

Request

Returns a list of all SDD collection applications for the person specified in the request URL.

Path
person_idstringrequired
Query
page[size]integer

Specifies the number of resources to return in each page of results.

Default 10
page[number]integer

Specifies the number of pages of results to return.

Default 1
filter[status]string

Filter the results by status.

No request payload

Responses

The operation was successful.

Bodyapplication/jsonArray [
idstring

ID of the SDD collection application.

Example: "dec2961f594045159195ca66e55fd6ea"
person_idstring

ID of the person who created the SDD collection application.

Example: "ec71f4b0456b424b97cc8be75b2c77d4"
credit_record_idstring

The credit_record_id of the SDD collection application.

Example: "84f468eacc7a4784ba0d4b0b577a9265"
sdd_collection_idstring

ID of the SDD collection.

Example: "c06fbfcc98b04376a9f220c4578932e4"
account_snapshot_idstring

ID of the relevant account snapshot record.

Example: "973a5f01ed7a416fadfed954c5bce782"
statusstring

The current status of the SDD collection application.

Example: "pending"
decisionstring

The decision taken on the SDD collection application.

Enum"OFFERED""REJECTED"
Example: "OFFERED"
rejection_reasonsArray of strings

An array of reasons why the SDD collection application was rejected.

Items Enum"not_preferred_alternate_offer""probability_of_default"
Example: ["probability_of_default"]
created_atstring(date-time)

UTC timestamp from when the application was created.

Example: "2021-10-20T14:45:54Z"
limitobject(amount)
]
Response
application/json
[
  {
    "id": "dec2961f594045159195ca66e55fd6ea",
    "person_id": "ec71f4b0456b424b97cc8be75b2c77d4",
    "credit_record_id": "84f468eacc7a4784ba0d4b0b577a9265",
    "sdd_collection_id": "c06fbfcc98b04376a9f220c4578932e4",
    "account_snapshot_id": "973a5f01ed7a416fadfed954c5bce782",
    "status": "pending",
    "decision": "OFFERED",
    "rejection_reasons": [ … ],
    "created_at": "2021-10-20T14:45:54Z",
    "limit": { … }
  }
]

Create an SDD collection application

Request

Creates an application for an SDD collection for the person specified in the request URL.

Path
person_idstringrequired
Bodyapplication/json
credit_record_idstringrequired

ID of the credit record (created using POST /persons/{person_id}/credit_records).

Example: "84f468eacc7a4784ba0d4b0b577a9265"
application/json
{
  "credit_record_id": "84f468eacc7a4784ba0d4b0b577a9265"
}

Responses

The operation was successful.

Bodyapplication/jsonArray [
idstring

ID of the SDD collection application.

Example: "dec2961f594045159195ca66e55fd6ea"
person_idstring

ID of the person who created the SDD collection application.

Example: "ec71f4b0456b424b97cc8be75b2c77d4"
credit_record_idstring

The credit_record_id of the SDD collection application.

Example: "84f468eacc7a4784ba0d4b0b577a9265"
sdd_collection_idstring

ID of the SDD collection.

Example: "c06fbfcc98b04376a9f220c4578932e4"
account_snapshot_idstring

ID of the relevant account snapshot record.

Example: "973a5f01ed7a416fadfed954c5bce782"
statusstring

The current status of the SDD collection application.

Example: "pending"
decisionstring

The decision taken on the SDD collection application.

Enum"OFFERED""REJECTED"
Example: "OFFERED"
rejection_reasonsArray of strings

An array of reasons why the SDD collection application was rejected.

Items Enum"not_preferred_alternate_offer""probability_of_default"
Example: ["probability_of_default"]
created_atstring(date-time)

UTC timestamp from when the application was created.

Example: "2021-10-20T14:45:54Z"
limitobject(amount)
]
Response
application/json
[
  {
    "id": "dec2961f594045159195ca66e55fd6ea",
    "person_id": "ec71f4b0456b424b97cc8be75b2c77d4",
    "credit_record_id": "84f468eacc7a4784ba0d4b0b577a9265",
    "sdd_collection_id": "c06fbfcc98b04376a9f220c4578932e4",
    "account_snapshot_id": "973a5f01ed7a416fadfed954c5bce782",
    "status": "pending",
    "decision": "OFFERED",
    "rejection_reasons": [ … ],
    "created_at": "2021-10-20T14:45:54Z",
    "limit": { … }
  }
]

Attach account to an SDD collection application

Request

Attaches an internal account to the SDD collection application specified in the request URL.

Path
person_idstringrequired
sdd_collection_application_idstringrequired
Bodyapplication/json
account_idstringrequired

ID of the relevant account

application/json
{
  "account_id": "string"
}

Responses

The operation was successful.

Bodyapplication/json
any(no_content)

No content

Response
application/json
null

Link account snapshot to an SDD collection application

Request

Links an account snapshot to the SDD collection application specified in the request URL.

Path
person_idstringrequired
sdd_collection_application_idstringrequired
Bodyapplication/json
account_snapshot_idstringrequired

ID of the account snapshot to attach to the SDD collection application

application/json
{
  "account_snapshot_id": "string"
}

Responses

The operation was successful.

Bodyapplication/json
any(no_content)

No content

Response
application/json
null

Retrieve an SDD collection application

Request

Returns the SDD collection application specified in the request URL.

Path
person_idstringrequired
sdd_collection_application_idstringrequired
No request payload

Responses

The operation was successful.

Headers
Totalstring

Total number of resources to return.

Example: "123"
Per-Pagestring

Number of resources to return in each page.

Example: "10"
Linkstring

Links to first/previous/next/last pages.

Example: "<url?page[size]=10&page[number]=1>; rel=\"first\", <url?page[size]=10&page[number]=13>; rel=\"last\", <url?page[size]=10&page[number]=2>; rel=\"next\", <url?page[size]=10&page[number]=4>; rel=\"prev\"\n"
Bodyapplication/json
idstring

ID of the SDD collection application.

Example: "dec2961f594045159195ca66e55fd6ea"
person_idstring

ID of the person who created the SDD collection application.

Example: "ec71f4b0456b424b97cc8be75b2c77d4"
credit_record_idstring

The credit_record_id of the SDD collection application.

Example: "84f468eacc7a4784ba0d4b0b577a9265"
sdd_collection_idstring

ID of the SDD collection.

Example: "c06fbfcc98b04376a9f220c4578932e4"
account_snapshot_idstring

ID of the relevant account snapshot record.

Example: "973a5f01ed7a416fadfed954c5bce782"
statusstring

The current status of the SDD collection application.

Example: "pending"
decisionstring

The decision taken on the SDD collection application.

Enum"OFFERED""REJECTED"
Example: "OFFERED"
rejection_reasonsArray of strings

An array of reasons why the SDD collection application was rejected.

Items Enum"not_preferred_alternate_offer""probability_of_default"
Example: ["probability_of_default"]
created_atstring(date-time)

UTC timestamp from when the application was created.

Example: "2021-10-20T14:45:54Z"
limitobject(amount)
Response
application/json
{
  "id": "dec2961f594045159195ca66e55fd6ea",
  "person_id": "ec71f4b0456b424b97cc8be75b2c77d4",
  "credit_record_id": "84f468eacc7a4784ba0d4b0b577a9265",
  "sdd_collection_id": "c06fbfcc98b04376a9f220c4578932e4",
  "account_snapshot_id": "973a5f01ed7a416fadfed954c5bce782",
  "status": "pending",
  "decision": "OFFERED",
  "rejection_reasons": [
    "probability_of_default"
  ],
  "created_at": "2021-10-20T14:45:54Z",
  "limit": {
    "value": 10000,
    "unit": "cents",
    "currency": "EUR"
  }
}

SDD Collections

Operations

SEPA Credit Batch Transfers

Operations

Scheduled Transfers

Operations

Verification of Payee

Operations

(Legacy) SEPA Direct Debit for freelancers

Operations

(Legacy) SEPA Direct Debit for business

Operations

(Legacy) SEPA Direct Debit profile templates

Operations