Payout Schemes

Payout Scheme operations

Get a Payout Scheme

Role Requirements

tenant-payout-scheme-read or tenant-admin

Description

Gets a Payout Scheme by the schemeId.

Securitybearer
Request
path Parameters
schemeId
required
string

The Scheme Id.

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

Returns the Payout Scheme response.

400

Bad Request - Returns the Error response object.

401

Unauthorised

403

Forbidden - If the API user does not have one of the roles listed in Role Requirements above.

get/v2/schemes/payout/{schemeId}
Request samples 
Response samples 
application/json
{
  • "schemeId": "string",
  • "publishedDraftId": "f146684a-35bf-4b8f-9c19-2d070befcb82",
  • "drafts": [
    • {
      • "draftId": "dfb8a430-52c9-4ba8-8878-6bd070da9488",
      • "name": "string",
      • "code": "string",
      • "rules": [
        • {
          • "priority": 0,
          • "currencies": [
            • "GBP"
            ],
          • "countries": [
            • "UK"
            ],
          • "highValueInclusive": 0,
          • "lowValueInclusive": 0,
          • "apps": [
            • {
              • "appId": "string",
              • "availablePaymentMethods": [
                • null
                ],
              • "excludedPaymentMethods": [
                • null
                ]
              }
            ]
          }
        ],
      • "lastModified": "2019-08-24T14:15:22Z"
      }
    ]
}
Delete a Payout Scheme
Role Requirements


tenant-payout-scheme-write or tenant-admin


Description


Delete a Payout Scheme by the schemeId.


Securitybearer 
Request 
path Parameters
schemeId
required
string
The Scheme Id.


 
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 
204
No Content


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


delete/v2/schemes/payout/{schemeId}
Request samples 
Gets the published Payout Scheme draft 
Role Requirements


tenant-payout-scheme-read or tenant-admin


Description


Gets the published draft of a Payout Scheme by the schemeId.


Securitybearer 
Request 
path Parameters
schemeId
required
string
The Scheme Id.


 
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
Returns the Payout Draft response.


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


get/v2/schemes/payout/{schemeId}/published
Request samples 
Response samples 
application/json
{
  • "draftId": "dfb8a430-52c9-4ba8-8878-6bd070da9488",
  • "name": "string",
  • "code": "string",
  • "rules": [
    • {
      • "priority": 0,
      • "currencies": [
        • "GBP"
        ],
      • "countries": [
        • "UK"
        ],
      • "highValueInclusive": 0,
      • "lowValueInclusive": 0,
      • "apps": [
        • {
          • "appId": "string",
          • "availablePaymentMethods": [
            • "string"
            ],
          • "excludedPaymentMethods": [
            • "string"
            ]
          }
        ]
      }
    ],
  • "lastModified": "2019-08-24T14:15:22Z"
}
Gets the latest Payout Scheme draft
Role Requirements


tenant-payout-scheme-read or tenant-admin


Description


Gets the latest draft of a Payout Scheme by the schemeId.


Securitybearer 
Request 
path Parameters
schemeId
required
string
The Scheme Id.


 
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
Returns the Payout Draft response.


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


get/v2/schemes/payout/{schemeId}/latest
Request samples 
Response samples 
application/json
{
  • "draftId": "dfb8a430-52c9-4ba8-8878-6bd070da9488",
  • "name": "string",
  • "code": "string",
  • "rules": [
    • {
      • "priority": 0,
      • "currencies": [
        • "GBP"
        ],
      • "countries": [
        • "UK"
        ],
      • "highValueInclusive": 0,
      • "lowValueInclusive": 0,
      • "apps": [
        • {
          • "appId": "string",
          • "availablePaymentMethods": [
            • "string"
            ],
          • "excludedPaymentMethods": [
            • "string"
            ]
          }
        ]
      }
    ],
  • "lastModified": "2019-08-24T14:15:22Z"
}
Get a Payout Scheme draft
Role Requirements


tenant-payout-scheme-read or tenant-admin


Description


Gets a Payout Scheme draft by the schemeId and draftId.


Securitybearer 
Request 
path Parameters
schemeId
required
string
The Scheme Id.


 
draftId
required
string
The Draft Id.


 
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
Returns the Payout Draft response.


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


get/v2/schemes/payout/{schemeId}/drafts/{draftId}
Request samples 
Response samples 
application/json
{
  • "draftId": "dfb8a430-52c9-4ba8-8878-6bd070da9488",
  • "name": "string",
  • "code": "string",
  • "rules": [
    • {
      • "priority": 0,
      • "currencies": [
        • "GBP"
        ],
      • "countries": [
        • "UK"
        ],
      • "highValueInclusive": 0,
      • "lowValueInclusive": 0,
      • "apps": [
        • {
          • "appId": "string",
          • "availablePaymentMethods": [
            • "string"
            ],
          • "excludedPaymentMethods": [
            • "string"
            ]
          }
        ]
      }
    ],
  • "lastModified": "2019-08-24T14:15:22Z"
}
Delete a Payout Scheme draft
Role Requirements


tenant-payout-scheme-write or tenant-admin


Description


Delete a Payout Scheme draft by the schemeId and draftId.


Securitybearer 
Request 
path Parameters
schemeId
required
string
The Scheme Id.


 
draftId
required
string
The Draft Id.


 
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 
204
No Content


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


delete/v2/schemes/payout/{schemeId}/drafts/{draftId}
Request samples 
Create new draft for a Payout Scheme
Role Requirements


tenant-payout-scheme-write or tenant-admin


Description


Creates a new draft for an existing Payout Scheme.


Securitybearer 
Request 
path Parameters
schemeId
required
string
The Scheme Id.


 
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: 
name
string or null
The name of this Scheme.


 
code
string or null
Optional code to attribute to the Scheme.


 
Array of objects or null (PayoutRuleRequest) 
A list of the Rules attached to the Scheme.


 
Responses 
200
Returns the Payout Draft response.


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


post/v2/schemes/payout/{schemeId}/drafts
Request samples 
{
  • "name": "string",
  • "code": "string",
  • "rules": [
    • {
      • "currencies": [
        • "GBP"
        ],
      • "countries": [
        • "UK"
        ],
      • "highValueInclusive": "string",
      • "lowValueInclusive": "string",
      • "apps": [
        • {
          • "appId": "string",
          • "excludedPaymentMethods": [
            • "string"
            ]
          }
        ]
      }
    ]
}
Response samples 
application/json
{
  • "draftId": "dfb8a430-52c9-4ba8-8878-6bd070da9488",
  • "name": "string",
  • "code": "string",
  • "rules": [
    • {
      • "priority": 0,
      • "currencies": [
        • "GBP"
        ],
      • "countries": [
        • "UK"
        ],
      • "highValueInclusive": 0,
      • "lowValueInclusive": 0,
      • "apps": [
        • {
          • "appId": "string",
          • "availablePaymentMethods": [
            • "string"
            ],
          • "excludedPaymentMethods": [
            • "string"
            ]
          }
        ]
      }
    ],
  • "lastModified": "2019-08-24T14:15:22Z"
}
Publish a draft for a Payout Scheme
Role Requirements


tenant-payout-scheme-write or tenant-admin


Description


Publishes a draft for a Payout Scheme by the schemeId and draftId.


Securitybearer 
Request 
path Parameters
schemeId
required
string
The Scheme Id.


 
draftId
required
string
The Draft Id.


 
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
Returns the Payout Scheme response.


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


post/v2/schemes/payout/{schemeId}/drafts/{draftId}/publish
Request samples 
Response samples 
application/json
{
  • "schemeId": "string",
  • "publishedDraftId": "f146684a-35bf-4b8f-9c19-2d070befcb82",
  • "drafts": [
    • {
      • "draftId": "dfb8a430-52c9-4ba8-8878-6bd070da9488",
      • "name": "string",
      • "code": "string",
      • "rules": [
        • {
          • "priority": 0,
          • "currencies": [
            • "GBP"
            ],
          • "countries": [
            • "UK"
            ],
          • "highValueInclusive": 0,
          • "lowValueInclusive": 0,
          • "apps": [
            • {
              • "appId": "string",
              • "availablePaymentMethods": [
                • null
                ],
              • "excludedPaymentMethods": [
                • null
                ]
              }
            ]
          }
        ],
      • "lastModified": "2019-08-24T14:15:22Z"
      }
    ]
}
Get Payout Scheme options
Role Requirements


tenant-payout-scheme-read or tenant-admin


Description


Gets the payout options available for a Payout Scheme by the schemeId.


Securitybearer 
Request 
path Parameters
schemeId
required
string
The Scheme Id.


 
 Example:  3E082D9CDDF93879CA9F17E60C12C6E5
query Parameters
amount
required
string
The Amount.


 
 Example:  amount=10
currency
required
string
The Currency Code.


 
 Example:  currency=GBP
country
required
string
The Country Code.


 
 Example:  country=GB
matchType
string
The Match Type.


 
capabilities
string
 Default:  ""
Comma delimited capabilities.


 
 Example:  capabilities=financialInstrumentReady
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
Returns the Payout Options response.


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


get/v2/schemes/payout/{schemeId}/options
Request samples 
Response samples 
application/json
{
  • "matchedRulePriority": 1,
  • "payments": [
    • {
      • "type": "PAYMENTS",
      • "paymentType": "BACS_DIRECT_CREDIT",
      • "paymentOptions": [
        • {
          • "id": "BACS_DIRECT_CREDIT",
          • "name": "BACS Direct Credit",
          • "iconName": "payment-icons/bacs",
          • "appId": "BOTTOMLINE",
          • "appName": "Bottomline",
          • "whitelabel": {
            • "componentName": "bacs-financial-instrument",
            • "appBrandName": "Bacs Direct Credit"
            },
          • "capabilities": {
            • "usesRedirect": true,
            • "financialInstrumentReady": false,
            • "supportsMotoTransactions": false
            }
          }
        ]
      }
    ]
}
Get a preview of Payout Scheme options
Role Requirements


tenant-payout-scheme-read or tenant-admin


Description


Gets a preview of the payout options available for a Payout Scheme by the schemeId.


Securitybearer 
Request 
query Parameters
amount
required
string
The Amount.


 
currency
required
string
The Currency Code.


 
country
required
string
The Country Code.


 
matchType
string
The Match Type.


 
capabilities
string
 Default:  ""
Comma delimited capabilities.


 
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: 
name
string or null
The name of this Scheme.


 
code
string or null
Optional code to attribute to the Scheme.


 
Array of objects or null (PayoutRuleRequest) 
A list of the Rules attached to the Scheme.


 
Responses 
200
Returns the Payout Options response.


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


post/v2/schemes/payout/options-preview
Request samples 
{
  • "name": "string",
  • "code": "string",
  • "rules": [
    • {
      • "currencies": [
        • "GBP"
        ],
      • "countries": [
        • "UK"
        ],
      • "highValueInclusive": "string",
      • "lowValueInclusive": "string",
      • "apps": [
        • {
          • "appId": "string",
          • "excludedPaymentMethods": [
            • "string"
            ]
          }
        ]
      }
    ]
}
Response samples 
application/json
{
  • "matchedRulePriority": 1,
  • "payments": [
    • {
      • "type": "PAYMENTS",
      • "paymentType": "BACS_DIRECT_CREDIT",
      • "paymentOptions": [
        • {
          • "id": "BACS_DIRECT_CREDIT",
          • "name": "BACS Direct Credit",
          • "iconName": "payment-icons/bacs",
          • "appId": "BOTTOMLINE",
          • "appName": "Bottomline",
          • "whitelabel": {
            • "componentName": "bacs-financial-instrument",
            • "appBrandName": "Bacs Direct Credit"
            },
          • "capabilities": {
            • "usesRedirect": true,
            • "financialInstrumentReady": false,
            • "supportsMotoTransactions": false
            }
          }
        ]
      }
    ]
}
Get list of Payout Scheme summaries
Role Requirements


tenant-payout-scheme-read or tenant-admin


Description


Gets a list of all Payout Scheme summaries.


Securitybearer 
Request 
query Parameters
sortColumn
string
 
sortDirection
string
 
searchColumn
string
 
searchValue
string
 
isLatestDraftPublished
boolean
 
from
integer <int32> 
 Default:  0
 
take
integer <int32> 
 Default:  100
 
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
OK - Returns the Payout Scheme summaries response.


400
Bad Request - Returns the Error response object.


401
Unauthorised


403
Forbidden - If the API user does not have one of the roles listed in Role Requirements above.


get/v2/schemes/payout
Request samples 
Response samples 
application/json
{
  • "currentPage": 0,
  • "pageCount": 0,
  • "pageSize": 0,
  • "rowCount": 0,
  • "totalCount": 0,
  • "results": [
    • {
      • "schemeId": "string",
      • "name": "string",
      • "code": "string",
      • "latestDraftId": "3c9d3e6a-b749-4243-90f3-c6a0fd7b1172",
      • "publishedDraftId": "f146684a-35bf-4b8f-9c19-2d070befcb82",
      • "isLatestDraftPublished": true,
      • "lastModified": "2019-08-24T14:15:22Z"
      }
    ]
}
Copyright 2025 Duck Creek Technologies. All Rights Reserved.