Credit Fundings

Retrieve a credit funding

Returns the credit funding specified by its ID, including its status, cash amount, and counterparty details.

get/payments/credit_fundings/{credit_funding_id}

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/payments/credit_fundings/{credit_funding_id}
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: credit_fundings:read, payments:admin, payments:read)

Response

Credit Funding payment

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

Universally Unique Identifier (UUID) of the account group.

cash_amountstring required

A positive cash amount, as a decimal string with up to two decimal places.

currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR — Euro.
  • GBP — Pound Sterling.
status'CONFIRMED' | 'CANCELLED'

Status of the credit funding

  • CONFIRMED - Credit Funding was confirmed.
  • CANCELLED - Credit Funding was cancelled.
remittance_informationstring required

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

virtual_bank_account_idstring uuid

Virtual bank account request unique identifier.

purpose_codestring

Purpose of the payment based on ExternalPurpose1Code from ISO 20022.

Changes

No recorded changes to this operation across all 25 revisions of this API.