Payments

Credit Fundings

Download Spec

All credit fundings related paths

get/account_groups/{account_group_id}/payments/credit_funding_details

Retrieve funding details

limitint

Use the limit argument to specify the maximum number of items returned.

Format: int32
Default: 100
Min: 0
Max: 1000

offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format: int32
Min: 0

Responses

Response examples

Funding Details

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "created_at",
    "order": "ASC"
  },
  "data": [
    {
      "virtual_bank_account_id": "4e127ac5-dae3-487e-b76b-fef7225a8b80",
      "name": "Max's Virtual Bank Account",
      "currency": "EUR",
      "owner": {
        "name": "Max Musterman"
      },
      "identification": {
        "swift": {
          "iban": "DE02100500000054540402",
          "bic": "DEUTDEFFXXX"
        }
      }
    },
    {
      "virtual_bank_account_id": "a38470db-f54c-4514-ad71-6904a5c2744f",
      "name": "Max's Virtual Bank Account",
      "currency": "EUR",
      "owner": {
        "name": "Max Musterman"
      },
      "identification": {
        "swift": {
          "iban": "DE02100500000054540403",
          "bic": "DEUTDEFFXXX"
        }
      }
    }
  ]
}

get/account_groups/{account_group_id}/payments/credit_fundings

List credit fundings

sortstring

Field of resource to sort by

Default: "created_at"
Enum: created_at
Example: "created_at"

orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default: "ASC"
Enum: ASC
DESC

limitint

Use the limit argument to specify the maximum number of items returned.

Format: int32
Default: 100
Min: 0
Max: 1000

offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format: int32
Min: 0

Responses

Response examples

Credit Funding list

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
      "created_at": "2020-08-24T14:15:22Z",
      "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
      "cash_amount": "200.00",
      "currency": "EUR",
      "status": "CONFIRMED",
      "remittance_information": "CF123456789",
      "counterparty": {
        "identification": {
          "name": "Max Musterman"
        },
        "account": {
          "identification": {
            "iban": "DE02100500000054540402"
          }
        }
      },
      "virtual_bank_account_id": "ab8f9b19-6a31-48d3-b201-4dee92f3da0d",
      "purpose_code": "OTHR"
    }
  ]
}

get/payments/credit_fundings/{credit_funding_id}

Retrieve a credit funding

credit_funding_idstring

required

Credit Funding request unique identifier

Format: uuid

Responses

Response examples

Credit Funding payment

{
  "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
  "created_at": "2020-08-24T14:15:22Z",
  "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
  "cash_amount": "200.00",
  "currency": "EUR",
  "status": "CONFIRMED",
  "remittance_information": "CF123456789",
  "counterparty": {
    "identification": {
      "name": "Max Musterman"
    },
    "account": {
      "identification": {
        "iban": "DE02100500000054540402"
      }
    }
  },
  "virtual_bank_account_id": "ab8f9b19-6a31-48d3-b201-4dee92f3da0d",
  "purpose_code": "OTHR"
}

webhook

Credit Funding events

idstring

required

Event unique identifier

Format: uuid

created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format: date-time

typestring

required

Event type

Default: "CREDIT_FUNDING.CONFIRMED"
Enum: CREDIT_FUNDING.CONFIRMED
CREDIT_FUNDING.CANCELLED

objectobject

required

idstring

required

Credit Funding request unique identifier

Format: uuid

created_atstring

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

Format: date-time

account_group_idstring

required

Account group unique identifier.

Format: uuid

cash_amountstring

required

Pattern: ^[0-9]{1,9}(\.[0-9]{2})?$

currencystring

required

Alphabetic three-letter ISO 4217 currency code.

EUR - Euro

Default: "EUR"
Enum: EUR

statusstring

Status of the credit funding

CONFIRMED - Credit Funding was confirmed.
CANCELLED - Credit Funding was cancelled.

Enum: CONFIRMED
CANCELLED

remittance_informationstring

required

Payment reference the one that was used by the end user for the corresponding SEPA Credit Transfer

counterpartyobject

required

virtual_bank_account_idstring

Virtual bank account request unique identifier.

Format: uuid

purpose_codestring

Purpose of the payment based on ExternalPurpose1Code from ISO 20022.

Max Length: 4

webhook_idstring

required

Webhook unique identifier.

Format: uuid

Responses

Request examples

{
  "id": "8962b496-8d42-4560-bfab-10490dd1a721",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "CREDIT_FUNDING.CONFIRMED",
  "object": {
    "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
    "created_at": "2020-08-24T14:15:22Z",
    "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
    "cash_amount": "200.00",
    "currency": "EUR",
    "status": "CONFIRMED",
    "remittance_information": "CF123456789",
    "counterparty": {
      "identification": {
        "name": "Max Musterman"
      },
      "account": {
        "identification": {
          "iban": "DE02100500000054540402"
        }
      }
    },
    "virtual_bank_account_id": "ab8f9b19-6a31-48d3-b201-4dee92f3da0d",
    "purpose_code": "OTHR"
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?