Skip to content
API Reference/
/
Retrieve a direct debit

Upvest Investment API (1.75.0)

Upvest Investment API.

Download OpenAPI description
api.json
api.yaml
Overview
URL

https://docs.upvest.co

Upvest API Support

api@upvest.co

License

Apache 2.0

Languages
Servers
Sandbox environment

https://sandbox.upvest.co/

Live environment

https://api.upvest.co/

Access Tokens

All authentication related paths.

Operations

Users

All user related paths.

OperationsWebhooks

User Identifiers

All user identifiers related paths.

Operations

User Checks

All user checks related paths.

OperationsWebhooks

Accounts

All accounts related paths

OperationsWebhooks

Account Groups

All account groups related paths

OperationsWebhooks

Tax Residencies

All tax residencies related paths.

Operations

Corporate Actions

All Corporate Action related paths.

Webhooks

Tax Exemptions

All tax exemptions related paths

OperationsWebhooks

Tax Collections

All tax collections related paths

Webhooks

Tax Wrappers

All tax wrappers related paths

OperationsWebhooks

Instruments

All instrument related paths.

OperationsWebhooks

Price Data

All price data related paths.

Operations

Orders

All order related paths.

OperationsWebhooks

Portfolios

All portfolios related paths.

Operations

Portfolios Rebalancing

All portfolios rebalancing related paths.

OperationsWebhooks

Savings Plans

All savings plans related paths.

OperationsWebhooks

Liquidations

All accounts liquidations related paths.

OperationsWebhooks

Direct Debits

All direct debits related paths

OperationsWebhooks

Trigger a direct debit

Request

Trigger a direct debit

Security
oauth-client-credentials
Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^Bearer [a-zA-Z0-9\-\._~+/]*=*required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example: Bearer c2VjcmV0Cg==
signaturestringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-inputstringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

idempotency-keystring(uuid)^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-f...required

A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency

Example: ccb07f42-4104-44ad-8e1f-c660bb7b269c
upvest-api-versionstring

Upvest API version (Note: Do not include quotation marks)

Default 1
Value"1"
Example: 1
Bodyapplication/json
user_idstring(uuid)required

User unique identifier.

account_group_idstring(uuid)required

Account group unique identifier.

mandate_idstring(uuid)required

Direct Debit Mandate unique identifier.

cash_amountstring^-?[0-9]{1,9}(\.[0-9]{2})?$required
currencystring

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default "EUR"
Value"EUR"
remittance_informationstring<= 140 characters^[0-9A-Za-z+?/\-:()\.,';_ ]{0,140}$

Payment reference the end user will see in their bank statement for the corresponding direct debit booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting (see more).

purpose_codestring<= 4 characters

Purpose of the payment based on ExternalPurpose1Code from ISO 20022.

curl -i -X POST \
  https://sandbox.upvest.co/payments/direct_debits \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'authorization: Bearer c2VjcmV0Cg==' \
  -H 'idempotency-key: ccb07f42-4104-44ad-8e1f-c660bb7b269c' \
  -H 'signature: string' \
  -H 'signature-input: string' \
  -H 'upvest-api-version: 1' \
  -H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062' \
  -d '{
    "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
    "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
    "mandate_id": "95b8304e-19fc-4cd9-8e50-82532e6b8d8c",
    "cash_amount": "200.00",
    "currency": "EUR",
    "remittance_information": "payment for green energy portfolio",
    "purpose_code": "OTHR"
  }'

Responses

Direct debit

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Bodyapplication/json
idstring(uuid)required

Direct debit funding request unique identifier

created_atstring(date-time)required

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

user_idstring(uuid)required

User unique identifier.

account_group_idstring(uuid)required

Account group unique identifier.

mandate_idstring(uuid)required

Direct Debit Mandate unique identifier.

cash_amountstring^-?[0-9]{1,9}(\.[0-9]{2})?$required
currencystringrequired

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default "EUR"
Value"EUR"
remittance_informationstring<= 140 characters^[0-9A-Za-z+?/\-:()\.,';_ ]{0,140}$

Payment reference the end user will see in their bank statement for the corresponding direct debit booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting (see more).

statusstring

Status of the direct debit

  • NEW - Direct debit is created but not started processing.
  • PROCESSING - Direct debit is in processing.
  • CONFIRMED - Direct debit was successfully processed.
  • CANCELLED - Direct debit was cancelled.
Enum"NEW""PROCESSING""CONFIRMED""CANCELLED"
purpose_codestring<= 4 characters

Purpose of the payment based on ExternalPurpose1Code from ISO 20022.

Response
application/json
{
  "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
  "created_at": "2020-08-24T14:15:22Z",
  "user_id": "82b49999-1145-4e05-916a-567662daa7bc",
  "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
  "mandate_id": "730b8719-0bc6-401d-98dd-b2de72afbf05",
  "cash_amount": "200.00",
  "currency": "EUR",
  "status": "NEW",
  "purpose_code": "OTHR"
}

Retrieve a direct debit

Request

Retrieve a direct debit

Security
oauth-client-credentials
Path
direct_debit_idstring(uuid)required

Direct debit funding request unique identifier

Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^Bearer [a-zA-Z0-9\-\._~+/]*=*required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example: Bearer c2VjcmV0Cg==
signaturestringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-inputstringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-versionstring

Upvest API version (Note: Do not include quotation marks)

Default 1
Value"1"
Example: 1
curl -i -X GET \
  'https://sandbox.upvest.co/payments/direct_debits/{direct_debit_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'authorization: Bearer c2VjcmV0Cg==' \
  -H 'signature: string' \
  -H 'signature-input: string' \
  -H 'upvest-api-version: 1' \
  -H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'

Responses

Direct debit payment

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Bodyapplication/json
idstring(uuid)required

Direct debit funding request unique identifier

created_atstring(date-time)required

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

user_idstring(uuid)required

User unique identifier.

account_group_idstring(uuid)required

Account group unique identifier.

mandate_idstring(uuid)required

Direct Debit Mandate unique identifier.

cash_amountstring^-?[0-9]{1,9}(\.[0-9]{2})?$required
currencystringrequired

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default "EUR"
Value"EUR"
remittance_informationstring<= 140 characters^[0-9A-Za-z+?/\-:()\.,';_ ]{0,140}$

Payment reference the end user will see in their bank statement for the corresponding direct debit booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting (see more).

statusstring

Status of the direct debit

  • NEW - Direct debit is created but not started processing.
  • PROCESSING - Direct debit is in processing.
  • CONFIRMED - Direct debit was successfully processed.
  • CANCELLED - Direct debit was cancelled.
Enum"NEW""PROCESSING""CONFIRMED""CANCELLED"
purpose_codestring<= 4 characters

Purpose of the payment based on ExternalPurpose1Code from ISO 20022.

Response
application/json
{
  "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
  "created_at": "2020-08-24T14:15:22Z",
  "user_id": "82b49999-1145-4e05-916a-567662daa7bc",
  "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
  "mandate_id": "730b8719-0bc6-401d-98dd-b2de72afbf05",
  "cash_amount": "200.00",
  "currency": "EUR",
  "remittance_information": "payment for green energy portfolio",
  "status": "NEW",
  "purpose_code": "OTHR"
}

Direct Debit eventsWebhook

Request

Direct Debit events

Bodyapplication/json
idstring(uuid)required

Event unique identifier

created_atstring(date-time)required

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

typestringrequired

Event type

Enum"DIRECT_DEBIT.NEW""DIRECT_DEBIT.PROCESSING""DIRECT_DEBIT.CONFIRMED""DIRECT_DEBIT.CANCELLED"
objectobjectrequired
idstring(uuid)required

Direct debit funding request unique identifier

created_atstring(date-time)required

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

user_idstring(uuid)required

User unique identifier.

account_group_idstring(uuid)required

Account group unique identifier.

mandate_idstring(uuid)required

Direct Debit Mandate unique identifier.

cash_amountstring^-?[0-9]{1,9}(\.[0-9]{2})?$required
currencystringrequired

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default "EUR"
Value"EUR"
remittance_informationstring<= 140 characters^[0-9A-Za-z+?/\-:()\.,';_ ]{0,140}$

Payment reference the end user will see in their bank statement for the corresponding direct debit booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting (see more).

statusstring

Status of the direct debit

  • NEW - Direct debit is created but not started processing.
  • PROCESSING - Direct debit is in processing.
  • CONFIRMED - Direct debit was successfully processed.
  • CANCELLED - Direct debit was cancelled.
Enum"NEW""PROCESSING""CONFIRMED""CANCELLED"
purpose_codestring<= 4 characters

Purpose of the payment based on ExternalPurpose1Code from ISO 20022.

webhook_idstring(uuid)required

Webhook unique identifier.

application/json
{
  "id": "8962b496-8d42-4560-bfab-10490dd1a721",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "DIRECT_DEBIT.NEW",
  "object": {
    "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
    "created_at": "2020-08-24T14:15:22Z",
    "user_id": "82b49999-1145-4e05-916a-567662daa7bc",
    "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
    "mandate_id": "730b8719-0bc6-401d-98dd-b2de72afbf05",
    "cash_amount": "200.00",
    "currency": "EUR",
    "remittance_information": "payment for green energy portfolio",
    "status": "NEW"
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Responses

Request has been processed successfully.

Top-ups

All top-ups related paths

OperationsWebhooks

Withdrawals

All withdrawals related paths

OperationsWebhooks

Reference Accounts

All reference account related paths

Operations

Mandates

All direct debit mandates related paths

Operations

Cash Balances

All cash balance related paths

OperationsWebhooks

Positions

All positions related paths.

OperationsWebhooks

Valuations

All valuations related paths.

OperationsWebhooks

Returns

All accounts returns related paths.

OperationsWebhooks

Virtual Cash Balances

All virtual cash balances related paths

OperationsWebhooks

Fees

All fees related paths.

OperationsWebhooks

Fees Configurations

All fees configurations related paths.

Operations

Reports

All reports related paths.

OperationsWebhooks

Treasury Reports

All treasury reports related paths.

Webhooks

Transactions

All transactions related paths.

OperationsWebhooks

Files

All files API related paths.

Operations

Webhook Subscriptions

All webhook subscriptions related paths.

Operations

Virtual Bank Accounts

All virtual bank accounts related paths

OperationsWebhooks

Tests

All test related paths.

Operations