Provider Configurations

Get Provider Configuration

Role Requirements

tenant-mandate-read or tenant-admin

Description

Get Provider Configuration

Securitybearer
Request
path Parameters
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"
Example: SEPA
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 Provider Configuration.

401

Unauthorized

403

Forbidden

404
  • Not Found - Provider Configuration was not found.
get/v2/mandates/provider-configuration/{network}
Request samples 
Response samples 
application/json
{
  • "tenantId": "00998360-4902-4aab-9f78-cebf129528b3",
  • "mandateProvider": "Bottomline",
  • "network": "Bacs",
  • "validationProvider": "Bottomline",
  • "creditorProfileRef": "creditor-profile-123",
  • "clientName": "Imburse",
  • "clientEmail": "an-email@imbursepayments.com",
  • "clientMerchantId": "abc123",
  • "clientBankStatementName": "IMBURSE",
  • "providerPrivacyPolicyUrl": "https://imbursepayments.com/privacy-policy",
  • "notificationPeriod": 3
}
Create Provider Configuration
Role Requirements


tenant-mandate-write or tenant-admin


Description


Create Provider Configuration


Securitybearer 
Request 
path Parameters
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"  
 Example:  SEPA
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 provider configuration details.


mandateProvider
required
string or null (ProviderNameV2) 
The provider used to create or validation mandates


    

  • Bottomline: Bacs ONLY
    • 

  • GoCardless: Bacs, SEPA
    • 

  • Becs: BECS AU and NZ
    • 

  • Ach: ACH ONLY
    • 



 Enum: "Bottomline" "GoCardless" "Becs" "Ach"  
validationProvider
required
string or null (ProviderNameV2) 
The provider used to create or validation mandates


    

  • Bottomline: Bacs ONLY
    • 

  • GoCardless: Bacs, SEPA
    • 

  • Becs: BECS AU and NZ
    • 

  • Ach: ACH ONLY
    • 



 Enum: "Bottomline" "GoCardless" "Becs" "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 ..


 
clientName
required
string
The name of the client


 
clientEmail
required
string
A contact email address for the client


 
clientMerchantId
required
string
Merchant ID


 
clientBankStatementName
required
string
Name shown on the bank statement


 
notificationPeriod
required
integer (ProviderNotificationPeriod) 
Notification period in days 

Advanced notice period: the advance notice is the notice to the Payer (the person paying the Direct Debit), before the first Direct Debit is collected or when any changes are made to the amount, collection date or frequency of the Direct  Debit collection. The notice period can be amendment provided you have the agreement of your sponsoring bank. 

 The minimum notice period is 3 days for SEPA and BACS, 1 day for BECS AU and 2 days for BECS NZ.


 
clientTelephone
string or null
Telephone number of the client


 
Responses 
201
Provider Configuration was successfully created.


401
Unauthorized


403
Forbidden


404
    

  • Not Found - Provider Configuration was not found.
    • 



post/v2/mandates/provider-configuration/{network}
Request samples 
application/json
{
  • "mandateProvider": "Bottomline",
  • "validationProvider": "Bottomline",
  • "creditorProfileRef": "creditor-profile-123",
  • "clientName": "Imburse",
  • "clientEmail": "an-email@imbursepayments.com",
  • "clientMerchantId": "abc123",
  • "clientBankStatementName": "IMBURSE",
  • "notificationPeriod": 3
}
Response samples 
application/json
Provider Configuration already exists for this network.


{
  • "title": "BAD_REQUEST",
  • "detail": "See validation errors.",
  • "timestamp": "2021-01-30T08:30:00Z",
  • "correlationId": "0HMB2TA322CA7:00000001",
  • "status": 404,
  • "traceId": "0HMB2TA322CA7:00000001",
  • "errors": [
    • {
      • "title": "PROVIDER_CONFIGURATION_EXISTS",
      • "detail": "Provider Configuration already exists for this network."
      }
    ]
}
Update Provider Configuration
Role Requirements


tenant-mandate-write or tenant-admin


Description


Update Provider Configuration


Securitybearer 
Request 
path Parameters
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"  
 Example:  SEPA
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 amended provider configuration details.


mandateProvider
required
string or null (ProviderNameV2) 
The provider used to create or validation mandates


    

  • Bottomline: Bacs ONLY
    • 

  • GoCardless: Bacs, SEPA
    • 

  • Becs: BECS AU and NZ
    • 

  • Ach: ACH ONLY
    • 



 Enum: "Bottomline" "GoCardless" "Becs" "Ach"  
validationProvider
required
string or null (ProviderNameV2) 
The provider used to create or validation mandates


    

  • Bottomline: Bacs ONLY
    • 

  • GoCardless: Bacs, SEPA
    • 

  • Becs: BECS AU and NZ
    • 

  • Ach: ACH ONLY
    • 



 Enum: "Bottomline" "GoCardless" "Becs" "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 ..


 
clientName
required
string
The name of the client


 
clientEmail
required
string
A contact email address for the client


 
clientMerchantId
required
string
Merchant ID


 
clientBankStatementName
required
string
Name shown on the bank statement


 
notificationPeriod
required
integer (ProviderNotificationPeriod) 
Notification period in days 

Advanced notice period: the advance notice is the notice to the Payer (the person paying the Direct Debit), before the first Direct Debit is collected or when any changes are made to the amount, collection date or frequency of the Direct  Debit collection. The notice period can be amendment provided you have the agreement of your sponsoring bank. 

 The minimum notice period is 3 days for SEPA and BACS, 1 day for BECS AU and 2 days for BECS NZ.


 
clientTelephone
string or null
Telephone number of the client


 
Responses 
200
Provider Configuration was successfully created.


401
Unauthorized


403
Forbidden


404
    

  • Not Found - Provider Configuration was not found.
    • 



put/v2/mandates/provider-configuration/{network}
Request samples 
application/json
{
  • "mandateProvider": "Bottomline",
  • "validationProvider": "Bottomline",
  • "creditorProfileRef": "creditor-profile-123",
  • "clientName": "Imburse",
  • "clientEmail": "an-email@imbursepayments.com",
  • "clientMerchantId": "abc123",
  • "clientBankStatementName": "IMBURSE",
  • "notificationPeriod": 3
}
Response samples 
application/json
Provider Configuration does not exist.


{
  • "title": "BAD_REQUEST",
  • "detail": "See validation errors.",
  • "timestamp": "2021-01-30T08:30:00Z",
  • "correlationId": "0HMB2TA322CA7:00000001",
  • "status": 404,
  • "traceId": "0HMB2TA322CA7:00000001",
  • "errors": [
    • {
      • "title": "PROVIDER_CONFIGURATION_NOT_FOUND",
      • "detail": "Provider Configuration does not exist"
      }
    ]
}
Delete Provider Configuration
Role Requirements


tenant-mandate-write or tenant-admin


Description


Delete Provider Configuration


Securitybearer 
Request 
path Parameters
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"  
 Example:  SEPA
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
Provider Configuration was successfully deleted.


401
Unauthorized


403
Forbidden


404
    

  • Not Found - Provider Configuration was not found.
    • 



delete/v2/mandates/provider-configuration/{network}
Request samples 
Response samples 
application/json
Provider Configuration does not exist.


{
  • "title": "BAD_REQUEST",
  • "detail": "See validation errors.",
  • "timestamp": "2021-01-30T08:30:00Z",
  • "correlationId": "0HMB2TA322CA7:00000001",
  • "status": 404,
  • "traceId": "0HMB2TA322CA7:00000001",
  • "errors": [
    • {
      • "title": "PROVIDER_CONFIGURATION_NOT_FOUND",
      • "detail": "Provider Configuration does not exist"
      }
    ]
}
Copyright 2024 Duck Creek Technologies. All Rights Reserved.