Upvest Investment API.
API Reference/- List credit fundings
Retrieve funding details
Retrieve a credit funding
Credit Funding events
List credit fundings
Upvest Investment API (1.76.0)
Overview
Languages
Servers
Sandbox environment
https://sandbox.upvest.co/
Live environment
https://api.upvest.co/
Headers
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
Example: Bearer c2VjcmV0Cg==
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
- Sandbox environment
https://sandbox.upvest.co/account_groups/{account_group_id}/payments/credit_funding_details
- Live environment
https://api.upvest.co/account_groups/{account_group_id}/payments/credit_funding_details
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/account_groups/{account_group_id}/payments/credit_funding_details?limit=100&offset=0' \
-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'Funding Details
Owner of the virtual bank account
Response
application/json
{ "meta": { "offset": 0, "limit": 100, "count": 1, "total_count": 1, "sort": "created_at", "order": "ASC" }, "data": [ { … }, { … } ] }
Query
Field of resource to sort by
Default "created_at"
Value"created_at"
Example: sort=created_at
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"
Use the limit argument to specify the maximum number of items returned.
Default 100
Headers
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
Example: Bearer c2VjcmV0Cg==
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
- Sandbox environment
https://sandbox.upvest.co/account_groups/{account_group_id}/payments/credit_fundings
- Live environment
https://api.upvest.co/account_groups/{account_group_id}/payments/credit_fundings
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/account_groups/{account_group_id}/payments/credit_fundings?sort=created_at&order=ASC&limit=100&offset=0' \
-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'Credit Funding list
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Payment reference the one that was used by the end user for the corresponding SEPA Credit Transfer
International Bank Account Number IBAN.
Status of the credit funding
- CONFIRMED - Credit Funding was confirmed.
- CANCELLED - Credit Funding was cancelled.
Enum"CONFIRMED""CANCELLED"
Purpose of the payment based on ExternalPurpose1Code from ISO 20022.
Response
application/json
{ "meta": { "offset": 0, "limit": 100, "count": 1, "total_count": 1, "sort": "id", "order": "ASC" }, "data": [ { … } ] }
Headers
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
Example: Bearer c2VjcmV0Cg==
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
- Sandbox environment
https://sandbox.upvest.co/payments/credit_fundings/{credit_funding_id}
- Live environment
https://api.upvest.co/payments/credit_fundings/{credit_funding_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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'Credit Funding payment
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Payment reference the one that was used by the end user for the corresponding SEPA Credit Transfer
International Bank Account Number IBAN.
Status of the credit funding
- CONFIRMED - Credit Funding was confirmed.
- CANCELLED - Credit Funding was cancelled.
Enum"CONFIRMED""CANCELLED"
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" }