Mandates (Creditor Profiles)

Get Creditor Profiles (paged)

Role Requirements

tenant-mandate-read or tenant-admin

Description

Obtain a paginated list of Creditor Profiles, regardless of their associated network. Creditor Profile entities returned by this operation will only include common attributes and a link to their full details.

Securitybearer
Request
query Parameters
from
integer <int32>
Default: 0

The item from which to start (skip from-1 items) the search.

take
integer <int32> [ 1 .. 1000 ]
Default: 100

The maximum number of items to return from the search.

header Parameters
x-account-id
required
string <uuid> [ 1 .. 50 ] characters

The Account Id.

x-tenant-id
required
string <uuid> (TenantIdV2) [ 1 .. 50 ] characters

The Tenant Id.

x-correlation-id
string

Correlation Id for the request.

Responses
200

A successful response containing a paginated list of Creditor Profiles.

401

Unauthorized

403

Forbidden

get/v2/mandates/creditor-profiles
Request samples 
Response samples 
application/json
{
  • "currentPage": 0,
  • "pageCount": 0,
  • "pageSize": 0,
  • "rowCount": 0,
  • "totalCount": 0,
  • "results": [
    • {
      • "creditorProfileRef": "fb39d6eb3ac44d6597f0f7221da5e663",
      • "profileName": "A_PROFILE_NAME_0",
      • "network": "SEPA",
      • "creditorIdentifier": "string",
      • "creditorName": "string",
      • "address": {
        • "houseNumberOrName": "123A",
        • "streetAddress": "Upper Great Street",
        • "extendedAddress": "string",
        • "postcode": "AB12 3CD",
        • "city": "London",
        • "country": "GB"
        },
      • "metadata": {
        • "property1": "string",
        • "property2": "string"
        }
      }
    ]
}
Create Creditor Profile
Role Requirements


tenant-mandate-write or tenant-admin


Description


Create a Creditor Profile.


Securitybearer 
Request 
header Parameters
x-account-id
required
string <uuid>   [ 1 .. 50 ] characters 
The Account Id.


 
x-tenant-id
required
string <uuid>  (TenantIdV2)   [ 1 .. 50 ] characters 
The Tenant Id.


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


 
Request Body schema: application/json
The full details of the new Creditor-Profile.


network
required
string (NetworkV2) 
The network scopes the context within which the Creditor Profile or
the Mandate is valid. For example a SEPA Mandate can be used to collect
euro-denominated payments between SEPA countries; a Bacs Creditor
Profile can only be associated with a Bacs Mandate.


 Enum: "Bacs" "SEPA" "BecsAu" "BecsNz" "Ach"  
creditorProfileRef
required
string (CreditorProfileRefV2)   [ 1 .. 50 ] characters ^[a-zA-Z0-9-_\.]+$
Unique reference identifier for the creditor profile. 
It accepts alphanumeric characters (a to z or digits), as well as the symbols -, _ and ..


 
profileName
required
string (ProfileNameV2)   [ 1 .. 100 ] characters 
A user-friendly name for the creditor profile that can easily be recognized.


 
creditorIdentifier
required
string  [ 1 .. 100 ] characters 
    

  • BACS: Service User Number (Digits only, 6 character limit)
    • 

  • SEPA: Identifier
    • 

  • BECS AU: Direct Debit User ID
    • 

  • BECS NZ: Authorisation Code
    • 

  • ACH: ACH Company ID
    • 



 
creditorName
required
string  [ 1 .. 100 ] characters 
The name as it will appear on the debtor's bank account statement.


 
object (CreditorProfileAddressRequestV2) 
Required for SEPA, BECS AU, BECS NZ and ACH


The address of the creditor profile.


 
object or null (MetadataV2) 
A collection of key-value pairs defined by the client. 
This object is subject to the following limits:


    

  • Maximum of 15 keys.
    • 

  • Keys have a maximum length of 64 characters.
    • 

  • Values have a maximum length of 256 characters.
    • 



 
Responses 
201
Creditor profile created.


400
Bad Request - Validation error response, containing errors such as:


    

  • The attribute CreditorProfileRef is required.
    • 

  • The attribute ProfileName is required.
    • 

  • The attribute ServiceUserNumber is required.
    • 

  • The attribute OrganizationName is required.
    • 



401
Unauthorized


403
Forbidden


post/v2/mandates/creditor-profiles
Request samples 
application/json
Example request of creating a BACS creditor profile


{
  • "network": "Bacs",
  • "creditorProfileRef": "org-bacs-profile-1234",
  • "profileName": "BACS Profile #1234",
  • "creditorIdentifier": "123456",
  • "creditorName": "Imburse"
}
Response samples 
application/json
CreditorProfileRef was not specified.


{
  • "title": "BAD_REQUEST",
  • "detail": "See validation errors.",
  • "timestamp": "2021-01-30T08:30:00Z",
  • "correlationId": "0HMB2TA322CA7:00000001",
  • "status": 400,
  • "traceId": "0HMB2TA322CA7:00000001",
  • "errors": [
    • {
      • "title": "REQUIRED_ATTRIBUTE",
      • "detail": "The attribute CreditorProfileRef is required",
      • "metadata": {
        • "PropertyName": "CreditorProfileRef",
        • "AttemptedValue": "null",
        • "ErrorMessage": "The attribute CreditorProfileRef is required"
        }
      }
    ]
}
Get Creditor Profile
Role Requirements


tenant-mandate-read or tenant-admin


Description


Returns the details of a Creditor Profile.


Securitybearer 
Request 
path Parameters
creditorProfileRef
required
string (CreditorProfileRefV2)   [ 1 .. 50 ] characters ^[a-zA-Z0-9-_\.]+$
Returns a creditor profile.


 
 Example:  fb39d6eb3ac44d6597f0f7221da5e663
header Parameters
x-account-id
required
string <uuid>   [ 1 .. 50 ] characters 
The Account Id.


 
x-tenant-id
required
string <uuid>  (TenantIdV2)   [ 1 .. 50 ] characters 
The Tenant Id.


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


 
Responses 
200
Returns a Creditor Profile.


401
Unauthorized


403
Forbidden


404
    

  • Not Found - Creditor Profile was not found.
    • 



get/v2/mandates/creditor-profiles/{creditorProfileRef}
Request samples 
Response samples 
application/json
{
  • "creditorProfileRef": "bacs-creditor-profile",
  • "profileName": "My BACS Creditor Profile",
  • "network": "Bacs",
  • "creditorIdentifier": "123456",
  • "creditorName": "Imburse"
}
Copyright 2024 Duck Creek Technologies. All Rights Reserved.