Loading
Documentation Powered by ReDoc

DFS Funding Services API (latest)

Download OpenAPI specification:Download

Contains functionality around Funding Services.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

FundingManagement

Delete funding

Deletes (logically) a funding.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

The id of the contact.

fundingId
required
integer <int32>

The id of the funding.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v1.1/contacts/{contactId}/fundings/{fundingId}
https://example-host/v1.1/contacts/{contactId}/fundings/{fundingId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get funding by id

Gets a funding.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

The id of the contact.

fundingId
required
integer <int32>

The id of the funding.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v1.1/contacts/{contactId}/fundings/{fundingId}
https://example-host/v1.1/contacts/{contactId}/fundings/{fundingId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "targetAccountUId": "3471b71d-e1fe-4648-a90e-43b6db21e973",
  • "sourceAccountUId": "f2c1f931-cd20-4268-a185-7ed11a7443a7",
  • "currencyUId": "2f87cc20-5347-43ea-a083-3122f16cbdb0",
  • "goalUId": "d691adea-b291-447b-83fe-6857f3a75f70",
  • "cronExpression": "0 0 6 ? * MON",
  • "id": 8,
  • "typeId": 1,
  • "targetAccountId": 2,
  • "sourceAccountId": 1,
  • "amount": 250,
  • "currencyId": 2,
  • "isActive": true,
  • "createDate": "2022-10-21T06:31:09",
  • "endDate": "2025-10-20T06:31:09",
  • "firstExecutionDate": "2022-10-31T06:31:09",
  • "goalId": 16,
  • "recurrenceTypeId": 2,
  • "isLockedForProcessing": false
}

Modify funding

Modifies a funding by deleting (logically) the existing funding and creating a new one.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

The id of the contact.

fundingId
required
integer <int32>

The id of the funding.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Properties of the funding to update.

typeId
integer <int32> Nullable
amount
number <double> Nullable
createDate
string <date-time> Nullable
endDate
string <date-time> Nullable
firstExecutionDate
string <date-time> Nullable
recurrenceTypeId
integer <int32> Nullable
attributes
string Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v1.1/contacts/{contactId}/fundings/{fundingId}
https://example-host/v1.1/contacts/{contactId}/fundings/{fundingId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "typeId": 2,
  • "amount": 5001,
  • "createDate": "2020-02-28T00:00:00",
  • "endDate": "2021-03-05T00:00:00",
  • "firstExecutionDate": "2021-03-05T00:00:00",
  • "recurrenceTypeId": 3,
  • "attributes": "{ \"Description\" : \"Recurring\" }"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 62,
  • "typeId": 2,
  • "targetAccountId": 1,
  • "sourceAccountId": 2,
  • "amount": 5001,
  • "currencyId": 2,
  • "isActive": true,
  • "createDate": "2020-02-28T00:00:00",
  • "endDate": "2021-03-05T00:00:00",
  • "firstExecutionDate": "2021-03-05T00:00:00",
  • "goalId": 12,
  • "recurrenceTypeId": 3,
  • "isLockedForProcessing": false,
  • "scheduledJobId": "12345",
  • "attributes": "{ \"Description\" : \"Recurring\" }"
}

Create funding

Creates a funding.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

The id of the contact.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

New funding.

fundingTypeId
integer <int32> Nullable
targetAccountId
integer <int32> Nullable
sourceAccountId
integer <int32> Nullable
amount
number <double> Nullable
currencyId
integer <int32> Nullable
isActive
boolean Nullable
createDate
string <date-time> Nullable
endDate
string <date-time> Nullable
firstExecutionDate
string <date-time> Nullable
goalId
integer <int32> Nullable
recurrenceTypeId
integer <int32> Nullable
isLockedForProcessing
boolean Nullable
attributes
string Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.1/contacts/{contactId}/fundings
https://example-host/v1.1/contacts/{contactId}/fundings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fundingTypeId": 1,
  • "targetAccountId": 1,
  • "sourceAccountId": 2,
  • "amount": 1337,
  • "currencyId": 2,
  • "isActive": true,
  • "createDate": "2021-02-28T00:00:00",
  • "endDate": "2021-03-05T00:00:00",
  • "firstExecutionDate": "2021-03-05T00:00:00",
  • "goalId": 12,
  • "recurrenceTypeId": 2,
  • "isLockedForProcessing": false,
  • "attributes": "{ \"Description\" : \"(Test) Top up\" }"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 7,
  • "typeId": 1,
  • "targetAccountId": 1,
  • "sourceAccountId": 2,
  • "amount": 1337,
  • "currencyId": 2,
  • "isActive": true,
  • "createDate": "2021-02-28T00:00:00",
  • "endDate": "2021-03-05T00:00:00",
  • "firstExecutionDate": "2021-03-05T00:00:00",
  • "goalId": 12,
  • "recurrenceTypeId": 2,
  • "isLockedForProcessing": false,
  • "scheduledJobId": "12345",
  • "attributes": "{ \"Description\" : \"(Test) Top up\" }"
}

FundingSearch

Search fundings for a contact

Allows the User to search for Fundings of an authenticated Contact for a given set of criteria.

Authorizations:
Bearer
path Parameters
contactId
required
integer <int32>

The id of the contact.

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

The search parameters.

page
integer <int32>
pageSize
integer <int32>
typeIds
Array of integers <int32> Nullable
targetAccountIds
Array of integers <int32> Nullable
sourceAccountIds
Array of integers <int32> Nullable
goalIds
Array of integers <int32> Nullable
recurrenceTypeIds
Array of integers <int32> Nullable
isActive
boolean Nullable
scheduledJobIds
Array of strings Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.1/contacts/{contactId}/fundings/search
https://example-host/v1.1/contacts/{contactId}/fundings/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "page": 1,
  • "pageSize": 3,
  • "typeIds":
    [
    ],
  • "targetAccountIds":
    [
    ],
  • "sourceAccountIds":
    [
    ],
  • "goalIds":
    [
    ],
  • "recurrenceTypeIds":
    [
    ],
  • "isActive": true,
  • "scheduledJobIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fundings":
    [
    ],
  • "totalNumberOfResults": 1
}

Search fundings

Searches for fundings and returns a list with fundings (and key attributes) matching the passed request parameters.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

The request DTO

page
integer <int32>
pageSize
integer <int32>
sortBy
string Nullable
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
ids
Array of integers <int32> Nullable
typeIds
Array of integers <int32> Nullable
targetAccountIds
Array of integers <int32> Nullable
sourceAccountIds
Array of integers <int32> Nullable
currencyIds
Array of integers <int32> Nullable
goalIds
Array of integers <int32> Nullable
recurrenceTypeIds
Array of integers <int32> Nullable
isActive
boolean Nullable
isLockedForProcessing
boolean Nullable
scheduledJobIds
Array of strings Nullable
createDateFrom
string <date-time> Nullable
createDateTo
string <date-time> Nullable
firstExecutionDateFrom
string <date-time> Nullable
firstExecutionDateTo
string <date-time> Nullable
nextExecutionDateFrom
string <date-time> Nullable
nextExecutionDateTo
string <date-time> Nullable
endDateFrom
string <date-time> Nullable
endDateTo
string <date-time> Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v1.1/fundings/search
https://example-host/v1.1/fundings/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "isActive": true,
  • "isLockedForProcessing": false,
  • "sortBy": "id",
  • "sortOrder": "Ascending",
  • "page": 1,
  • "pageSize": 10
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "results":
    [
    ],
  • "page": 1,
  • "pageSize": 10,
  • "pageCount": 1,
  • "totalCount": 2
}