Activate SEPA Mandate

PUT 
/mandates/:mandateId/activate

Initiate the activation of a mandate, enabling it for payment processing.

Request

Path Parameters

mandateId stringrequired

Possible values: <= 39 characters

Unique identifier.

Header Parameters

Content-Type stringrequired

Must be application/json

Accept-Language stringrequired

Must be be en-US

Origin stringrequired

The origin of the request

User-Agent stringrequired

The client making the request

application/json

Body

required

mandateSignedLocation stringnullable

Possible values: <= 255 characters

Location where the mandate was signed.

mandateDateOfSignature daterequired

Possible values: <= 11 characters

Mandate date of the signature. Must be in ISO date format (e.g., "YYYY-MM-DD").

mandateAcceptance stringrequired

Possible values: [OFFLINE, ONLINE]

Mandate acceptance. Should be either "ONLINE" or "OFFLINE".

Responses

200

Mandate activated successfully

application/json

Schema

Schema

id stringrequired

Possible values: <= 39 characters

Unique identifier of the activated mandate.

object stringrequired

Possible values: <= 39 characters

Always MANDATE.

createdAt stringrequired

Possible values: <= 25 characters

Timestamp of the mandate creation.

storedPaymentOptionReference stringrequired

Possible values: <= 100 characters

Reference to the created stored payment option.

mandateSignedLocation string

Possible values: <= 255 characters

Location where the mandate was signed.

mandateDateOfSignature daterequired

Possible values: <= 11 characters

Mandate date of the signature. Must be in ISO date format (e.g., "YYYY-MM-DD").

mandateAcceptance stringrequired

Possible values: [OFFLINE, ONLINE]

Mandate acceptance. Should be either "ONLINE" or "OFFLINE".

Example (from schema)

{
  "id": "string",
  "object": "string",
  "createdAt": "string",
  "storedPaymentOptionReference": "string",
  "mandateSignedLocation": "string",
  "mandateDateOfSignature": "2024-07-29",
  "mandateAcceptance": "OFFLINE"
}

SEPA B2B

Activate SEPA B2B mandate

{
  "mandateSignedLocation": "Berlin",
  "mandateDateOfSignature": "2024-08-22",
  "mandateAcceptance": "OFFLINE"
}

SEPA Core

Activate SEPA Core mandate

{
  "storedPaymentOptionReference": "8ac7a4a266c593040166d4b7d08e2201",
  "mandateSignedLocation": "Berlin",
  "mandateDateOfSignature": "2024-08-22",
  "mandateAcceptance": "OFFLINE"
}

400

Bad Request

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Value out of bounds. Value must be between 1 and 100",
      "code": "value_out_of_bounds",
      "property": "someField",
      "context": {
        "minimum": 1,
        "maximum": 100
      }
    }
  ]
}

401

Unauthenticated

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You are not authenticated to perform this request.",
      "code": "unauthorized"
    }
  ]
}

403

Forbidden

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You do not have permissions to perform this request.",
      "code": "forbidden"
    }
  ]
}

404

Not Found

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Resource not found.",
      "code": "not_found"
    }
  ]
}

500

Internal Server Error

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Internal server error."
    }
  ]
}

Loading...