Skip to content
/
Credit Funding events

Upvest Investment API (1.76.0)

Upvest Investment API.

Download OpenAPI description
Upvest-Investment-API.v1.json
Upvest-Investment-API.v1.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

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

Virtual Bank Accounts

All virtual bank accounts related paths

OperationsWebhooks

Credit Fundings

All credit fundings related paths

OperationsWebhooks

Retrieve a credit funding

Request

Retrieve a credit funding

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

Credit 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/credit_fundings/{credit_funding_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

Credit Funding payment

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

Credit Funding request unique identifier

created_atstring(date-time)required

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

account_group_idstring(uuid)required

Account group 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_informationstringrequired

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

counterpartyobjectrequired
identificationobjectrequired
namestringrequired

Name of the counterparty

accountobjectrequired
identificationobjectrequired
ibanstring^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$required

International Bank Account Number IBAN.

statusstring

Status of the credit funding

  • CONFIRMED - Credit Funding was confirmed.
  • CANCELLED - Credit Funding was cancelled.
Enum"CONFIRMED""CANCELLED"
virtual_bank_account_idstring(uuid)

Virtual bank account request unique identifier.

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",
  "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
  "cash_amount": "200.00",
  "currency": "EUR",
  "status": "CONFIRMED",
  "remittance_information": "CF123456789",
  "counterparty": {
    "identification": { … },
    "account": { … }
  },
  "virtual_bank_account_id": "ab8f9b19-6a31-48d3-b201-4dee92f3da0d",
  "purpose_code": "OTHR"
}

Credit Funding eventsWebhook

Request

Credit Funding 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

Default "CREDIT_FUNDING.CONFIRMED"
Enum"CREDIT_FUNDING.CONFIRMED""CREDIT_FUNDING.CANCELLED"
objectobjectrequired
idstring(uuid)required

Credit Funding request unique identifier

created_atstring(date-time)required

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

account_group_idstring(uuid)required

Account group 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_informationstringrequired

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

counterpartyobjectrequired
identificationobjectrequired
namestringrequired

Name of the counterparty

accountobjectrequired
identificationobjectrequired
ibanstring^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,26}$required

International Bank Account Number IBAN.

statusstring

Status of the credit funding

  • CONFIRMED - Credit Funding was confirmed.
  • CANCELLED - Credit Funding was cancelled.
Enum"CONFIRMED""CANCELLED"
virtual_bank_account_idstring(uuid)

Virtual bank account request unique identifier.

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": "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": { … },
    "virtual_bank_account_id": "ab8f9b19-6a31-48d3-b201-4dee92f3da0d",
    "purpose_code": "OTHR"
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Responses

Request has been processed successfully.

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

Tests

All test related paths.

Operations