v2

latestOpenAPI 3.0.3Apache 2.02026-08-0715707.5 MB

Reference Accounts

Create a reference account

Creates a new reference account for a user or business specified by ID.

post/payments/reference_accounts

idempotency-keystring uuid required

Example:ccb07f42-4104-44ad-8e1f-c660bb7b269c

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

user_idstring uuid

User unique identifier.

business_idstring uuid

Unique identifier for the business.

account_ownerstring required

Name of the reference account holder

namestring

Human-readable name of the reference bank account

ibanstring required

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

Reference account created.

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