Mandates

Create a mandate

Create a mandate.

Supports both user and business accounts. Provide user_id for user flows or business_id for business flows — exactly one must be specified.

post/payments/mandates

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/payments/mandates
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: mandates:admin)

Headers

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

Request body

user_idstring uuid

Unique identifier of the user, as a UUID.

business_idstring uuid

Unique identifier for the business.

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 mandate

Response

Mandate

idstring uuid required

Direct Debit Mandate unique identifier.

created_atstring date-time required

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

user_idstring uuid

Unique identifier of the user, as a UUID.

business_idstring uuid

Unique identifier for the business.

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.

creditor_namestring required

Name of the creditor on the mandate.

creditor_idstring required

Banking identifier of the creditor.

type'RECURRENT' required

Type of mandate.

  • RECURRENT -
confirmed_atstring date-time required

Timestamp of when user validated the mandate

Changes

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