Mandates

Validate SEPA Direct Debit Core configuration.

Role Requirements

tenant-mandate-read or tenant-admin

Description

Validates that a the SEPA Direct Debit Core configuration is valid.

Securitybearer
Request
header Parameters
x-account-id
required
string

The Account Id.

x-tenant-id
required
string

The Tenant Id.

x-correlation-id
string

Correlation Id for the request.

Responses
200

Success

401

Unauthorized

403

Forbidden

get/v1/mandates/configuration/sepa-direct-debit-core/validate
Request samples 
Response samples 
application/json
{
  • "isValid": true,
  • "validationMessages": [
    • "string"
    ]
}
Create a SEPA Direct Debit Core configuration.
Role Requirements


tenant-mandate-write or tenant-admin


Description


Create or update a SEPA Direct Debit Core configuration.


Securitybearer 
Request 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Request Body schema: 
iban
string
 
bic
string
 
object (AddressDto) 
 
Responses 
200
Success


401
Unauthorized


403
Forbidden


post/v1/mandates/configuration/sepa-direct-debit-core
Request samples 
{
  • "iban": "string",
  • "bic": "string",
  • "address": {
    • "streetAddress": "string",
    • "extendedAddress": "string",
    • "locality": "string",
    • "region": "string",
    • "postcode": "string",
    • "country": "string"
    }
}
Get SEPA Direct Debit Core configuration.
Role Requirements


tenant-mandate-read or tenant-admin


Description


Get the SEPA Direct Debit Core configuration


Securitybearer 
Request 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Responses 
200
Success


401
Unauthorized


403
Forbidden


get/v1/mandates/configuration/sepa-direct-debit-core
Request samples 
Response samples 
application/json
{
  • "iban": "string",
  • "bic": "string",
  • "address": {
    • "streetAddress": "string",
    • "extendedAddress": "string",
    • "locality": "string",
    • "region": "string",
    • "postcode": "string",
    • "country": "string"
    }
}
Update a SEPA Direct Debit Core configuration.
Role Requirements


tenant-mandate-write or tenant-admin


Description


Create or update a SEPA Direct Debit Core configuration.


Securitybearer 
Request 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Request Body schema: 
iban
string
 
bic
string
 
object (AddressDto) 
 
Responses 
200
Success


401
Unauthorized


403
Forbidden


put/v1/mandates/configuration/sepa-direct-debit-core
Request samples 
{
  • "iban": "string",
  • "bic": "string",
  • "address": {
    • "streetAddress": "string",
    • "extendedAddress": "string",
    • "locality": "string",
    • "region": "string",
    • "postcode": "string",
    • "country": "string"
    }
}
Delete SEPA Direct Debit Core configuration.
Role Requirements


tenant-mandate-write or tenant-admin


Description


Delete an existing SEPA Direct Debit Core configuration.


Securitybearer 
Request 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Responses 
200
Success


401
Unauthorized


403
Forbidden


delete/v1/mandates/configuration/sepa-direct-debit-core
Request samples 
Create a Mandate
Role Requirements


tenant-admin


Description


Create a Mandate.


Securitybearer 
Request 
header Parameters
authorization
string
 Default:  
 
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Request Body schema: 
customerRef
string
 
object (Debtor) 
 
object (Creditor) 
 
firstCollectionDate
string
 
paymentType
string
 
dateSigned
string
 
Array of objects (Signature) 
 
documentTemplateId
string
 
object
 
Responses 
200
Success


401
Unauthorized


403
Forbidden


post/v1/mandates/sepa-direct-debit-core
Request samples 
{
  • "customerRef": "string",
  • "debtor": {
    • "name": "string",
    • "address": {
      • "streetAddress": "string",
      • "extendedAddress": "string",
      • "locality": "string",
      • "region": "string",
      • "postcode": "string",
      • "country": "string"
      },
    • "iban": "string",
    • "bic": "string"
    },
  • "creditor": {
    • "name": "string",
    • "identifier": "string"
    },
  • "firstCollectionDate": "string",
  • "paymentType": "string",
  • "dateSigned": "string",
  • "signatures": [
    • {
      • "type": "string",
      • "name": "string",
      • "value": "string"
      }
    ],
  • "documentTemplateId": "string",
  • "metadata": {
    • "property1": "string",
    • "property2": "string"
    }
}
Response samples 
application/json
{
  • "mandateReference": "string",
  • "financialInstrumentId": "35596f91-fea9-4297-b70b-01fdad24e25a"
}
Get a Mandate
Role Requirements


tenant-admin


Description


Get a Mandate by its Mandate Reference.


Securitybearer 
Request 
path Parameters
mandateReference
required
string
 Default:  ""
The Mandate Reference.


 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Responses 
200
Success


401
Unauthorized


403
Forbidden


get/v1/mandates/sepa-direct-debit-core/{mandateReference}
Request samples 
Response samples 
application/json
{
  • "mandateReference": "string",
  • "customerRef": "string",
  • "financialInstrumentId": "35596f91-fea9-4297-b70b-01fdad24e25a",
  • "debtor": {
    • "name": "string",
    • "address": {
      • "streetAddress": "string",
      • "extendedAddress": "string",
      • "locality": "string",
      • "region": "string",
      • "postcode": "string",
      • "country": "string"
      },
    • "iban": "string",
    • "bic": "string"
    },
  • "creditor": {
    • "name": "string",
    • "identifier": "string"
    },
  • "firstCollectionDate": "string",
  • "paymentType": "string",
  • "dateSigned": "string",
  • "signatures": [
    • {
      • "type": "string",
      • "name": "string",
      • "value": "string"
      }
    ],
  • "network": "string",
  • "mandateSigningType": "string",
  • "status": "string",
  • "documentTemplateId": "string",
  • "documentId": "string",
  • "documentLocation": "string",
  • "metadata": {
    • "property1": "string",
    • "property2": "string"
    },
  • "createdTimestamp": 0,
  • "updatedTimestamp": 0
}
Download a Mandate
Role Requirements


tenant-mandate-read or tenant-admin


Description


Download a Mandate using its Mandate Reference and DocumentId.


Securitybearer 
Request 
path Parameters
mandateReference
required
string
 Default:  ""
The mandate reference.


 
documentId
required
string
 Default:  ""
The id of the document to download


 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Responses 
200
Success


401
Unauthorized


403
Forbidden


get/v1/mandates/{mandateReference}/download/{documentId}.pdf
Request samples 
Copyright 2024 Duck Creek Technologies. All Rights Reserved.