Reference Accounts

Get a reference account by ID

Retrieves the reference account specified by its ID.

get/payments/reference_accounts/{reference_account_id}

Request

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

Response

OK

idstring uuid required

Reference account unique identifier.

created_atstring date-time required

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

updated_atstring date-time required

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

user_idstring uuid

Unique identifier of the user, as a UUID.

business_idstring uuid

Unique identifier for the business.

account_ownerstring required

Name of the reference account holder

namestring required

Human-readable name of the reference bank account

ibanstring required

Obfuscated International Bank Account Number IBAN.

bicstring required

Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) ISO 9362.

confirmed_atstring date-time required

Timestamp of when user validated the reference account

Changes

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