Mandates

Retrieve a direct debit mandate

Retrieve a direct debit mandate.

The response contains either user_id or business_id depending on whether the mandate belongs to a user or business account.

get/payments/mandates/{mandate_id}

Request

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

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.