Download OpenAPI specification:Download
This is the documentation for the PTX Payments API.
The PTX Payments API is organized around REST and is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors.
We use built-in HTTP features, like HTTP authentication and HTTP verbs (methods), which can be understood by off-the-shelf HTTP clients, and we support cross-origin resource sharing to allow you to interact securely with our API.
The URL you will target depends on how you're using the service:
◦ If testing against our online RESTful API: https://payments.cat.uk.pt-x.com/
◦ If in production with our online RESTful API: https://uk.pt-x.com/
◦ If using your own network, you'll need to use the URL/IP address on which you are hosting the service.
PTX uses conventional HTTP response codes to indicate the success or failure of an API request.
Any unsuccessful response codes will contain more information to help you to identify the cause of the problem.
In general:
Authenticate your account by performing a handshake to obtain a CSRF token and JSESSIONID, these are used in the login request. All API calls should then contain the header information obtained from the handshake and authentication and must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
The authentication will expire after approximately 10 minutes and the process will then need to be repeated.
First perform the handshake with the API to obtain the CSRF token and the JSESSIONID:
GET /payments-service/api/security/handshake
Extract the JSESSIONID cookie from the Set-Cookie field in the response cookie (not the header response), extracting the ID only (highlighted in bold in the example below):
JSESSIONID=yGQz2iZLf8mDb2D7M8nL0f8cxFcjNwBjVimJab8C41kUiNTkVyMA!1781984570.node01; path=/; HttpOnly; Secure;
Then extract the CSRF Token from the X-CSRF field in the response header.
The JSESSIONID and CSRF are then used in the login request header below.
Using the JSESSIONID cookie, and X-CSRF header token from the handshake call, make a POST call to this URL:
/payments-service/api/security/login HTTP/1.1
Ensure to include the following additional, mandatory headers:
User-Agent:api-v2.5
Content-Type:application/json
Note: Items in bold are fixed/mandatory.
POST /payments-service/api/security/login HTTP/1.1
Host:payments.cat.uk.pt-x.com
User-Agent:api-v2.5
Cookie:JSESSIONID=Ig3ayRxj1vV17QzUrqPRj-OPgIkQ4Vtihj3lu09TRgt135wAcjQF!-1331583496.node01; TS010ce9a5=0188c34b1367edbe78653c5225eb697178166c6eab65b122b65781e659677d74265561228edc25616390080c41a285aa5e245eb45a
X-CSRF:Ys9duXU4p4aixevzWzG/qK6MNLitom5cYkceMplsFr4=
Content-Type:application/json
Cache-Control:no-cache
Accept-Encoding:gzip, deflate, br
Connection:keep-alive
Content-Length:450
{
"loginTokens": [{
"key": "com.bottomline.security.provider.login.email",
"value": "Include email address here"
}, {
"key": "com.bottomline.security.provider.login.password",
"value": "Include password here"
}],
"apiVersion": "{\"major\": \"1\",\"minor\": \"0\",\"patch\": \"0\",\"build\": \"0\"}",
"purpose": "cpay-auth",
"tokenLocation": "HEADER"
}
Note: Items in bold are fixed/mandatory.
POST /payments-service/api/security/login HTTP/1.1
Host:uk.pt-x.com
User-Agent:api-v2.5
Cookie:f5avraaaaaaaaaaaaaaaa_session_=DFEALBAPPPCOMKFPMHAKMPKHMLOJBNAGGGJLKOHELAEOACOEOOPLCKEMKDFMAPDGIOODBMJACDOGMBHNCCDAFABCOOAIICONKAHEOOIKOMIPOGDDKFHNPLJKOOHONLJN; JSESSIONID=Ig3ayRxj1vV17QzUrqPRj-OPgIkQ4Vtihj3lu09TRgt135wAcjQF!-1331583496.node01; TS010ce9a5=0188c34b1367edbe78653c5225eb697178166c6eab65b122b65781e659677d74265561228edc25616390080c41a285aa5e245eb45a X-CSRF:Ys9duXU4p4aixevzWzG/qK6MNLitom5cYkceMplsFr4=
Content-Type:application/json
Cache-Control:no-cache
Accept-Encoding:gzip, deflate, br
Connection:keep-alive
Content-Length:450
{
"loginTokens": [{
"key": "com.bottomline.security.provider.login.email",
"value": "Include email address here"
}, {
"key": "com.bottomline.security.provider.login.password",
"value": "Include password here"
}],
"apiVersion": "{\"major\": \"1\",\"minor\": \"0\",\"patch\": \"0\",\"build\": \"0\"}",
"purpose": "cpay-auth",
"tokenLocation": "HEADER"
}
The X-CSRF token and auth.token returned in the Authenticate response, along with the JSESSIONID returned from the handshake are required in all future API calls.
Once the authentication is successful, it will expire in approximately 10 minutes if not used (the timer is reset with successful API request). API integrations will need to correctly handle HTTP401 responses and repeat the above handshake and authenticate steps.
API calls should contain the header information collected from the handshake and login.
Note: Ensure that the CSRF token that is used is the value returned by the login call and not the handshake call which will be out of date.
The API call below is an example for creating a new payment batch and most calls will follow this format. However, always refer to the specific documentation for each API call regarding header, request and response information.
POST /payments-service/api/bacs/batches HTTP/1.1
User-Agent:api-v2.5
Cookie:JSESSIONID=Y1cXNhhhCapIMdC3EKnsKP0djemJoq7DorVHf6zNzyHnLxTVmId5!-1275828986.node01; TS010ce9a5=0188c34b1367edbe78653c5225eb697178166c6eab65b122b65781e659677d74265561228edc25616390080c41a285aa5e245eb45a X-CSRF:WQgmaV4zskFD0DzPdiii5ESbwx+G9EJlZ7mTL2Zz7Kc=
Content-Type:application/json
com.bottomline.auth.token:AAABcRcyoUYTHdHNVjB2d496zvTNGVzOgPu+sNhY4xZSVYtHIDx4weJY6WpcQMZcI627EOgYnbEAM3W57zM7p9HGN712Tz+YEIHM4UG6mtUVKNpKxk6qkrIc4KaFp/ue+/qCHf+FDIyMAd7F8YvwTpVL1t8/N+bUnyO+qqOk/e4EcDHOrvbyHL0cDRMBcZ4V+vToZQRA333sPc8RdqbT3Xs08qOvlXZyns9ux1/haGAyMuyYuFGBAU2GDernzcosSAlCTr0HAII24XTJKSK1uRdO59fbbe6rwIGCXASemMoXpMFaY8xx22oxMKrc5HAolcmYNGSlmEXJ/CiXJkDtnJxu4nryEHgJAvd/uU6TGOS+BfWwELXsZOkpGzshDe6O+FCptIsMTYNPBTCebHgQmBeCUGDKCRMHTJYCpPRPHgwZGm7f5Oe+VCII9Mqeb+m90s+aNDY9x9cYirAhoGEs1gHvt+K92vftulgeOWdYLR2hnmxK9wYa/hJg38f3w9fap00VEcjzEsGBuO1qql5OuWwVcomcdXpW41ioM83eZFfDlMKMDUCc/2OK8vFXlhEttk3ygg8q3M2myo0DlmmypptbpNZrcZGTqnirrgKGuqOJo7LSFaMjbSvVAzOcCwNUKPuuuQGEke/QRJkLfK8yEZ6RD9VW5gnB6oBmtAiVyMyKgnVS8CYTNbCnIHwZyr25zY2W4A5hHa8I03TclglRc1wi1bKe6pndiLVX1UKbzeAR0Xgqq7pNWTLotxtBmj2e/VB7Eb60yjNbjao1y5YoyzzFcQP9sPFNQ1kWWxBSkEawIbGMT+tD3NR6wqAjK5j2Bjfuu4r9PhOC/0R/FSkLhpxnxsUR36bb1FteWe4YcC2nFfFcxgmCBjyQ/tE/6uLfQWAWH8aBUw+FWpZH18tZJYxzKMPjJkMZ1+m28p+htQM8zqne6uT7U6jxWHcUxR8tLQN7KK8myCg7BA0k4tTJZu4v6jz6U/LyIvnnKYRupFp9sQVKXuh77npGLExhLoir2BeegkhYpv60zDEuOELuZyb/d3TyBRLrjUkBLCjM/AkKoAd1IlvD1AABoMPjLLRlAVJwCc2Vd7Lj7Hw6GfPsm1Bc4Pbfb8TwIfMirfBt4SpCQIVmGzGDzkz98h15wlptThST43t/ZNgx33LdnhOBNyTJQWgc11F/1SlO1zLVg8FqCPS4LgutZSSBMX6HZkUezGT8LETAaxq1WrYh2JyeWrmyBvydoVqmqoo5MJ+PSJXIuUXTqkcx39HygqZLHmXQBcxg9vuTcfVdvLaI1wrPnh2uUP98L6JCltGBeFHhMF5fp/ekqRyII8SqpCua6Se99JMk3KpQcsi8sVZ5STnS47wN8WhcdBWgf1h1CTn/My3/Cs8XHKJCUVseS8jkaKYYMGpF0DLeEXhWUuq58qxIugtaAjQUxr0iHEwcjVZEC88f523ngfGwbwWBt58ECmLuR+jIXhwOTuAj3HjR2vlYjEXcllRyRNn3xcjIjUlLajsv9EjcSzbbpWWykQ6xiaVwCpJyXGwg72gnQZNjV+dvBRG1Qh7C3VWYTzXjSsLynsxDt0ziT4ZWyO9xnSeamgBZPPPsux6BPjekvnI8ppQCjrt5Qm9sJSxoyaTKyPx0lq1/nzMYyx+spIdmBiwkUPsw/Dnli7gAOnSgH3B/xl6l1Ss4Y5RDhG0ElQ==
Accept:/
Cache-Control:no-cache
Host: payments.cat.uk.pt-x.com Accept-Encoding:gzip, deflate, br Connection:keep-alive Content-Length:199 { "inputMethod":"manual",
"description":"BATCH 2",
"application":"1234",
"applicationName":"-",
"status":"-",
"paymentDate":"-",
"submissionSigningMethod":"SMARTCARD" }
For all API calls, parameters of type string cannot start with any of the following charaters: =, +, -, @
Payment profiles are used for making payments.
Payment Profiles contain all the information that the PTX system needs to process payments including if the payments is to be made via Bacs or Faster Payments, if the payment is to be submitted via a bureau or submitted to Bacs on behalf of a bureau and how the payment data will be uploaded to PTX.
Executes a query to list all payment profiles.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Applications",
- "symbol": "com.bottomline.cpay.model.applications",
- "key": "com.bottomline.cpay.model.applications"
}, - "resultFields": [
- {
- "name": "All Applications Minimal",
- "symbol": "com.bottomline.cpay.model.AllApplicationsMinimal",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "All Applications Minimal",
- "symbol": "com.bottomline.cpay.model.AllApplicationsMinimal",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "PaymentProfileMinimal",
- "id": 8543,
- "name": "TEST FPS PAYMENT PROFILE",
- "createdDate": "2018-10-17T13:33:08.749",
- "status": "AP",
- "bacsTransmissionType": "STRUCTURALTEST",
- "type": "BACS",
- "dataEntryMethod": "MANUALENTRY",
- "serviceType": "SECUREIP",
- "paymentFileSigningType": "NONE",
- "submissionSigningMethod": "SMARTCARD",
- "connectionType": "DIRECT",
- "promptForDate": false,
- "originatingAccountName": "FPS ACCOUNT NAME",
- "originatingSortCode": "444444",
- "originatingAccountNumber": "44444444",
- "originatorsStatementText": "FPS STATE TEXT",
- "firstUseOfAccount": "NONE",
- "duplicateAccount": "NONE",
- "duplicateAmount": "NONE",
- "blackListedAccount": "NONE",
- "autoArchiveSentSubmissions": false,
- "numberOfDaysToProcessSentSubmissions": 7,
- "numberOfApprovals": 1,
- "automaticSubmission": "false+"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "PaymentProfileMinimal",
- "id": 8308,
- "name": "TEST INDIRECT PROFILE",
- "createdDate": "2018-08-10T13:47:36.224",
- "status": "AP",
- "bacsTransmissionType": "TEST",
- "type": "BACS",
- "dataEntryMethod": "MANUALENTRY",
- "serviceType": "BACSTELIP",
- "paymentFileSigningType": "NONE",
- "submissionSigningMethod": "SMARTCARD",
- "connectionType": "INDIRECT",
- "promptForDate": false,
- "originatingAccountName": "INDIRECT ACC NAME",
- "originatingSortCode": "217217",
- "originatingAccountNumber": "21702170",
- "originatorsStatementText": "IND STATE TEXT",
- "firstUseOfAccount": "NONE",
- "duplicateAccount": "NONE",
- "duplicateAmount": "NONE",
- "blackListedAccount": "NONE",
- "autoArchiveSentSubmissions": false,
- "numberOfDaysToProcessSentSubmissions": 7,
- "numberOfApprovals": 1,
- "automaticSubmission": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "PaymentProfileMinimal",
- "id": 6421,
- "name": "TEST PAYMENT PROFILE",
- "createdDate": "2017-11-27T13:38:52.339",
- "status": "AP",
- "bacsTransmissionType": "STRUCTURALTEST",
- "type": "BACS",
- "dataEntryMethod": "FILEIMPORT",
- "serviceType": "BACSTELIP",
- "paymentFileSigningType": "NONE",
- "submissionSigningMethod": "SMARTCARD",
- "connectionType": "DIRECT",
- "promptForDate": true,
- "originatingAccountName": "TEST ACC NAME",
- "originatingSortCode": "000000",
- "originatingAccountNumber": "00000000",
- "originatorsStatementText": "TEST STATE TEXT",
- "firstUseOfAccount": "NONE",
- "duplicateAccount": "NONE",
- "duplicateAmount": "NONE",
- "blackListedAccount": "NONE",
- "autoArchiveSentSubmissions": false,
- "numberOfDaysToProcessSentSubmissions": 7,
- "numberOfApprovals": 1,
- "automaticSubmission": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 3
}
}
]
}
]
}
]
}
Executes a query to search for a payment profile by name.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Applications",
- "symbol": "com.bottomline.cpay.model.applications",
- "key": "com.bottomline.cpay.model.applications"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "name",
- "symbol": "com.bottomline.cpay.model.application.name",
- "fieldType": "STRING_CI",
- "key": false
}, - "operator": {
- "symbol": "CONTAINS"
}, - "queryValue": {
- "@type": "string",
- "$value": "indirect"
}
}
]
}, - "resultFields": [
- {
- "name": "All Applications Minimal",
- "symbol": "com.bottomline.cpay.model.AllApplicationsMinimal",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "All Applications Minimal",
- "symbol": "com.bottomline.cpay.model.AllApplicationsMinimal",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "PaymentProfileMinimal",
- "id": 8308,
- "name": "TEST INDIRECT PROFILE",
- "createdDate": "2018-08-10T13:47:36.224",
- "status": "AP",
- "bacsTransmissionType": "TEST",
- "type": "BACS",
- "dataEntryMethod": "MANUALENTRY",
- "serviceType": "BACSTELIP",
- "paymentFileSigningType": "NONE",
- "submissionSigningMethod": "SMARTCARD",
- "connectionType": "INDIRECT",
- "promptForDate": false,
- "originatingAccountName": "INDIRECT ACC NAME",
- "originatingSortCode": "217217",
- "originatingAccountNumber": "21702170",
- "originatorsStatementText": "IND STATE TEXT",
- "firstUseOfAccount": "NONE",
- "duplicateAccount": "NONE",
- "duplicateAmount": "NONE",
- "blackListedAccount": "NONE",
- "autoArchiveSentSubmissions": false,
- "numberOfDaysToProcessSentSubmissions": 7,
- "numberOfApprovals": 1,
- "automaticSubmission": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 1
}
}
]
}
]
}
]
}
Payment batches are used for making payments. A payment batch contains payment instructions details.
The API allows you to create a batch which will upload the payment into the PTX system. You can create a batch template and create a batch from the template. You can also move a batch from draft to entered, approved or committed status.
Creates a new payment batch.
Note: Create an empty batch first and then use the Create an instruction call to add instructions to the batch.
The MdeHeader
inputMethod | string <string> Input method, set to either Manual or File. |
description | string <string> Description for batch. |
application required | string <string> Unique identifier of the selected payment profile. |
applicationName | string <string> The name of the selected payment profile. |
status | string <string> Default: "DRAFT" The status of the batch. |
paymentDate | string <date-time> The payment date of the batch. If supplied then must adhere to Bacs scheme rules (the earliest date is two days from the current date excluding bank holidays and weekends). |
paymentType | string <string> The payment type, set to either Bacs or Faster Payments. |
submissionSigningMethod | string Default: "SMARTCARD" The signing method when submitting files to Bacs, set to either Smartcard or HSM. |
{- "inputMethod": "manual",
- "description": "New batch",
- "application": 6421,
- "applicationName": "TEST PAYMENT PROFILE",
- "status": "-",
- "paymentDate": "-",
- "paymentType": "Bacs",
- "submissionSigningMethod": "SMARTCARD"
}
{- "@type": "MdeHeader",
- "id": 100,
- "application": 33,
- "applicationName": "Direct MDE Profile",
- "enteredDate": "2018-10-18T13:13:24.000+0000",
- "paymentDate": "2018-10-22T00:00:00.000",
- "enteredBy": "JGX3FTUOQF1PPIDQTMLF",
- "description": "TEST PAYMENT PROFILE-1539868404142",
- "status": "DRAFT",
- "statusDescription": "Draft",
- "debitCount": 3,
- "debitTotal": 623.45,
- "creditCount": 0,
- "creditTotal": 0,
- "paymentType": "Bacs",
- "originatorInfo": {
- "sortCode": "309470",
- "accountNumber": "12341234",
- "accountName": "test account name",
- "statementText": "statement text",
- "sun": 100265,
- "destinationStatementText": "dest statement text"
}, - "errorCount": 0,
- "warningCount": 0,
- "auddisCount": 0,
- "submission": 126091,
- "multiplePaymentDates": false,
- "entryCount": 0,
- "includedCount": 0,
- "rti": false,
- "possibleDuplicate": false,
- "indirect": false,
- "paymentFileSigned": false,
- "riskCount": 0,
- "isDDMEntry": false
}
Creates a new payment batch template.
batchId required | integer <int64> Unique identifier of batch for template creation. |
The Bacs template descriptor.
templateName | string <string> Template name. |
batchId | integer <int64> The batch ID for template creation. |
{- "templateName": "MyWeeklyBatchFile",
- "batchId": 100
}
{- "model": { },
- "informationMessages": [
- {
- "key": "string",
- "message": "string"
}
], - "warningMessages": [
- {
- "key": "string",
- "message": "string"
}
], - "errorMessages": [
- {
- "key": "string",
- "message": "string"
}
], - "debugMessages": [
- {
- "key": "string",
- "message": "string"
}
]
}
Creates a new payment batch from a template.
templateId required | integer <int64> Unique identifier of template for batch creation. |
curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/bacs/batches/124/template/batch
{- "id": 100,
- "submissionId": 99,
- "application": 33,
- "applicationName": "Direct MDE Profile",
- "entries": [
- {
- "id": 10045,
- "paymentType": "Bacs",
- "included": true,
- "index": 1,
- "transactionType": "0",
- "transactionTypeCode": "99",
- "sortCode": "200000",
- "accountNumber": "42222222",
- "batchId": 100,
- "reference": "Reference-1234",
- "amount": "2450.99",
- "paymentDate": "2019-08-24T14:15:22Z",
- "type": "DBACS",
- "name": "JON SMITH",
- "rti": "",
- "isDDMEntry": false
}
], - "applicationDescription": "Direct MDE Profile {100124}",
- "paymentDate": "2019-08-24T14:15:22Z",
- "type": "DBACS",
- "description": "DirectMDEProfile-1515062817535",
- "debitCount": 3,
- "debitTotal": 623.45,
- "creditCount": 14,
- "creditTotal": 125650.9
}
Completes a payment batch moving the batch from draft to entered status.
Warning: This call is not thread safe therefore DO NOT use this call while instructions are being added to the batch manually or via the API.
submissionId required | integer <int64> Submission identifier obtained from the Create a new payment batch call. |
paymentProfileId required | integer <int64> Payment profile identifier obtained from the Query list all payment profiles or Query payment profile by payment profile name call. |
curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/bacs/submissions/126091/enter/6421
Completes a payment batch moving the batch from entered to approved status.
Warning: This call can only be used for batches that are in the entered state.
submissionId required | integer <int64> Submission identifier obtained from the Create a new payment batch call. |
curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/bacs/submissions/126091/approve
Rejects a payment batch.
submissionId required | integer <int64> Submission identifier obtained from the Create a new payment batch call. |
reason | string <string> Reject reason. |
{- "reason": "Duplicate payment"
}
Unapproves a payment batch, moving the status of the batch back to Entered.
submissionId required | integer <int64> Submission identifier obtained from the Create a new payment batch call. |
curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/bacs/submissions/126091/unapprove
Completes a payment batch moving the batch from approved to committed status.
Warning: This call can only be used for batches that have been created using a payment profile for indirect submitters and are in the approved state.
submissionId required | integer <int64> Submission identifier obtained from the Create a new payment batch call. |
curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/bacs/submissions/126091/commit
Archives a payment batch.
submissionId required | integer <int64> Submission identifier obtained from the Create a new payment batch call. |
curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/bacs/submissions/126091/archive
Executes a query for a rejected payment batch between two dates.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Submission",
- "symbol": "com.bottomline.cpay.model.bacs.submission",
- "key": "com.bottomline.cpay.model.bacs.submission"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "status",
- "symbol": "com.bottomline.cpay.model.bacs.submission.status",
- "fieldType": "STRING",
- "key": false
}, - "operator": {
- "symbol": "IN"
}, - "queryValue": {
- "@type": "string",
- "$value": "RJ"
}
}, - {
- "@type": "QueryRelationship",
- "name": "AND",
- "description": "AND relationship.",
- "symbol": "AND"
}, - {
- "@type": "QueryParameter",
- "field": {
- "name": "paymentDate",
- "symbol": "com.bottomline.cpay.model.bacs.submission.paymentDate",
- "fieldType": "DATE",
- "key": false
}, - "operator": {
- "symbol": "BETWEEN"
}, - "queryValues": [
- {
- "@type": "date",
- "$value": "2022-06-08T00:00:00.000Z"
}, - {
- "@type": "date",
- "$value": "2022-06-11T23:59:59.100Z"
}
]
}
]
}, - "resultFields": [
- {
- "name": "Submission",
- "symbol": "com.bottomline.cpay.model.bacs.SubmissionResponse",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Submission",
- "symbol": "com.bottomline.cpay.model.bacs.SubmissionResponse",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "SubmissionResponse",
- "id": 88444,
- "application": 6421,
- "applicationName": "TEST PAYMENT PROFILE",
- "applicationDescription": "TEST PAYMENT PROFILE (000000)",
- "entryMethod": "FILEIMPORT",
- "enteredDate": "2022-01-06T14:49:00.000",
- "paymentDate": "2022-01-08T00:00:00.000",
- "enteredBy": "Alex Smith",
- "enteredById": "JGX3FTUOQF1PPIDQTMLF",
- "description": "One-Off Collections.txt",
- "status": "RJ",
- "statusDescription": "Rejected",
- "numFiles": 1,
- "debitTotal": 0,
- "creditTotal": 0,
- "debitCount": 0,
- "creditCount": 0,
- "paymentType": "Bacs",
- "multiplePaymentDates": false,
- "errorCount": 2,
- "warningCount": 0,
- "auddisCount": 0,
- "entryCount": 0,
- "entryTotal": 0,
- "sun": "000000",
- "indirect": false,
- "earliestProcessingDate": "2022-01-07T00:00:00.000",
- "transmissionType": "StructuralTest",
- "possibleDuplicate": false,
- "submissionSigningMethod": "SMARTCARD",
- "bureau": false,
- "workflowStatus": "Created",
- "riskCount": 0,
- "numberOfApprovals": 1
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "SubmissionResponse",
- "id": 88442,
- "application": 6421,
- "applicationName": "TEST PAYMENT PROFILE",
- "applicationDescription": "TEST PAYMENT PROFILE (000000)",
- "entryMethod": "FILEIMPORT",
- "enteredDate": "2022-01-06T14:48:00.000",
- "paymentDate": "2022-01-08T00:00:00.000",
- "enteredBy": "Alex Smith",
- "enteredById": "JGX3FTUOQF1PPIDQTMLF",
- "description": "One-Off Collections.txt",
- "status": "RJ",
- "statusDescription": "Rejected",
- "numFiles": 1,
- "debitTotal": 0,
- "creditTotal": 0,
- "debitCount": 0,
- "creditCount": 0,
- "paymentType": "Bacs",
- "multiplePaymentDates": false,
- "errorCount": 2,
- "warningCount": 0,
- "auddisCount": 0,
- "entryCount": 0,
- "entryTotal": 0,
- "sun": "000000",
- "indirect": false,
- "earliestProcessingDate": "2022-01-07T00:00:00.000",
- "transmissionType": "StructuralTest",
- "possibleDuplicate": false,
- "submissionSigningMethod": "SMARTCARD",
- "bureau": false,
- "workflowStatus": "Created",
- "riskCount": 0,
- "numberOfApprovals": 1
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "SubmissionResponse",
- "id": 88438,
- "application": 6421,
- "applicationName": "TEST PAYMENT PROFILE",
- "applicationDescription": "TEST PAYMENT PROFILE (000000)",
- "entryMethod": "FILEIMPORT",
- "enteredDate": "2022-01-06T14:47:00.000",
- "paymentDate": "2022-01-08T00:00:00.000",
- "enteredBy": "Alex Smith",
- "enteredById": "JGX3FTUOQF1PPIDQTMLF",
- "description": "One-Off Collections.txt",
- "status": "RJ",
- "statusDescription": "Rejected",
- "numFiles": 1,
- "debitTotal": 0,
- "creditTotal": 0,
- "debitCount": 0,
- "creditCount": 0,
- "paymentType": "Bacs",
- "multiplePaymentDates": false,
- "errorCount": 2,
- "warningCount": 0,
- "auddisCount": 0,
- "entryCount": 0,
- "entryTotal": 0,
- "sun": "000000",
- "indirect": false,
- "earliestProcessingDate": "2022-01-07T00:00:00.000",
- "transmissionType": "StructuralTest",
- "possibleDuplicate": false,
- "submissionSigningMethod": "SMARTCARD",
- "bureau": false,
- "workflowStatus": "Created",
- "riskCount": 0,
- "numberOfApprovals": 1
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "SubmissionResponse",
- "id": 88434,
- "application": 6421,
- "applicationName": "TEST PAYMENT PROFILE",
- "applicationDescription": "TEST PAYMENT PROFILE (000000)",
- "entryMethod": "FILEIMPORT",
- "enteredDate": "2022-01-06T14:44:00.000",
- "paymentDate": "2022-01-08T00:00:00.000",
- "enteredBy": "Alex Smith",
- "enteredById": "JGX3FTUOQF1PPIDQTMLF",
- "description": "One-Off Collections.txt",
- "status": "RJ",
- "statusDescription": "Rejected",
- "numFiles": 1,
- "debitTotal": 0,
- "creditTotal": 0,
- "debitCount": 0,
- "creditCount": 0,
- "paymentType": "Bacs",
- "multiplePaymentDates": false,
- "errorCount": 2,
- "warningCount": 0,
- "auddisCount": 0,
- "entryCount": 0,
- "entryTotal": 0,
- "sun": "000000",
- "indirect": false,
- "earliestProcessingDate": "2022-01-07T00:00:00.000",
- "transmissionType": "StructuralTest",
- "possibleDuplicate": false,
- "submissionSigningMethod": "SMARTCARD",
- "bureau": false,
- "workflowStatus": "Created",
- "riskCount": 0,
- "numberOfApprovals": 1
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "SubmissionResponse",
- "id": 88428,
- "application": 6421,
- "applicationName": "TEST PAYMENT PROFILE",
- "applicationDescription": "TEST PAYMENT PROFILE (000000)",
- "entryMethod": "FILEIMPORT",
- "enteredDate": "2022-01-06T14:41:00.000",
- "paymentDate": "2022-01-08T00:00:00.000",
- "enteredBy": "Alex Smith",
- "enteredById": "JGX3FTUOQF1PPIDQTMLF",
- "description": "One-Off Collections.txt",
- "status": "RJ",
- "statusDescription": "Rejected",
- "numFiles": 1,
- "debitTotal": 0,
- "creditTotal": 0,
- "debitCount": 0,
- "creditCount": 0,
- "paymentType": "Bacs",
- "multiplePaymentDates": false,
- "errorCount": 2,
- "warningCount": 0,
- "auddisCount": 0,
- "entryCount": 0,
- "entryTotal": 0,
- "sun": "000000",
- "indirect": false,
- "earliestProcessingDate": "2022-01-07T00:00:00.000",
- "transmissionType": "StructuralTest",
- "possibleDuplicate": false,
- "submissionSigningMethod": "SMARTCARD",
- "bureau": false,
- "workflowStatus": "Created",
- "riskCount": 0,
- "numberOfApprovals": 1
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "SubmissionResponse",
- "id": 88426,
- "application": 6421,
- "applicationName": "TEST PAYMENT PROFILE",
- "applicationDescription": "TEST PAYMENT PROFILE (000000)",
- "entryMethod": "FILEIMPORT",
- "enteredDate": "2022-01-06T14:41:00.000",
- "paymentDate": "2022-01-08T00:00:00.000",
- "enteredBy": "Alex Smith",
- "enteredById": "JGX3FTUOQF1PPIDQTMLF",
- "description": "One-Off Collections.txt",
- "status": "RJ",
- "statusDescription": "Rejected",
- "numFiles": 1,
- "debitTotal": 0,
- "creditTotal": 0,
- "debitCount": 0,
- "creditCount": 0,
- "paymentType": "Bacs",
- "multiplePaymentDates": false,
- "errorCount": 2,
- "warningCount": 0,
- "auddisCount": 0,
- "entryCount": 0,
- "entryTotal": 0,
- "sun": "000000",
- "indirect": false,
- "earliestProcessingDate": "2022-01-07T00:00:00.000",
- "transmissionType": "StructuralTest",
- "possibleDuplicate": false,
- "submissionSigningMethod": "SMARTCARD",
- "bureau": false,
- "workflowStatus": "Created",
- "riskCount": 0,
- "numberOfApprovals": 1
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "SubmissionResponse",
- "id": 88422,
- "application": 6421,
- "applicationName": "TEST PAYMENT PROFILE",
- "applicationDescription": "TEST PAYMENT PROFILE (000000)",
- "entryMethod": "FILEIMPORT",
- "enteredDate": "2022-01-06T14:37:00.000",
- "paymentDate": "2022-01-08T00:00:00.000",
- "enteredBy": "Alex Smith",
- "enteredById": "JGX3FTUOQF1PPIDQTMLF",
- "description": "One-Off Collections.txt",
- "status": "RJ",
- "statusDescription": "Rejected",
- "numFiles": 1,
- "debitTotal": 0,
- "creditTotal": 0,
- "debitCount": 0,
- "creditCount": 0,
- "paymentType": "Bacs",
- "multiplePaymentDates": false,
- "errorCount": 2,
- "warningCount": 0,
- "auddisCount": 0,
- "entryCount": 0,
- "entryTotal": 0,
- "sun": "000000",
- "indirect": false,
- "earliestProcessingDate": "2022-01-07T00:00:00.000",
- "transmissionType": "StructuralTest",
- "possibleDuplicate": false,
- "submissionSigningMethod": "SMARTCARD",
- "bureau": false,
- "workflowStatus": "Created",
- "riskCount": 0,
- "numberOfApprovals": 1
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 7
}
}
]
}
]
}
]
}
Payment instructions are used for making payments. A payment instruction contains the payment details including sort code, account number, payment type and amount.
The API allows you to create, delete and update your payment instructions. You can clear the amount in an instruction and identify which instructions to include in a batch. You can run queries to list instructions using reference, creation date and batch ID.
Creates a new instruction.
The MdeEntry
paymentType | string <string> Payment type of the instruction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
included | boolean Identifier of the instruction state, if it is included in the batch file or not. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transactionType required | string <string> Default: "0" Possible values:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
text required | string <string> Default: "STC TEXT" Text that appears on the statement. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
paymentDate required | string <date-time> The payment date of the instruction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sortCode required | string <string> Default: "111111" The destination sort code. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
accountNumber required | string <string> Default: "11111111" The destination account number. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reference | string <string> The payment reference. Note: This field is optional for direct credits and mandatory for direct debits. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string <string> The destination account name. Note: This field is optional for direct credits and mandatory for direct debits. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
batchId required | integer <int64> Default: 101036 Unique identifier of batch for update. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
amount required | string <amounts> Default: "1222211" The payment amount. |
{- "paymentType": "Bacs",
- "included": true,
- "transactionType": "0",
- "text": "STC TEXT",
- "paymentDate": "2022-10-24T00:00:00.000",
- "sortCode": "200000",
- "accountNumber": "42222222",
- "reference": "Reference-101",
- "name": "JON SMITH",
- "batchId": 101,
- "amount": "402.35"
}
{- "@type": "MdeEntry",
- "id": 1056,
- "batchId": 101,
- "index": 42,
- "sortCode": "200000",
- "accountNumber": "42222222",
- "reference": "Reference-101",
- "name": "JON SMITH",
- "text": "STC TEXT",
- "type": "DBACS",
- "transactionType": "0",
- "transactionTypeCode": "99",
- "paymentDate": "2022-10-24T00:00:00.000",
- "amount": "402.35",
- "status": "DF",
- "included": true,
- "isDDMEntry": false,
- "createdDate": "2022-10-18T00:00:00.000",
- "warning": {
- "accountNumber": [
- "Account number 11111111 does not have a valid checksum for sort code 111111"
]
}
}
Updates an instruction.
entryId required | integer <int64> Unique identifier of entry for the update. |
Unique identifier of entry for the update.
@type | string <string> Default: "MdeEntry" The type of record. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | int <int64> Unique identifier of batch file. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
batchId required | integer <int64> Unique identifier of batch for update. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
index required | integer <int64> The index identifier of the instruction within the batch file. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sortCode required | string <string> The destination sort code. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
accountNumber required | string <string> The destination account number. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reference | string <string> The payment reference. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string <string> The destination account name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
text required | string <string> Text that appears on the statement. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string <string> Default: "DBACS" The type of instruction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transactionType required | string <string> Possible values:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transactionTypeCode | string <string> Transaction code of the instruction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
paymentDate required | string <date-time> The payment date of the instruction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
amount required | string <amounts> The payment amount. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status required | string <string> The status of the instruction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
included | boolean Identifier of the instruction state, if it is included in the batch file or not. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isDDMEntry | boolean Default: false Alternative identifier for DDM instructions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createdDate required | string <date-time> The date the instruction was created. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
paymentType required | string <string> Payment type of the instruction. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isRefund required | boolean Defines if the payment is a refund. Always set to false. |
{- "@type": "MdeEntry",
- "id": 100,
- "batchId": 101,
- "index": 1,
- "sortCode": "200000",
- "accountNumber": "42222222",
- "reference": "Reference-1234",
- "name": "JON SMITH",
- "text": "STC TEXT",
- "type": "DBACS",
- "transactionType": "0",
- "transactionTypeCode": "99",
- "paymentDate": "2022-06-19T00:00:00.000",
- "amount": "402.35",
- "status": "DF",
- "included": true,
- "isDDMEntry": false,
- "createdDate": "2022-06-05T00:00:00.000",
- "paymentType": "Bacs",
- "isRefund": false
}
{- "@type": "MdeEntry",
- "id": 1056,
- "batchId": 101,
- "index": 42,
- "sortCode": "200000",
- "accountNumber": "42222222",
- "reference": "Reference-10",
- "name": "JON SMITH",
- "text": "STC TEXT",
- "type": "DBACS",
- "transactionType": "0",
- "transactionTypeCode": "99",
- "paymentDate": "2022-06-19T00:00:00.000",
- "amount": "402.35",
- "status": "DF",
- "included": true,
- "isDDMEntry": false,
- "createdDate": "2022-06-05T00:00:00.000"
}
Identifies which instructions to include in a batch.
batchId required | integer <int64> Unique identifier of batch for update. |
included required | boolean Has the value true if the instructions should be included. |
curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/bacs/instructions/101/included/true
Executes a query to search for instructions by batch ID.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Payments",
- "symbol": "com.bottomline.cpay.model.bacs.payment.entry",
- "key": "com.bottomline.cpay.model.bacs.payment.entry"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "batchId",
- "symbol": "com.bottomline.cpay.model.bacs.payment.batchid",
- "fieldType": "INTEGER",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "integer",
- "$value": "216683"
}
}
]
}, - "resultFields": [
- {
- "name": "Payment Detail",
- "symbol": "com.bottomline.cpay.model.bacs.payment.BacsInstruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Payment Detail",
- "symbol": "com.bottomline.cpay.model.bacs.payment.BacsInstruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ModelMessages",
- "model": {
- "@type": "BacsInstruction",
- "id": 66655142,
- "batchId": 216683,
- "index": 1,
- "sortCode": "200000",
- "accountNumber": "55555555",
- "transactionType": "2",
- "transactionTypeCode": "01",
- "amount": 101,
- "text": "THE VICTORIAN SOCI",
- "reference": "00009662",
- "name": "MR C J CONSTANCE",
- "paymentDate": "2021-06-08T00:00:00.000",
- "type": "DBACS",
- "status": "EN",
- "included": true,
- "isDDMEntry": false,
- "createdDate": "2021-05-18T10:39:46.618"
}, - "warning": {
- "entered": [
- "Originator details: The sort code and account number do not pass the modulus check"
]
}
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 1
}
}
]
}
]
}
]
}
Executes a query to search for instructions greater than or equal to a specified created date.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Payments",
- "symbol": "com.bottomline.cpay.model.bacs.payment.entry",
- "key": "com.bottomline.cpay.model.bacs.payment.entry"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "createdDate",
- "symbol": "com.bottomline.cpay.model.bacs.payment.createdDate",
- "fieldType": "TIMESTAMP",
- "key": false
}, - "operator": {
- "symbol": ">="
}, - "queryValue": {
- "@type": "dateTime",
- "$value": "2022-05-18T00:00:00.000"
}
}
]
}, - "resultFields": [
- {
- "name": "Payment Detail",
- "symbol": "com.bottomline.cpay.model.bacs.payment.BacsInstruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "OBJECT",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Payment Detail",
- "symbol": "com.bottomline.cpay.model.bacs.payment.BacsInstruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ModelMessages",
- "model": {
- "@type": "BacsInstruction",
- "id": 66654076,
- "batchId": 216641,
- "index": 1,
- "sortCode": "200000",
- "accountNumber": "55555555",
- "transactionType": "2",
- "transactionTypeCode": "01",
- "amount": 101,
- "text": "THE VICTORIAN SOCI",
- "reference": "00009662",
- "name": "MR C J CONSTANCE",
- "paymentDate": "2022-05-20T00:00:00.000",
- "type": "DBACS",
- "status": "RJ",
- "included": true,
- "isDDMEntry": false,
- "createdDate": "2022-05-18T09:35:34.703"
}, - "warning": {
- "entered": [
- "Originator details: The sort code and account number do not pass the modulus check"
]
}
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ModelMessages",
- "model": {
- "@type": "MdeEntry",
- "id": 70358993,
- "batchId": 222502,
- "index": 1,
- "sortCode": "666666",
- "accountNumber": "66666666",
- "reference": "REF6666",
- "name": "666666666",
- "text": "EXAMPLE ACC NAME",
- "type": "DBACS",
- "transactionType": "7",
- "transactionTypeCode": "0N",
- "paymentDate": "2022-06-24T00:00:00.000",
- "amount": 101,
- "status": "DF",
- "userGroup": "ALEXTEST",
- "parentUserGroup": "BTS",
- "included": true,
- "isDDMEntry": true,
- "createdDate": "2022-06-22T17:52:42.622"
}, - "warning": {
- "sortCode": [
- "Sort code has not been found in the sort code directory"
], - "paymentDate": [
- "Please enter valid value of Payment Date"
]
}
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ModelMessages",
- "model": {
- "@type": "MdeEntry",
- "id": " 70311660",
- "batchId": 221450,
- "index": 1,
- "sortCode": "200000",
- "accountNumber": "44995500",
- "reference": "08496656",
- "name": "MR USER ONE",
- "text": "N/A",
- "type": "DBACS",
- "transactionType": "7",
- "transactionTypeCode": "0N",
- "paymentDate": "2022-06-18T00:00:00.000",
- "amount": 101,
- "status": "DF",
- "UserGroup": "ALEXTEST",
- "parentUserGroup": "BTS",
- "included": true,
- "isDDMEntry": true,
- "createdDate": "2022-06-16T16:12:07.585"
}, - "warning": {
- "entered": [
- "Please enter valid value of Payment Date"
]
}
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 3
}
}
]
}
]
}
]
}
Executes a query to list instructions by creation date and batch ID.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Payments",
- "symbol": "com.bottomline.cpay.model.bacs.payment.entry",
- "key": "com.bottomline.cpay.model.bacs.payment.entry"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "createdDate",
- "symbol": "com.bottomline.cpay.model.bacs.payment.createdDate",
- "fieldType": "TIMESTAMP",
- "key": false
}, - "operator": {
- "symbol": ">="
}, - "queryValue": [
- {
- "@type": "dateTime",
- "$value": "2021-05-18T00:00:00.000"
}
]
}, - {
- "@type": "QueryRelationship",
- "name": "AND",
- "description": "AND relationship.",
- "symbol": "AND"
}, - {
- "@type": "QueryParameter",
- "field": {
- "name": "batchId",
- "symbol": "com.bottomline.cpay.model.bacs.payment.batchid",
- "fieldType": "INTEGER",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "integer",
- "$value": 216683
}
}
]
}, - "resultFields": [
- {
- "name": "Payment Detail",
- "symbol": "com.bottomline.cpay.model.bacs.payment.BacsInstruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Payment Detail",
- "symbol": "com.bottomline.cpay.model.bacs.payment.BacsInstruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ModelMessages",
- "model": {
- "@type": "BacsInstruction",
- "id": 66655142,
- "batchId": 216683,
- "index": 1,
- "sortCode": "200000",
- "accountNumber": "55555555",
- "transactionType": "2",
- "transactionTypeCode": "01",
- "amount": 101,
- "text": "THE VICTORIAN SOCI",
- "reference": "00009662",
- "name": "MR C J CONSTANCE",
- "paymentDate": "2021-06-08T00:00:00.000",
- "type": "DBACS",
- "status": "EN",
- "included": true,
- "isDDMEntry": false,
- "createdDate": "2021-05-18T10:39:46.618"
}, - "warning": {
- "entered": [
- "Originator details: The sort code and account number do not pass the modulus check"
]
}
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 1
}
}
]
}
]
}
]
}
Executes a query to list instructions by reference and batch ID.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Payments",
- "symbol": "com.bottomline.cpay.model.bacs.payment.entry",
- "key": "com.bottomline.cpay.model.bacs.payment.entry"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "reference",
- "symbol": "com.bottomline.cpay.model.bacs.payment.reference",
- "fieldType": "STRING_CI",
- "key": false
}, - "operator": {
- "symbol": "CONTAINS"
}, - "queryValue": [
- {
- "@type": "string",
- "$value": "TEST9662"
}
]
}, - {
- "@type": "QueryRelationship",
- "name": "AND",
- "description": "AND relationship.",
- "symbol": "AND"
}, - {
- "@type": "QueryParameter",
- "field": {
- "name": "batchId",
- "symbol": "com.bottomline.cpay.model.bacs.payment.batchid",
- "fieldType": "INTEGER",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "integer",
- "$value": 216683
}
}
]
}, - "resultFields": [
- {
- "name": "Payment Detail",
- "symbol": "com.bottomline.cpay.model.bacs.payment.BacsInstruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Payment Detail",
- "symbol": "com.bottomline.cpay.model.bacs.payment.BacsInstruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ModelMessages",
- "model": {
- "@type": "BacsInstruction",
- "id": 66655142,
- "batchId": 216683,
- "index": 1,
- "sortCode": "200000",
- "accountNumber": "55555555",
- "transactionType": "2",
- "transactionTypeCode": "01",
- "amount": 101,
- "text": "THE VICTORIAN SOCI",
- "reference": "TEST9662",
- "name": "MR C J CONSTANCE",
- "paymentDate": "2022-06-08T00:00:00.000",
- "type": "DBACS",
- "status": "EN",
- "included": true,
- "isDDMEntry": false,
- "createdDate": "2022-05-18T10:39:46.618"
}, - "warning": {
- "entered": [
- "Originator details: The sort code and account number do not pass the modulus check"
]
}
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 1
}
}
]
}
]
}
]
}
Payment instructions are used for making payments and can be added to PTX by uploading a file.
The API allows you to upload a Bacs file and retrieve the result of the upload.
Uploads a Bacs payment file.
id required | integer <int64> Payment profile identifier |
file required | string <binary> File to upload |
curl -F 'file=@PAYER_FILE' https://uk.pt-x.com/payments-service/api/file/6421
{- "version": "null",
- "extensions": [ ]
}
Retrieves the result of uploading a Bacs payment file.
id required | integer <int64> File identifier as generated by PTX, obtained from the Upload a file call. |
curl -H "Content-Type: application/json" -X GET https://uk.pt-x.com/payments-service/api/file/19456
{- "id": 19456,
- "filename": "Payment file type.csv",
- "size": 253,
- "status": "SUCCESS",
- "submissionId": 88863,
- "applicationId": 6264,
- "batchId": 88864
}
Executes a query for successful Bacs file upload by batch id.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "payments",
- "symbol": "com.bottomline.cpay.model.bacs.payment.entry",
- "key": "com.bottomline.cpay.model.bacs.payment.entry"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "batchId",
- "symbol": "com.bottomline.cpay.model.bacs.payment.batchid",
- "fieldType": "INTEGER",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "integer",
- "$value": 127233
}
}
]
}, - "resultFields": [
- {
- "name": "Payment Detail",
- "symbol": "com.bottomline.cpay.model.bacs.payment.BacsInstruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Payment Detail",
- "symbol": "com.bottomline.cpay.model.bacs.payment.BacsInstruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ModelMessages",
- "model": {
- "@type": "BacsInstruction",
- "id": 20943821,
- "batchId": 127233,
- "index": 1,
- "sortCode": "200000",
- "accountNumber": "55555555",
- "transactionType": "2",
- "transactionTypeCode": "01",
- "amount": 1,
- "text": "TEST DEST TEXT",
- "reference": "00009662",
- "name": "THE VICTORIAN SOCI",
- "paymentDate": "2018-11-07T00:00:00.000",
- "type": "DBACS",
- "status": "EN",
- "included": true,
- "isDDMEntry": false,
- "createdDate": "2018-11-05T00:00:00.000"
}, - "warning": {
- "entered": [
- "Originator details: The sort code has not been found in the sort code directory"
]
}
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 1
}
}
]
}
]
}
]
}
Executes a query for failed Bacs file upload by batch id.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "BacsTransformerEvent",
- "symbol": "com.bottomline.cpay.model.bacs.transformer.event",
- "key": "com.bottomline.cpay.model.bacs.transformer.event"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "BacsTransformerEvent BatchId",
- "symbol": "com.bottomline.cpay.model.bacs.BacsTransformerEvent.batchId",
- "fieldType": "INTEGER",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "integer",
- "$value": 88860
}
}
]
}, - "resultFields": [
- {
- "name": "BacsTransformerEvent",
- "symbol": "com.bottomline.cpay.model.bacs.BacsTransformerEvent",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "BacsTransformerEvent",
- "symbol": "com.bottomline.cpay.model.bacs.BacsTransformerEvent",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsTransformerEvent",
- "id": 4634086,
- "batchId": 88860,
- "createdTimeStamp": "2018-06-07T17:33:08",
- "eCode": "BV3006",
- "eventType": "Error",
- "lineNum": 0,
- "message": "No data records were extracted from file. Check XML mapping template and/or data file.",
- "occurances": 0,
- "preSubmissionFlag": false,
- "recId": 0,
- "submissionId": 88859,
- "type": "HEADER"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsTransformerEvent",
- "id": 4634087,
- "batchId": 88860,
- "createdTimeStamp": "2018-06-07T17:33:08",
- "eventType": "Error",
- "lineNum": 0,
- "message": "Failed extracting CSV field[AMOUNT] because Input string was not in a correct format.",
- "occurances": 0,
- "preSubmissionFlag": false,
- "recId": 0,
- "submissionId": 88859,
- "type": "HEADER"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 2
}
}
]
}
]
}
]
}
Executes a query for failed Bacs file upload by submission id.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "BacsTransformerEvent",
- "symbol": "com.bottomline.cpay.model.bacs.transformer.event",
- "key": "com.bottomline.cpay.model.bacs.transformer.event"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "BacsTransformerEvent SubmissionId",
- "symbol": "com.bottomline.cpay.model.bacs.BacsTransformerEvent.submissionid",
- "fieldType": "INTEGER",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "integer",
- "$value": 88860
}
}
]
}, - "resultFields": [
- {
- "name": "BacsTransformerEvent",
- "symbol": "com.bottomline.cpay.model.bacs.BacsTransformerEvent",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "BacsTransformerEvent",
- "symbol": "com.bottomline.cpay.model.bacs.BacsTransformerEvent",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsTransformerEvent",
- "id": 4634086,
- "batchId": 88860,
- "createdTimeStamp": "2018-06-07T17:33:08",
- "eCode": "BV3006",
- "eventType": "Error",
- "lineNum": 0,
- "message": "No data records were extracted from file. Check XML mapping template and/or data file.",
- "occurances": 0,
- "preSubmissionFlag": false,
- "recId": 0,
- "submissionId": 88859,
- "type": "HEADER"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsTransformerEvent",
- "id": 4634087,
- "batchId": 88860,
- "createdTimeStamp": "2018-06-07T17:33:08",
- "eventType": "Error",
- "lineNum": 0,
- "message": "Failed extracting CSV field[AMOUNT] because Input string was not in a correct format.",
- "occurances": 0,
- "preSubmissionFlag": false,
- "recId": 0,
- "submissionId": 88859,
- "type": "HEADER"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 2
}
}
]
}
]
}
]
}
Executes a query for failed Bacs file upload by batch id and error.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "BacsTransformerEvent",
- "symbol": "com.bottomline.cpay.model.bacs.transformer.event",
- "key": "com.bottomline.cpay.model.bacs.transformer.event"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "BacsTransformerEvent BatchId",
- "symbol": "com.bottomline.cpay.model.bacs.BacsTransformerEvent.batchId",
- "fieldType": "INTEGER",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "integer",
- "$value": 112222
}
}, - {
- "@type": "QueryRelationship",
- "name": "AND",
- "description": "AND relationship.",
- "symbol": "AND"
}, - {
- "@type": "QueryParameter",
- "field": {
- "name": "BacsTransformerEvent Event Type",
- "symbol": "com.bottomline.cpay.model.bacs.BacsTransformerEvent.eventType",
- "fieldType": "STRING",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "string",
- "$value": "Error"
}
}
]
}, - "resultFields": [
- {
- "name": "BacsTransformerEvent",
- "symbol": "com.bottomline.cpay.model.bacs.BacsTransformerEvent",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "BacsTransformerEvent",
- "symbol": "com.bottomline.cpay.model.bacs.BacsTransformerEvent",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsTransformerEvent",
- "id": 4662654,
- "batchId": 112222,
- "createdTimeStamp": "2018-08-01T08:57:37",
- "eCode": "BV3012",
- "eventType": "Error",
- "lineNum": 0,
- "message": "Data integrity check. The number of data records processed don't match database records.",
- "occurances": 0,
- "preSubmissionFlag": false,
- "recId": 0,
- "submissionId": 112221,
- "type": "HEADER"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsTransformerEvent",
- "id": 4662652,
- "batchId": 112222,
- "createdTimeStamp": "2018-08-01T08:57:37",
- "eCode": "RV0102",
- "eventType": "Error",
- "lineNum": 1,
- "message": "Destination SortCode length is larger than the permitted length of 6 digits: 200000ERROR",
- "occurances": 0,
- "preSubmissionFlag": false,
- "recId": 1,
- "sourceDetail": "200000ERROR,55555555,01,200000,55555554,00000000100,\"The Victorian Soci\",00009662,\"Mr C J CONSTANCE\"\n",
- "submissionId": 112221,
- "type": "INSTRUCTION"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsTransformerEvent",
- "id": 4662653,
- "batchId": 112222,
- "createdTimeStamp": "2018-08-01T08:57:37",
- "eventType": "Error",
- "lineNum": 1,
- "message": "Validation Error: Destination SortCode length is larger than the permitted length of 6 digits: 200000ERROR Source Record:1 Data:200000ERROR,55555555,01,200000,55555554,00000000100,\"The Victorian Soci\",00009662,\"Mr C J CONSTANCE\"\n",
- "occurances": 0,
- "preSubmissionFlag": false,
- "recId": 1,
- "sourceDetail": "200000ERROR,55555555,01,200000,55555554,00000000100,\"The Victorian Soci\",00009662,\"Mr C J CONSTANCE\"\n",
- "submissionId": 112221
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 3
}
}
]
}
]
}
]
}
Submission summary reports are provided by the Bacs service at the point of submission and are used to feed back information on payments so that they can be followed up accordingly.
Retrieves a submission summary report. The HTTP 200 response will contain either the report (if the report exists) or the text "Report is unavailable".
submissionId required | integer <int64> Example: 126091 Submission identifier obtained from the Create a new payment batch call. |
curl -H "Content-Type: application/json" -X GET https://uk.pt-x.com/payments-service/api/bacs/submissions/126091/report
<html xmlns:sub="http://bacs.co.uk/submissions"><head><meta http-equiv="Content-Type" content="text/html;" charset="utf-8" /><title>Bacs Payment Servivces - Submissions Summary</title></head><body> .... </body></html>
Bacs Messages are reports sent from Bacs to PTX for Direct Debit collections.
The API allows you to list, view, export, mark as downloaded and update the status of Bacs messages.
Returns a list of Bacs messages. The information returned can then be used in the Bacs messages calls.
Note: This call is only available for collection profiles set up for file import. Use the Query list all messages call for collection profiles set up for Manual Data Entry and file import.
curl -H "Content-Type: application/json" -X GET { "entity":{ "name": "BacsMessage", "symbol": "com.bottomline.cpay.model.bacs.reports.ReportItem", "key": "com.bottomline.cpay.model.bacs.reports.ReportItem" }, "resultFields":[ { "name": "BacsMessage", "symbol": "com.bottomline.cpay.model.bacs.reports.ReportItem", "fieldType": "OBJECT", "key": false }, { "name": "rowCount", "symbol": "com.bottomline.query.count", "fieldType": "LONG", "key": false } ], "resultsPage":{ "firstResult": 0, "maxResults": 50 } } https://uk.pt-x.com/payments-service/api/bacs-messages/downloadable
{- "fields": [
- {
- "fieldType": "STRING",
- "key": true,
- "name": "string",
- "description": "string",
- "symbol": "string"
}
], - "rows": [
- {
- "rowValues": [
- {
- "values": [
- {
- "value": { },
- "displayValue": "string"
}
]
}
]
}
]
}
Returns a XML representation of the message. The service type, report Id and report format are mandatory for the request.
serviceType required | string <int64> Unique identifier of the service type. Set to either BACSTel-IP or SECURE-IP. |
reportId required | integer <int64> Unique identifier of the Bacs report. |
reportFormat required | string <int64> Default: 0 Unique identifier of the report type to be downloaded. Set to:
|
curl -H "Content-Type: text/html" -X GET https://uk.pt-x.com/payments-service/api/bacs-messages/BACSTel-IP/9774/0
Updates the status of the Bacs message. The service type, report Id and readStatus are mandatory for the request.
serviceType required | string <string> Unique identifier of the service type. Either set to BACSTel-IP or SECURE-IP. |
reportId required | integer <int64> Unique identifier of the Bacs report, obtained from calling List bacs messages. |
readStatus required | integer <int64> Indicates if PTX should mark the message as read after the download. |
curl -H "Content-Type: application/json" -X PUT https://uk.pt-x.com/payments-service/api/bacs-messages/BACSTel-IP/bacs-report/9774/set-read-status/1
null
Marks a Bacs message as downloaded, even if the document is not downloaded. The service type, report Id and document Id are mandatory.
serviceType required | string <int64> Unique identifier of the service type. Set to either BACSTel-IP or SECURE-IP. |
reportId required | integer <int64> Unique identifier of the Bacs report. |
documentId required | integer <int64> Unique identifier of the Bacs document. |
curl -H "Content-Type: */*" -X POST https://uk.pt-x.com/payments-service/api/bacs-messages/mark-downloaded/BACSTel-IP/9774/223879829
Executes a query to list all Bacs messages. This call is available for collection profiles set up for Manual Data Entry and file import.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "BacsMessage",
- "symbol": "com.bottomline.cpay.model.bacs.reportitem",
- "key": "com.bottomline.cpay.model.bacs.reports.reportitem"
}, - "resultFields": [
- {
- "name": "BacsMessage",
- "symbol": "com.bottomline.cpay.model.bacs.reports.ReportItem",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "BacsMessage",
- "symbol": "com.bottomline.cpay.model.bacs.reports.ReportItem",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8556",
- "reportId": 8556,
- "type": "Arrival",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "REFT Arrival Report (2011)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 920556730,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8557",
- "reportId": 8557,
- "type": "Input",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "REFT Input Report (2013)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 2083356144,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8558",
- "reportId": 8558,
- "type": "Test Input",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "Test Input Report (2025)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 1405042097,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8559",
- "reportId": 8559,
- "type": "ARUCS",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "ARUCS Report (1027)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 1027100265,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8560",
- "reportId": 8560,
- "type": "ARUDD",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "ARUDD Report (1016)",
- "read": true,
- "isFasterPayments": false,
- "documentId": 1016100265,
- "processed": "REVIEW",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8561",
- "reportId": 8561,
- "type": "Test",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "Generic Test Report",
- "read": false,
- "isFasterPayments": false,
- "documentId": 86735623,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8569",
- "reportId": 8569,
- "type": "DDICA",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "DDICA",
- "read": false,
- "isFasterPayments": false,
- "documentId": 10196602,
- "processed": "REVIEW",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8563",
- "reportId": 8563,
- "type": "Withdrawal",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "Withdrawal Report (2014)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 1323841257,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8564",
- "reportId": 8564,
- "type": "ADDACS",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "ADDACS (7001)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 7001100265,
- "processed": "REVIEW",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8565",
- "reportId": 8565,
- "type": "AUDDIS",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "AUDDIS Bank Returned DDI (7002)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 7002100265,
- "processed": "REVIEW",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8566",
- "reportId": 8566,
- "type": "AUDDIS",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "AUDDIS File Acceptance (7003)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 7003100265,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8567",
- "reportId": 8567,
- "type": "AUDDIS",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "AUDDIS File Rejection (7004)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 7004100265,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8568",
- "reportId": 8568,
- "type": "AWACS",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "AWACS (7007)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 242242584,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8562",
- "reportId": 8562,
- "type": "Test Advice",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "AUDDIS Bank Returned DDI",
- "read": false,
- "isFasterPayments": false,
- "documentId": 405276514,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 14
}
}
]
}
]
}
]
}
Executes a query for Bacs messages not downloaded.
In the reponse the possible values for the processed field are:
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
resultFields required | Array of any The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "BacsMessage",
- "symbol": "com.bottomline.cpay.model.bacs.reports.reportitem",
- "key": "com.bottomline.cpay.model.bacs.reports.reportitem"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "Downloaded",
- "symbol": "com.bottomline.cpay.model.bacs.reportitem.downloaded",
- "fieldType": "BOOLEAN",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "boolean",
- "$value": false
}
}
]
}, - "resultFields": [
- {
- "name": "BacsMessage",
- "symbol": "com.bottomline.cpay.model.bacs.reports.ReportItem",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "BacsMessage",
- "symbol": "com.bottomline.cpay.model.bacs.reports.ReportItem",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8557",
- "reportId": 8557,
- "type": "Input",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "REFT Input Report (2013)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 2083356144,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8558",
- "reportId": 8558,
- "type": "Test Input",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "Test Input Report (2025)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 1405042097,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8559",
- "reportId": 8559,
- "type": "ARUCS",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "ARUCS Report (1027)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 1027100265,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8560",
- "reportId": 8560,
- "type": "ARUDD",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "ARUDD Report (1016)",
- "read": true,
- "isFasterPayments": false,
- "documentId": 1016100265,
- "processed": "REVIEW",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8562",
- "reportId": 8562,
- "type": "Test Advice",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "AUDDIS Bank Returned DDI",
- "read": false,
- "isFasterPayments": false,
- "documentId": 405276514,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8569",
- "reportId": 8569,
- "type": "DDICA",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "DDICA",
- "read": false,
- "isFasterPayments": false,
- "documentId": 10196602,
- "processed": "REVIEW",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8564",
- "reportId": 8564,
- "type": "ADDACS",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "ADDACS (7001)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 7001100265,
- "processed": "REVIEW",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8565",
- "reportId": 8565,
- "type": "AUDDIS",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "AUDDIS Bank Returned DDI (7002)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 7002100265,
- "processed": "REVIEW",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8566",
- "reportId": 8566,
- "type": "AUDDIS",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "AUDDIS File Acceptance (7003)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 7003100265,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8567",
- "reportId": 8567,
- "type": "AUDDIS",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "AUDDIS File Rejection (7004)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 7004100265,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8568",
- "reportId": 8568,
- "type": "AWACS",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "AWACS (7007)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 242242584,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ReportViewItem",
- "id": "BACS8563",
- "reportId": 8563,
- "type": "Withdrawal",
- "serviceUserNumber": "100265",
- "date": "2018-08-06T00:00:00.000",
- "name": "Withdrawal Report (2014)",
- "read": false,
- "isFasterPayments": false,
- "documentId": 1323841257,
- "processed": "BLANK",
- "downloaded": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 12
}
}
]
}
]
}
]
}
Executes a query for Bacs messages instruction detail by report id.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "BacsReportDdmLog",
- "symbol": "com.bottomline.ddm.model.bacsreportddmlog",
- "key": "com.bottomline.ddm.model.bacsreportddmlog"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "reportId",
- "symbol": "com.bottomline.ddm.model.BacsReportDdmLog.profileId",
- "fieldType": "LONG",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "long",
- "$value": 8560
}
}
]
}, - "resultFields": [
- {
- "name": "BacsReportDdmLog",
- "symbol": "com.bottomline.ddm.model.bacs.reports.BacsReportDdmLo",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "BacsReportDdmLog",
- "symbol": "com.bottomline.ddm.model.bacs.reports.BacsReportDdmLog",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsReportDdmLog",
- "id": 26160,
- "message": "ARUDD Report (1016) (id: 8,560):Instruction not found by SUN: \"121212\", reference: \"00783789U\", sort code: \"902194\", account number: \"49204813\", payment date: \"2010-08-10\", amount: \"253.68\", status: \"SUCCESS\".",
- "appliedTimestamp": "2018-09-07T02:00:00.601",
- "reportId": 8560,
- "reportType": "ARUDD"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsReportDdmLog",
- "id": 26161,
- "message": "ARUDD Report (1016) (id: 8,560):Instruction not found by SUN: \"121212\", reference: \"00793597U\", sort code: \"902274\", account number: \"49959781\", payment date: \"2010-08-10\", amount: \"35.48\", status: \"SUCCESS\".",
- "appliedTimestamp": "2018-09-07T02:00:00.633",
- "reportId": 8560,
- "reportType": "ARUDD"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsReportDdmLog",
- "id": 26162,
- "message": "ARUDD Report (1016) (id: 8,560):Instruction not found by SUN: \"121212\", reference: \"01004361R\", sort code: \"404324\", account number: \"92091712\", payment date: \"2010-08-10\", amount: \"273.48\", status: \"SUCCESS\".",
- "appliedTimestamp": "2018-09-07T02:00:00.636",
- "reportId": 8560,
- "reportType": "ARUDD"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsReportDdmLog",
- "id": 26163,
- "message": "ARUDD Report (1016) (id: 8,560):Instruction not found by SUN: \"121212\", reference: \"01011344M\", sort code: \"902100\", account number: \"27640059\", payment date: \"2010-08-10\", amount: \"78.68\", status: \"SUCCESS\".",
- "appliedTimestamp": "2018-09-07T02:00:00.640",
- "reportId": 8560,
- "reportType": "ARUDD"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsReportDdmLog",
- "id": 26164,
- "message": "ARUDD Report (1016) (id: 8,560):Instruction not found by SUN: \"121212\", reference: \"01051230M\", sort code: \"902194\", account number: \"20437779\", payment date: \"2010-08-10\", amount: \"31.17\", status: \"SUCCESS\".",
- "appliedTimestamp": "2018-09-07T02:00:00.643",
- "reportId": 8560,
- "reportType": "ARUDD"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsReportDdmLog",
- "id": 26165,
- "message": "ARUDD Report (1016) (id: 8,560):Instruction not found by SUN: \"121212\", reference: \"01054981A\", sort code: \"089417\", account number: \"01001105\", payment date: \"2010-08-10\", amount: \"21.22\", status: \"SUCCESS\".",
- "appliedTimestamp": "2018-09-07T02:00:00.647",
- "reportId": 8560,
- "reportType": "ARUDD"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsReportDdmLog",
- "id": 26166,
- "message": "ARUDD Report (1016) (id: 8,560):Instruction not found by SUN: \"121212\", reference: \"01140413G\", sort code: \"902311\", account number: \"38062143\", payment date: \"2010-08-10\", amount: \"31.07\", status: \"SUCCESS\".",
- "appliedTimestamp": "2018-09-07T02:00:00.650",
- "reportId": 8560,
- "reportType": "ARUDD"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsReportDdmLog",
- "id": 26167,
- "message": "ARUDD Report (1016) (id: 8,560):Instruction not found by SUN: \"121212\", reference: \"01159616V\", sort code: \"609204\", account number: \"91704315\", payment date: \"2010-08-10\", amount: \"33.04\", status: \"SUCCESS\".",
- "appliedTimestamp": "2018-09-07T02:00:00.653",
- "reportId": 8560,
- "reportType": "ARUDD"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsReportDdmLog",
- "id": 26168,
- "message": "ARUDD Report (1016) (id: 8,560):Instruction not found by SUN: \"121212\", reference: \"00212352N\", sort code: \"601730\", account number: \"83452818\", payment date: \"2010-08-11\", amount: \"58.19\", status: \"SUCCESS\".",
- "appliedTimestamp": "2018-09-07T02:00:00.656",
- "reportId": 8560,
- "reportType": "ARUDD"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsReportDdmLog",
- "id": 26169,
- "message": "ARUDD Report (1016) (id: 8,560):Instruction not found by SUN: \"121212\", reference: \"00213294T\", sort code: \"010838\", account number: \"23463880\", payment date: \"2010-08-11\", amount: \"51.08\", status: \"SUCCESS\".",
- "appliedTimestamp": "2018-09-07T02:00:00.659",
- "reportId": 8560,
- "reportType": "ARUDD"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsReportDdmLog",
- "id": 26170,
- "message": "ARUDD Report (1016) (id: 8,560):Instruction not found by SUN: \"121212\", reference: \"00215186B\", sort code: \"309826\", account number: \"02762618\", payment date: \"2010-08-11\", amount: \"53.72\", status: \"SUCCESS\".",
- "appliedTimestamp": "2018-09-07T02:00:00.663",
- "reportId": 8560,
- "reportType": "ARUDD"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsReportDdmLog",
- "id": 26171,
- "message": "ARUDD Report (1016) (id: 8,560):Instruction not found by SUN: \"121212\", reference: \"00221814C\", sort code: \"090126\", account number: \"20474664\", payment date: \"2010-08-11\", amount: \"20.05\", status: \"SUCCESS\".",
- "appliedTimestamp": "2018-09-07T02:00:00.666",
- "reportId": 8560,
- "reportType": "ARUDD"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "BacsReportDdmLog",
- "id": 26172,
- "message": "ARUDD report Id 8,560 process failed.Unable to process 12 items of 12.",
- "appliedTimestamp": "2018-09-07T02:00:00.669",
- "reportId": 8560,
- "reportType": "ARUDD"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 13
}
}
]
}
]
}
]
}
Collection Profiles are used for Direct Debit collections.
Collection profiles contain all the information that the Direct Debit Management system needs for processing direct debit payments including email preferences, document settings and notice period for mandates.
Executes a query to list all collection profiles.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Profiles",
- "symbol": "com.bottomline.ddm.model.profile",
- "key": "com.bottomline.ddm.model.profile"
}, - "resultFields": [
- {
- "name": "AllProfilesForAdminUser",
- "symbol": "com.bottomline.ddm.model.profile.AllProfilesForAdminUser",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "AllProfilesForAdminUser",
- "symbol": "com.bottomline.ddm.model.profile.AllProfilesForAdminUser",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Profile",
- "id": 4826,
- "name": "TEST COLLECTION PROFILE",
- "applicationId": 6421,
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "representationRetries": 0,
- "representationDelay": 15,
- "suppress01": false,
- "suppress19": true,
- "suppressAuddis": false,
- "prefix": "1234",
- "contactName": "Alex Martin",
- "contactCompany": "Mr.",
- "contactAddress": "115 Chatham Street",
- "contactPhone": "7535721177",
- "contactEmail": "a@b.com",
- "isMandateRefEditable": true,
- "isAttachmentUsed": true,
- "emailDetailsId": 4752,
- "communicationTriggersId": 4636,
- "autoCloseBatch": false,
- "nonAuddis": false,
- "ownEmailDomain": true,
- "enableDrive": false,
- "uploadWatchFolder": "",
- "deleteOriginalFile": false,
- "autoReportDownload": false,
- "salutation": "Dear",
- "encryptedFileImport": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Profile",
- "id": 5761,
- "name": "TEST COLLECTION PROFILE 2",
- "applicationId": 6421,
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "representationRetries": 0,
- "representationDelay": 3,
- "suppress01": false,
- "suppress19": true,
- "suppressAuddis": false,
- "contactName": "John Smith",
- "contactCompany": "John Smith Industries",
- "contactPhone": "012345",
- "contactEmail": "Z@Z.com",
- "isMandateRefEditable": true,
- "isAttachmentUsed": true,
- "emailDetailsId": 5667,
- "communicationTriggersId": 5551,
- "communicationSettingsId": 4525,
- "autoCloseBatch": true,
- "nonAuddis": false,
- "ownEmailDomain": true,
- "enableDrive": false,
- "uploadWatchFolder": "",
- "deleteOriginalFile": false,
- "autoReportDownload": false,
- "salutation": "Dear",
- "encryptedFileImport": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 2
}
}
]
}
]
}
]
}
Executes a query to search for a collection profile by name
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Profiles",
- "symbol": "com.bottomline.ddm.model.profile",
- "key": "com.bottomline.ddm.model.profile"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "name",
- "symbol": "com.bottomline.ddm.model.profile.Profile.name",
- "fieldType": "STRING_C1",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "string",
- "$value": "TEST COLLECTION PROFILE"
}
}
]
}, - "resultFields": [
- {
- "name": "AllProfilesForAdminUser",
- "symbol": "com.bottomline.ddm.model.profile.AllProfilesForAdminUser",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "AllProfilesForAdminUser",
- "symbol": "com.bottomline.ddm.model.profile.AllProfilesForAdminUser",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Profile",
- "id": 4826,
- "name": "TEST COLLECTION PROFILE",
- "applicationId": 6421,
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "representationRetries": 0,
- "representationDelay": 15,
- "suppress01": false,
- "suppress19": true,
- "suppressAuddis": false,
- "prefix": "1234",
- "contactName": "Alex Martin",
- "contactCompany": "Mr.",
- "contactAddress": "115 Chatham Street",
- "contactPhone": "7535721177",
- "contactEmail": "a@b.com",
- "isMandateRefEditable": true,
- "isAttachmentUsed": true,
- "emailDetailsId": 4752,
- "communicationTriggersId": 4636,
- "autoCloseBatch": false,
- "nonAuddis": false,
- "ownEmailDomain": true,
- "enableDrive": false,
- "uploadWatchFolder": "",
- "deleteOriginalFile": false,
- "autoReportDownload": false,
- "salutation": "Dear",
- "encryptedFileImport": false
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 1
}
}
]
}
]
}
]
}
Plan templates are used for Direct Debit collections.
A plan template is a template for recurring payments, when collection patterns are well defined. The API allows you to create, delete and update your plan templates. You can retrieve individual plan templates as well as a list of all your plan templates.
curl -H "Content-Type: application/json" -X GET https://uk.pt-x.com/payments-service/api/ddm/templates
[- {
- "WeeklyPlanTemplate": {
- "@type": "WeeklyPlanTemplate",
- "templateName": "Weekly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthWeek": 1,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPlanTemplate": {
- "@type": "MonthlyPlanTemplate",
- "templateName": "Monthly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthMonth": 1,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPlanTemplate": {
- "@type": "MonthlyPickPlanTemplate",
- "templateName": "Costumized Monthly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthMonth": 1,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPlanTemplate": {
- "@type": "YearlyPlanTemplate",
- "templateName": "Yearly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
]
Creates a new plan template.
The plan template model.
object (WeeklyPlanTemplate) | |
object (MonthlyPlanTemplate) | |
object (MonthlyPickPlanTemplate) | |
object (YearlyPlanTemplate) |
{- "WeeklyPlanTemplate": {
- "@type": "WeeklyPlanTemplate",
- "templateName": "Weekly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthWeek": 1,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPlanTemplate": {
- "@type": "MonthlyPlanTemplate",
- "templateName": "Monthly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthMonth": 1,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPlanTemplate": {
- "@type": "MonthlyPickPlanTemplate",
- "templateName": "Costumized Monthly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthMonth": 1,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPlanTemplate": {
- "@type": "YearlyPlanTemplate",
- "templateName": "Yearly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
{- "WeeklyPlanTemplate": {
- "@type": "WeeklyPlanTemplate",
- "templateName": "Weekly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthWeek": 1,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPlanTemplate": {
- "@type": "MonthlyPlanTemplate",
- "templateName": "Monthly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthMonth": 1,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPlanTemplate": {
- "@type": "MonthlyPickPlanTemplate",
- "templateName": "Costumized Monthly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthMonth": 1,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPlanTemplate": {
- "@type": "YearlyPlanTemplate",
- "templateName": "Yearly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
Retrieves a plan template by unique identifier
id required | integer <int64> ID of plan template, obtained from the List all plan templates call. |
curl -H "Content-Type: application/json" -X GET https://uk.pt-x.com/payments-service/api/ddm/templates/45
{- "WeeklyPlanTemplate": {
- "@type": "WeeklyPlanTemplate",
- "templateName": "Weekly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthWeek": 1,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPlanTemplate": {
- "@type": "MonthlyPlanTemplate",
- "templateName": "Monthly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthMonth": 1,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPlanTemplate": {
- "@type": "MonthlyPickPlanTemplate",
- "templateName": "Costumized Monthly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthMonth": 1,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPlanTemplate": {
- "@type": "YearlyPlanTemplate",
- "templateName": "Yearly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
Updates an existing plan template.
id required | string ID of plan template, obtained from the List all plan templates call. |
The plan template model.
object (WeeklyPlanTemplate) | |
object (MonthlyPlanTemplate) | |
object (MonthlyPickPlanTemplate) | |
object (YearlyPlanTemplate) |
{- "WeeklyPlanTemplate": {
- "@type": "WeeklyPlanTemplate",
- "templateName": "Weekly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthWeek": 1,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPlanTemplate": {
- "@type": "MonthlyPlanTemplate",
- "templateName": "Monthly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthMonth": 1,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPlanTemplate": {
- "@type": "MonthlyPickPlanTemplate",
- "templateName": "Costumized Monthly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthMonth": 1,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPlanTemplate": {
- "@type": "YearlyPlanTemplate",
- "templateName": "Yearly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
{- "WeeklyPlanTemplate": {
- "@type": "WeeklyPlanTemplate",
- "templateName": "Weekly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthWeek": 1,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPlanTemplate": {
- "@type": "MonthlyPlanTemplate",
- "templateName": "Monthly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthMonth": 1,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPlanTemplate": {
- "@type": "MonthlyPickPlanTemplate",
- "templateName": "Costumized Monthly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "everyNthMonth": 1,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPlanTemplate": {
- "@type": "YearlyPlanTemplate",
- "templateName": "Yearly Plan Template",
- "id": 101,
- "allowFrequencyChange": true,
- "allowAmountChange": true,
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "amountType": "0",
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
Deletes an existing plan template.
id required | integer <int64> ID of plan template, obtained from the List all plan templates call. |
curl -H "Content-Type: application/json" -X DELETE https://uk.pt-x.com/payments-service/api/ddm/templates/45
Contacts are used for Direct Debit collections.
A contact holds a person's or company's details whose accounts will be debited.The API allows you to create, delete and update your contacts. You can retrieve individual contacts as well as a list of all your contacts.
curl -H "Content-Type: application/json" -X GET https://uk.pt-x.com/payments-service/api/ddm/contacts
[- {
- "type": "PERSON",
- "title": "MR",
- "firstName": "Carlos",
- "lastName": "Page",
- "email": "cpage@mb-contact.com",
- "isAttachmentUsed": true,
- "communicationPref": "EMAIL",
- "address": {
- "lines": "530 HIGH ST",
- "town": "WESTBURY",
- "county": "WILTS",
- "code": "BA133BN",
- "country": "UK"
}, - "id": 101,
- "companyName": "Mercedes Benz",
- "reference": "UniqueReference-1234",
- "phone": "123456789"
}
]
Creates a new contact.
Contact model.
title required | string Title. |
firstName required | string First name of the contact. |
lastName required | string Last name of the contact. |
email required | string E-mail address of the contact. |
isAttachmentUsed | boolean If true, communications sent as attachments. Otherwise sent as part of the email body. |
communicationPref required | string (CommunicationPref) Enum: "LOCAL_PRINT" "EMAIL" "SERVICE_PRINT" "POST" Communications preference. |
required | object (Address) The address of the contact. |
companyName | string Company Name |
reference | string Reference is an unique identifier that can be associated with the contact object. If not provided, the PTX system will use the contact Id to generate the reference internally. Reference can be, for example, membership ID, CRM ID or some other ID from an external system. This reference is used on imports when updating an existing contact. If the reference is not provided on the import file, the system will assume that a new contact should be created. |
phone | string Phone number of the contact. |
{- "title": "MR",
- "firstName": "Carlos",
- "lastName": "Page",
- "email": "cpage@mb-contact.com",
- "isAttachmentUsed": true,
- "communicationPref": "EMAIL",
- "address": {
- "lines": "530 HIGH ST",
- "town": "WESTBURY",
- "county": "WILTS",
- "code": "BA133BN",
- "country": "UK"
}, - "companyName": "Mercedes Benz",
- "reference": "UniqueReference-1234",
- "phone": "123456789"
}
{- "type": "PERSON",
- "title": "MR",
- "firstName": "Carlos",
- "lastName": "Page",
- "email": "cpage@mb-contact.com",
- "isAttachmentUsed": true,
- "communicationPref": "EMAIL",
- "address": {
- "lines": "530 HIGH ST",
- "town": "WESTBURY",
- "county": "WILTS",
- "code": "BA133BN",
- "country": "UK"
}, - "id": 101,
- "companyName": "Mercedes Benz",
- "reference": "UniqueReference-1234",
- "phone": "123456789"
}
Retrieves details of a contact using unique identifier.
id required | integer <int64> Contact identifier, obtained from the List all contacts call. |
curl -H "Content-Type: application/json" -X GET https://uk.pt-x.com/payments-service/api/ddm/contacts/52
{- "type": "PERSON",
- "title": "MR",
- "firstName": "Carlos",
- "lastName": "Page",
- "email": "cpage@mb-contact.com",
- "isAttachmentUsed": true,
- "communicationPref": "EMAIL",
- "address": {
- "lines": "530 HIGH ST",
- "town": "WESTBURY",
- "county": "WILTS",
- "code": "BA133BN",
- "country": "UK"
}, - "id": 101,
- "companyName": "Mercedes Benz",
- "reference": "UniqueReference-1234",
- "phone": "123456789"
}
Updates the details of a contact.
id required | string Contact identifier, obtained from the List all contacts call. |
Contact model.
type | string Contact type - PERSON. |
title | string Title. |
firstName | string First name of the contact. |
lastName | string Last name of the contact. |
string E-mail address of the contact. | |
isAttachmentUsed | boolean If true, communications sent as attachments. Otherwise sent as part of the email body. |
communicationPref | string (CommunicationPref) Enum: "LOCAL_PRINT" "EMAIL" "SERVICE_PRINT" "POST" Communications preference. |
object (Address) The address of the contact. | |
id | integer <int64> Unique identifier for the contact generated by PTX and returned in the response. Used to retrieve, update and delete a contact. |
companyName | string Company Name |
reference | string Reference is an unique identifier that can be associated with the contact object. If not provided, the PTX system will use the contact Id to generate the reference internally. Reference can be, for example, membership ID, CRM ID or some other ID from an external system. This reference is used on imports when updating an existing contact. If the reference is not provided on the import file, the system will assume that a new contact should be created. |
phone | string Phone number of the contact. |
{- "type": "PERSON",
- "title": "MR",
- "firstName": "Carlos",
- "lastName": "Page",
- "email": "cpage@mb-contact.com",
- "isAttachmentUsed": true,
- "communicationPref": "EMAIL",
- "address": {
- "lines": "530 HIGH ST",
- "town": "WESTBURY",
- "county": "WILTS",
- "code": "BA133BN",
- "country": "UK"
}, - "id": 101,
- "companyName": "Mercedes Benz",
- "reference": "UniqueReference-1234",
- "phone": "123456789"
}
{- "type": "PERSON",
- "title": "MR",
- "firstName": "Carlos",
- "lastName": "Page",
- "email": "cpage@mb-contact.com",
- "isAttachmentUsed": true,
- "communicationPref": "EMAIL",
- "address": {
- "lines": "530 HIGH ST",
- "town": "WESTBURY",
- "county": "WILTS",
- "code": "BA133BN",
- "country": "UK"
}, - "id": 101,
- "companyName": "Mercedes Benz",
- "reference": "UniqueReference-1234",
- "phone": "123456789"
}
Looks up the supplied address of the payer.
Address lookup is performed on the partial address supplied.
lines required | string Address lines. |
town required | string Town. |
county required | string County. |
code required | string Postcode. |
country required | string Country. |
{- "lines": "530 HIGH ST",
- "town": "WESTBURY",
- "county": "WILTS",
- "code": "BA133BN",
- "country": "UK"
}
{- "type": "PERSON",
- "title": "MR",
- "firstName": "Carlos",
- "lastName": "Page",
- "email": "cpage@mb-contact.com",
- "isAttachmentUsed": true,
- "communicationPref": "EMAIL",
- "address": {
- "lines": "530 HIGH ST",
- "town": "WESTBURY",
- "county": "WILTS",
- "code": "BA133BN",
- "country": "UK"
}, - "id": 101,
- "companyName": "Mercedes Benz",
- "reference": "UniqueReference-1234",
- "phone": "123456789"
}
curl -H "Content-Type: application/json" -X GET https://uk.pt-x.com/payments-service/api/ddm/contacts/address-lookup-available
{- "type": "PERSON",
- "title": "MR",
- "firstName": "Carlos",
- "lastName": "Page",
- "email": "cpage@mb-contact.com",
- "isAttachmentUsed": true,
- "communicationPref": "EMAIL",
- "address": {
- "lines": "530 HIGH ST",
- "town": "WESTBURY",
- "county": "WILTS",
- "code": "BA133BN",
- "country": "UK"
}, - "id": 101,
- "companyName": "Mercedes Benz",
- "reference": "UniqueReference-1234",
- "phone": "123456789"
}
Executes a query to search for a contact by last name.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Contacts",
- "symbol": "com.bottomline.ddm.model.contact",
- "key": "com.bottomline.ddm.model.contact"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "lastName",
- "symbol": "com.bottomline.ddm.model.contact.Contact.lastName",
- "fieldType": "STRING",
- "key": false
}, - "operator": {
- "symbol": "CONTAINS"
}, - "queryValue": {
- "@type": "string",
- "$value": "Jones"
}
}
]
}, - "resultFields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.contact.Contact",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.contact.Contact",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ContactDTO",
- "id": 6447936,
- "type": "PERSON",
- "title": "MR",
- "lastName": "Jones",
- "status": "ACTIVE",
- "communicationPref": "LOCAL_PRINT",
- "companyName": "NoName Ltd",
- "reference": "NONAMEDDREF",
- "address": {
- "id": 6448732,
- "lines": [
- "909 No Name Avenue"
], - "town": "No Name City",
- "county": "Nonameshire",
- "code": "NO1N 4ME",
- "country": "UK"
}, - "isAttachmentUsed": true,
- "email": "LastnameOnly@b.com",
- "phone": "+012012012012"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 1
}
}
]
}
]
}
]
}
Executes a query to search for a contact by contact ref.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Contacts",
- "symbol": "com.bottomline.ddm.model.contact",
- "key": "com.bottomline.ddm.model.contact"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "reference",
- "symbol": "com.bottomline.ddm.model.contact.Contact.reference",
- "fieldType": "STRING",
- "key": false
}, - "operator": {
- "symbol": "CONTAINS"
}, - "queryValue": {
- "@type": "string",
- "$value": "05118122"
}
}
]
}, - "resultFields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.contact.Contact",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.contact.Contact",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "ContactDTO",
- "id": 7922236,
- "type": "PERSON",
- "firstName": "Lisa",
- "lastName": "Smith",
- "status": "ACTIVE",
- "communicationPref": "EMAIL",
- "reference": "05118122",
- "address": {
- "id": 7925051,
- "lines": [
- "1 Crown St",
- "Bewdley",
- "DY18 3QS"
], - "code": "AA11 1AA",
- "country": "UK"
}, - "isAttachmentUsed": true,
- "email": "a@b.com"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 1
}
}
]
}
]
}
]
}
Mandates are used for Direct Debit collections.
A Direct Debit Mandate is an authorisation from your customer to collect future payments from them when they are due. Mandates specify the bank details for the account from which the direct debit payments will be taken. The API allows you to create, delete and update your mandates. You can retrieve individual mandates as well as a list of all your mandates.
Returns a list of all mandates.
contactId required | string ID of contact, obtained from the List all contacts call. |
curl -H "Content-Type: application/json" -X GET https://uk.pt-x.com/payments-service/api/ddm/contacts/52/mandates
[- {
- "payerId": 52,
- "profileId": 101,
- "reference": "RFID-22012018-24",
- "sortCode": "200000",
- "accountNumber": "42222222",
- "id": 101,
- "altReference": "ALT/22012018-24",
- "accountName": "CARLOS SANTANA",
- "status": "ACTIVE",
- "comments": "Mandate was received as a hard copy.",
- "created": "2019-08-24T14:15:22Z",
- "validationStatus": "string",
- "paymentPlans": [
- {
- "WeeklyPaymentPlan": {
- "@type": "WeeklyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "@type": "MonthlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "@type": "MonthlyPickPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "@type": "YearlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
]
}
]
Creates a new mandate.
contactId required | string ID of contact. |
The mandate model.
payerId required | integer <int64> The ID of the payer (contact that owns this mandate). |
profileId required | integer <int64> The collection profile ID that this mandate is associated to. |
reference required | string Reference of the mandate. This is the reference that is used by the paying bank to register the mandate. |
sortCode required | string The sort code of the bank account to be debited. |
accountNumber required | string Account number of the bank account to be debited. |
altReference | string Alternative reference. This reference is only used if you need to associate the mandate with some other system and the original reference cannot be used, as the key from the other system does not comply with Bacs character requirements. For example, the mandate reference is a maximum of 18 characters and the following characters are valid (&-./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ ). If you wish to associate the mandate with another entity from a system that is longer than 18 characters or contains characters not listed above, then alternative reference should be used. |
accountName required | string Account name of the account to be debited. |
status | string Status of the mandate, where possible values are ACTIVE, SUSPENDED, CANCELLED, DELETED, DRAFT. |
comments | string Free text you wish to record against the mandate. |
created | string <date-time> Date and time when the mandate was created. This is read only and set by the server. |
{- "payerId": 52,
- "profileId": 101,
- "reference": "RFID-22012018-24",
- "sortCode": "200000",
- "accountNumber": "42222222",
- "altReference": "ALT/22012018-24",
- "accountName": "CARLOS SANTANA",
- "status": "DRAFT",
- "comments": "Mandate was received as a hard copy.",
- "created": "2019-08-24T14:15:22Z"
}
{- "id": 101,
- "payerId": 52,
- "profileId": 101,
- "reference": "RFID-22012018-24",
- "altReference": "ALT/22012018-24",
- "sortCode": "200000",
- "accountName": "CARLOS SANTANA",
- "accountNumber": "42222222",
- "status": "DRAFT",
- "created": "2019-08-24T14:15:22Z",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z"
}
Retrieves details of a mandate using unique identifier.
id required | integer <int64> ID of mandate, obtained from the List all mandates call. |
contactId required | string ID of contact, obtained from the List all contacts call. |
curl -H "Content-Type: application/json" -X GET https://uk.pt-x.com/payments-service/api/ddm/contacts/52/mandates/104
{- "payerId": 52,
- "profileId": 101,
- "reference": "RFID-22012018-24",
- "sortCode": "200000",
- "accountNumber": "42222222",
- "id": 101,
- "altReference": "ALT/22012018-24",
- "accountName": "CARLOS SANTANA",
- "status": "ACTIVE",
- "comments": "Mandate was received as a hard copy.",
- "created": "2019-08-24T14:15:22Z",
- "validationStatus": "string",
- "paymentPlans": [
- {
- "WeeklyPaymentPlan": {
- "@type": "WeeklyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "@type": "MonthlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "@type": "MonthlyPickPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "@type": "YearlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
]
}
Updates the details of a mandate.
id required | string ID of mandate, obtained from the List all mandates call. |
contactId required | string ID of contact, obtained from the List all contacts call. |
The mandate model.
payerId required | integer <int64> ID of contact (the same value as the path parameter contactId). |
profileId required | integer <int64> The collection profile ID that this mandate is associated to. |
reference required | string Reference of the mandate. This is the reference that is used by the paying bank to register the mandate. |
sortCode required | string The sort code of the bank account to be debited. |
accountNumber required | string Account number of the bank account to be debited. |
id required | integer <int64> The ID of the mandate. |
altReference | string Alternative reference. This reference is only used if you need to associate the mandate with some other system and the original reference cannot be used, as the key from the other system does not comply with Bacs character requirements. For example, the mandate reference is a maximum of 18 characters and the following characters are valid (&-./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ ). If you wish to associate the mandate with another entity from a system that is longer than 18 characters or contains characters not listed above, then alternative reference should be used. |
accountName | string Account name of the account to be debited. |
status required | string Status of the mandate, where possible values are ACTIVE, SUSPENDED, CANCELLED, DELETED, DRAFT. |
comments | string Free text you wish to record against the mandate. |
created | string <date-time> Date and time when the mandate was created. This is read only and set by the server. |
validationStatus | string Ownership verification status. |
Array of objects (PaymentPlan) The list of payment plans associated to this mandate. Currently only one payment plan can be added against the mandate. |
{- "payerId": 52,
- "profileId": 101,
- "reference": "RFID-22012018-24",
- "sortCode": "200000",
- "accountNumber": "42222222",
- "id": 101,
- "altReference": "ALT/22012018-24",
- "accountName": "CARLOS SANTANA",
- "status": "ACTIVE",
- "comments": "Mandate was received as a hard copy.",
- "created": "2019-08-24T14:15:22Z",
- "validationStatus": "string",
- "paymentPlans": [
- {
- "WeeklyPaymentPlan": {
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
]
}
{- "payerId": 52,
- "profileId": 101,
- "reference": "RFID-22012018-24",
- "sortCode": "200000",
- "accountNumber": "42222222",
- "id": 101,
- "altReference": "ALT/22012018-24",
- "accountName": "CARLOS SANTANA",
- "status": "ACTIVE",
- "comments": "Mandate was received as a hard copy.",
- "created": "2019-08-24T14:15:22Z",
- "validationStatus": "string",
- "paymentPlans": [
- {
- "WeeklyPaymentPlan": {
- "@type": "WeeklyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "@type": "MonthlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "@type": "MonthlyPickPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "@type": "YearlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
]
}
Deletes an existing mandate.
id required | integer <int64> ID of mandate, obtained from the List all mandates call. |
contactId required | string ID of contact, obtained from the List all contacts call. |
curl -H "Content-Type: application/json" -X DELETE https://uk.pt-x.com/payments-service/api/ddm/contacts/52/mandates/104
Updates the status of a mandate.
mandateId required | integer <int64> ID of mandate, obtained from the List all mandates call. |
status required | string The status field can have the following possible values: ACTIVE, SUSPENDED, CANCELLED, DELETED, DRAFT. DRAFT status is used as an intermediate status until all the payment plans are added and associated to the new mandate. At the end of the process of creating a new mandate, the status should be changed to ACTIVE. This is to make sure that only one correspondence is created when creating a mandate with multiple plans. |
contactId required | string ID of contact, obtained from the List all contacts call. |
- Activate Mandate: curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/ddm/contacts/52/mandates/104/status/ACTIVE - Cancel Mandate: curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/ddm/contacts/52/mandates/104/status/CANCEL
{- "payerId": 52,
- "profileId": 101,
- "reference": "RFID-22012018-24",
- "sortCode": "200000",
- "accountNumber": "42222222",
- "id": 101,
- "altReference": "ALT/22012018-24",
- "accountName": "CARLOS SANTANA",
- "status": "ACTIVE",
- "comments": "Mandate was received as a hard copy.",
- "created": "2019-08-24T14:15:22Z",
- "validationStatus": "string",
- "paymentPlans": [
- {
- "WeeklyPaymentPlan": {
- "@type": "WeeklyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "@type": "MonthlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "@type": "MonthlyPickPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "@type": "YearlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
]
}
Creates a one-off transaction for the mandate.
mandateId required | integer <int64> ID of mandate, obtained from the List all mandates call. |
contactId required | string ID of contact, obtained from the List all contacts call. |
Create a one-off transaction for the mandate.
amount required | string The amount of the one-off payment. |
dueDate required | string <date-time> The due date of the one-off payment. |
comments required | string The comment or decription of the one-off payment. |
paymentType required | string (paymentType) Enum: "DEBIT" "REFUND" "AUDDIS" |
{- "amount": "45.50",
- "dueDate": "2019-08-24T14:15:22Z",
- "comments": "Additional one-off collection as agreed with client.",
- "paymentType": "DEBIT"
}
{- "amount": "45.50",
- "dueDate": "2019-08-24T14:15:22Z",
- "comments": "Additional one-off collection as agreed with client.",
- "paymentType": "DEBIT"
}
Adds an AUDDIS instruction for a mandate.
mandateId required | integer <int64> ID of mandate, obtained from the List all mandates call. |
contactId required | string ID of contact, obtained from the List all contacts call. |
Add AUDDIS instructions for the mandate.
instructionCode required | string Auddis instruction. |
{- "instructionCode": "0N"
}
Verifies an account owner.
contactId required | string ID of contact, obtained from the List all contacts call. |
Mandate model with account and contact details.
payerId required | integer <int64> The ID of the payer (contact that owns this mandate). |
profileId required | integer <int64> The collection profile ID that this mandate is associated to. |
reference required | string Reference of the mandate. This is the reference that is used by the paying bank to register the mandate. |
sortCode required | string The sort code of the bank account to be debited. |
accountNumber required | string Account number of the bank account to be debited. |
id | integer <int64> The ID of the mandate. |
altReference | string Alternative reference. This reference is only used if you need to associate the mandate with some other system and the original reference cannot be used, as the key from the other system does not comply with Bacs character requirements. For example, the mandate reference is a maximum of 18 characters and the following characters are valid (&-./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ ). If you wish to associate the mandate with another entity from a system that is longer than 18 characters or contains characters not listed above, then alternative reference should be used. |
accountName | string Account name of the account to be debited. |
status | string Status of the mandate, where possible values are ACTIVE, SUSPENDED, CANCELLED, DELETED, DRAFT. |
comments | string Free text you wish to record against the mandate. |
created | string <date-time> Date and time when the mandate was created. This is read only and set by the server. |
validationStatus | string Ownership verification status. |
Array of objects (PaymentPlan) The list of payment plans associated to this mandate. Currently only one payment plan can be added against the mandate. |
{- "payerId": 52,
- "profileId": 101,
- "reference": "RFID-22012018-24",
- "sortCode": "200000",
- "accountNumber": "42222222",
- "id": 101,
- "altReference": "ALT/22012018-24",
- "accountName": "CARLOS SANTANA",
- "status": "ACTIVE",
- "comments": "Mandate was received as a hard copy.",
- "created": "2019-08-24T14:15:22Z",
- "validationStatus": "string",
- "paymentPlans": [
- {
- "WeeklyPaymentPlan": {
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
]
}
{- "payerId": 52,
- "profileId": 101,
- "reference": "RFID-22012018-24",
- "sortCode": "200000",
- "accountNumber": "42222222",
- "id": 101,
- "altReference": "ALT/22012018-24",
- "accountName": "CARLOS SANTANA",
- "status": "ACTIVE",
- "comments": "Mandate was received as a hard copy.",
- "created": "2019-08-24T14:15:22Z",
- "validationStatus": "string",
- "paymentPlans": [
- {
- "WeeklyPaymentPlan": {
- "@type": "WeeklyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "@type": "MonthlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "@type": "MonthlyPickPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "@type": "YearlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
]
}
Executes a query to search for a mandate by contact ID.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
{- "entity": {
- "name": "Mandates",
- "symbol": "com.bottomline.ddm.model.mandate",
- "key": "com.bottomline.ddm.model.mandate"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "payerId",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate.payer.id",
- "fieldType": "LONG",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "long",
- "$value": 3689140
}
}
]
}, - "resultFields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
]
}
{- "fields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 5168729,
- "payerId": 3689140,
- "profileId": 4826,
- "reference": "NEW REF W PLAN",
- "sortCode": "888888",
- "accountName": "NEW REF W PLAN",
- "accountNumber": "77777777",
- "status": "DELETED",
- "created": "2018-09-05T14:51:24.550",
- "lastUpdated": "2018-09-05T14:52:47.622",
- "restrictedDate": "2018-09-19T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3747035,
- "payerId": 3689140,
- "profileId": 4826,
- "reference": "AUTO DD REF",
- "altReference": "AUTO DD ALT REF",
- "sortCode": "654321",
- "accountName": "ACCT HOLDER NAME",
- "accountNumber": "87654321",
- "status": "ACTIVE",
- "created": "2018-05-16T09:52:21.372",
- "lastUpdated": "2018-08-31T09:37:20.074",
- "restrictedDate": "2018-09-14T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3747031,
- "payerId": 3689140,
- "profileId": 4826,
- "reference": "DDREF101",
- "altReference": "ALTREF101",
- "sortCode": "101101",
- "accountName": "ACCT NAME 101",
- "accountNumber": "10100101",
- "status": "DELETED",
- "created": "2018-05-16T08:54:47.437",
- "lastUpdated": "2018-05-16T09:37:10.997",
- "restrictedDate": "2018-05-26T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3720667,
- "payerId": 3689140,
- "profileId": 4826,
- "reference": "TESTDDREF2",
- "altReference": "ALTDDREF2",
- "sortCode": "234567",
- "accountName": "TEST ACCOUNT NAME",
- "accountNumber": "23456789",
- "status": "ACTIVE",
- "created": "2018-05-01T09:18:01.103",
- "lastUpdated": "2018-10-25T15:49:25.048",
- "restrictedDate": "2018-05-11T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3720665,
- "payerId": 3689140,
- "profileId": 4826,
- "reference": "TESTDDREF1",
- "altReference": "ALTDDREF1",
- "sortCode": "123456",
- "accountName": "CHANGE GONNA COME",
- "accountNumber": "12345678",
- "status": "DELETED",
- "created": "2018-05-01T09:03:16.687",
- "lastUpdated": "2018-08-31T09:31:23.292",
- "restrictedDate": "2018-05-11T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 5
}
}
]
}
]
}
]
}
Executes a query to search for mandates that are not deleted.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Contacts",
- "symbol": "com.bottomline.ddm.model.mandate",
- "key": "com.bottomline.ddm.model.mandate"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "status",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate.status",
- "fieldType": "ENUM",
- "key": false
}, - "operator": {
- "symbol": "<>"
}, - "queryValue": {
- "@type": "string",
- "$value": "DELETED"
}
}
]
}, - "resultFields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 5641447,
- "payerId": 3691994,
- "profileId": 5900,
- "reference": "05641447",
- "altReference": "TEST001",
- "sortCode": "111111",
- "accountName": "T TEST",
- "accountNumber": "12345671",
- "status": "ACTIVE",
- "created": "2018-10-02T14:48:49.632",
- "lastUpdated": "2018-10-02T14:48:49.752",
- "restrictedDate": "2018-10-16T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 5275599,
- "payerId": 5118122,
- "profileId": 4826,
- "reference": "010203ABC",
- "altReference": "NEW EMAIL TEST",
- "sortCode": "805508",
- "accountName": "EXAMPLE ACC NAME",
- "accountNumber": "80055008",
- "status": "ACTIVE",
- "paymentPlanIds": [
- 1530782
], - "created": "2018-09-20T10:53:08.137",
- "lastUpdated": "2018-10-04T09:58:01.953",
- "restrictedDate": "2018-10-04T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 5164746,
- "payerId": 3691994,
- "profileId": 4826,
- "reference": "NEW REF ADHOC API",
- "altReference": "NEW ALT REF",
- "sortCode": "555555",
- "accountName": "NEW ACC NAME",
- "accountNumber": "44444444",
- "status": "ACTIVE",
- "paymentPlanIds": [
- 1553124
], - "created": "2018-09-05T14:47:46.772",
- "lastUpdated": "2018-10-23T09:36:25.860",
- "restrictedDate": "2018-09-19T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 5004606,
- "payerId": 4787304,
- "profileId": 4826,
- "reference": "20202020",
- "sortCode": "202020",
- "accountName": "JOHN SMITH",
- "accountNumber": "20202020",
- "status": "CANCELLED",
- "created": "2018-07-26T14:46:04.038",
- "lastUpdated": "2018-11-13T13:55:29.843",
- "restrictedDate": "2018-08-09T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876126,
- "payerId": 4787305,
- "profileId": 4826,
- "reference": "000424",
- "sortCode": "700007",
- "accountName": "4TH API ACCOUNT",
- "accountNumber": "70000007",
- "status": "ACTIVE",
- "paymentPlanIds": [
- 1553115
], - "created": "2018-07-06T14:37:47.303",
- "lastUpdated": "2018-10-19T09:41:11.216",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876125,
- "payerId": 4787304,
- "profileId": 4826,
- "reference": "000423",
- "sortCode": "600006",
- "accountName": "3RD API ACCOUNT",
- "accountNumber": "60000006",
- "status": "ACTIVE",
- "paymentPlanIds": [
- 1369912
], - "created": "2018-07-06T14:37:47.223",
- "lastUpdated": "2018-07-06T14:37:47.234",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876124,
- "payerId": 4787303,
- "profileId": 4826,
- "reference": "000422",
- "sortCode": "500005",
- "accountName": "2ST API ACCOUNT",
- "accountNumber": "50000005",
- "status": "ACTIVE",
- "created": "2018-07-06T14:34:19.024",
- "lastUpdated": "2018-07-06T14:34:19.035",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876123,
- "payerId": 4787302,
- "profileId": 4826,
- "reference": "DDREF 404",
- "sortCode": "400004",
- "accountName": "1ST API ACCOUNT",
- "accountNumber": "40000004",
- "status": "ACTIVE",
- "paymentPlanIds": [
- 1369911
], - "created": "2018-07-06T14:32:13.946",
- "lastUpdated": "2018-08-31T09:38:37.398",
- "restrictedDate": "2018-09-14T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3747035,
- "payerId": 3689140,
- "profileId": 4826,
- "reference": "AUTO DD REF",
- "altReference": "AUTO DD ALT REF",
- "sortCode": "654321",
- "accountName": "ACCT HOLDER NAME",
- "accountNumber": "87654321",
- "status": "ACTIVE",
- "created": "2018-05-16T09:52:21.372",
- "lastUpdated": "2018-08-31T09:37:20.074",
- "restrictedDate": "2018-09-14T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3731165,
- "payerId": 3691994,
- "profileId": 4826,
- "reference": "DDREF123",
- "altReference": "ALTREF123",
- "sortCode": "454545",
- "accountName": "TEST ACC NAME",
- "accountNumber": "54545454",
- "status": "ACTIVE",
- "paymentPlanIds": [
- 1210031
], - "created": "2018-05-10T13:31:21.620",
- "lastUpdated": "2018-09-20T07:58:42.350",
- "restrictedDate": "2018-05-24T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3720667,
- "payerId": 3689140,
- "profileId": 4826,
- "reference": "TESTDDREF2",
- "altReference": "ALTDDREF2",
- "sortCode": "234567",
- "accountName": "TEST ACCOUNT NAME",
- "accountNumber": "23456789",
- "status": "ACTIVE",
- "created": "2018-05-01T09:18:01.103",
- "lastUpdated": "2018-10-25T15:49:25.048",
- "restrictedDate": "2018-05-11T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 11
}
}
]
}
]
}
]
}
Executes a query to search for mandates by contact ID that are not deleted.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Mandates",
- "symbol": "com.bottomline.ddm.model.mandate",
- "key": "com.bottomline.ddm.model.mandate"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "payerId",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate.payer.id",
- "fieldType": "LONG",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "long",
- "$value": 3689140
}
}, - {
- "@type": "QueryRelationship",
- "name": "AND",
- "description": "AND relationship.",
- "symbol": "AND"
}, - {
- "@type": "QueryParameter",
- "field": {
- "name": "status",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate.status",
- "fieldType": "ENUM",
- "key": false
}, - "operator": {
- "symbol": "<>"
}, - "queryValue": [
- {
- "@type": "string",
- "$value": "DELETED"
}
]
}
]
}, - "resultFields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3747035,
- "payerId": 3689140,
- "profileId": 4826,
- "reference": "AUTO DD REF",
- "altReference": "AUTO DD ALT REF",
- "sortCode": "654321",
- "accountName": "ACCT HOLDER NAME",
- "accountNumber": "87654321",
- "status": "ACTIVE",
- "created": "2018-05-16T09:52:21.372",
- "lastUpdated": "2018-08-31T09:37:20.074",
- "restrictedDate": "2018-09-14T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3720667,
- "payerId": 3689140,
- "profileId": 4826,
- "reference": "TESTDDREF2",
- "altReference": "ALTDDREF2",
- "sortCode": "234567",
- "accountName": "TEST ACCOUNT NAME",
- "accountNumber": "23456789",
- "status": "ACTIVE",
- "created": "2018-05-01T09:18:01.103",
- "lastUpdated": "2018-10-25T15:49:25.048",
- "restrictedDate": "2018-05-11T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 2
}
}
]
}
]
}
]
}
Executes a query to search for mandates that are either cancelled or suspended.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Mandates",
- "symbol": "com.bottomline.ddm.model.mandate",
- "key": "com.bottomline.ddm.model.mandate"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "status",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate.status",
- "fieldType": "STRING",
- "key": false
}, - "operator": {
- "symbol": "IN"
}, - "queryValues": [
- {
- "@type": "string",
- "$value": "SUSPENDED"
}, - {
- "@type": "string",
- "$value": "CANCELLED"
}
]
}
]
}, - "resultFields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 5275599,
- "payerId": 5118122,
- "profileId": 4826,
- "reference": "010203ABC",
- "altReference": "NEW EMAIL TEST",
- "sortCode": "805508",
- "accountName": "EXAMPLE ACC NAME",
- "accountNumber": "80055008",
- "status": "CANCELLED",
- "created": "2018-09-20T10:53:08.137",
- "lastUpdated": "2019-03-25T10:18:13.281",
- "restrictedDate": "2018-10-04T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876124,
- "payerId": 4787303,
- "profileId": 4826,
- "reference": "000422",
- "sortCode": "500005",
- "accountName": "2ST API ACCOUNT",
- "accountNumber": "50000005",
- "status": "CANCELLED",
- "created": "2018-07-06T14:34:19.024",
- "lastUpdated": "2019-04-15T14:50:26.968",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876123,
- "payerId": 4787302,
- "profileId": 4826,
- "reference": "DDREF 404",
- "sortCode": "400004",
- "accountName": "1ST API ACCOUNT",
- "accountNumber": "40000004",
- "status": "SUSPENDED",
- "paymentPlanIds": [
- 1369911
], - "created": "2018-07-06T14:32:13.946",
- "lastUpdated": "2019-04-15T14:50:11.377",
- "restrictedDate": "2018-09-14T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 3
}
}
]
}
]
}
]
}
Executes a query to search for a mandate by profile ID.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Mandates",
- "symbol": "com.bottomline.ddm.model.mandate",
- "key": "com.bottomline.ddm.model.mandate"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "profileId",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate.profile.modelId",
- "fieldType": "LONG",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "long",
- "$value": 4826
}
}
]
}, - "resultFields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 5011398,
- "payerId": 4893904,
- "profileId": 4826,
- "reference": "937650",
- "altReference": "ALTREFHERE",
- "sortCode": "402204",
- "accountName": "4TH API ACCOUNT",
- "accountNumber": "44022044",
- "status": "ACTIVE",
- "created": "2018-08-02T15:55:40.630",
- "lastUpdated": "2018-08-30T08:10:55.543",
- "restrictedDate": "2018-08-16T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 5011397,
- "payerId": 4893903,
- "profileId": 4826,
- "reference": "927650",
- "sortCode": "987654",
- "accountName": "3RD API ACCOUNT",
- "accountNumber": "98765432",
- "status": "ACTIVE",
- "paymentPlanIds": [
- 1441975
], - "created": "2018-08-02T15:55:40.577",
- "lastUpdated": "2018-08-02T15:55:40.586",
- "restrictedDate": "2018-08-16T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 5011396,
- "payerId": 4893901,
- "profileId": 4826,
- "reference": "917650",
- "sortCode": "987654",
- "accountName": "3RD API ACCOUNT",
- "accountNumber": "98765432",
- "status": "ACTIVE",
- "paymentPlanIds": [
- 1441974
], - "created": "2018-08-02T15:55:22.915",
- "lastUpdated": "2018-08-02T15:55:22.926",
- "restrictedDate": "2018-08-16T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 5011395,
- "payerId": 4893897,
- "profileId": 4826,
- "reference": "987650",
- "sortCode": "987654",
- "accountName": "1ST API ACCOUNT",
- "accountNumber": "98765432",
- "status": "ACTIVE",
- "paymentPlanIds": [
- 1441973
], - "created": "2018-08-02T15:54:14.774",
- "lastUpdated": "2018-08-02T15:54:14.786",
- "restrictedDate": "2018-08-16T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 5011394,
- "payerId": 4893896,
- "profileId": 4826,
- "reference": "987653",
- "sortCode": "402204",
- "accountName": "2ND API ACCOUNT",
- "accountNumber": "44022044",
- "status": "ACTIVE",
- "created": "2018-08-02T15:52:03.724",
- "lastUpdated": "2018-08-02T15:52:03.737",
- "restrictedDate": "2018-08-16T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 5011393,
- "payerId": 4893895,
- "profileId": 4826,
- "reference": "987654",
- "sortCode": "987654",
- "accountName": "1ST API ACCOUNT",
- "accountNumber": "98765432",
- "status": "ACTIVE",
- "paymentPlanIds": [
- 1441972
], - "created": "2018-08-02T15:52:03.629",
- "lastUpdated": "2018-08-02T15:52:03.657",
- "restrictedDate": "2018-08-16T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 5010059,
- "payerId": 4892559,
- "profileId": 4826,
- "reference": "010204",
- "sortCode": "402204",
- "accountName": "2ND API ACCOUNT",
- "accountNumber": "44022044",
- "status": "ACTIVE",
- "created": "2018-08-02T15:46:05.452",
- "lastUpdated": "2018-08-02T15:46:05.468",
- "restrictedDate": "2018-08-16T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 5004606,
- "payerId": 4787304,
- "profileId": 4826,
- "reference": "20202020",
- "sortCode": "202020",
- "accountName": "JOHN SMITH",
- "accountNumber": "20202020",
- "status": "ACTIVE",
- "created": "2018-07-26T14:46:04.038",
- "lastUpdated": "2018-08-23T14:44:15.562",
- "restrictedDate": "2018-08-09T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876126,
- "payerId": 4787305,
- "profileId": 4826,
- "reference": "000424",
- "sortCode": "700007",
- "accountName": "4TH API ACCOUNT",
- "accountNumber": "70000007",
- "status": "ACTIVE",
- "created": "2018-07-06T14:37:47.303",
- "lastUpdated": "2018-07-06T14:37:47.312",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876125,
- "payerId": 4787304,
- "profileId": 4826,
- "reference": "000423",
- "sortCode": "600006",
- "accountName": "3RD API ACCOUNT",
- "accountNumber": "60000006",
- "status": "ACTIVE",
- "paymentPlanIds": [
- 1369912
], - "created": "2018-07-06T14:37:47.223",
- "lastUpdated": "2018-07-06T14:37:47.234",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876124,
- "payerId": 4787303,
- "profileId": 4826,
- "reference": "000422",
- "sortCode": "500005",
- "accountName": "2ST API ACCOUNT",
- "accountNumber": "50000005",
- "status": "ACTIVE",
- "created": "2018-07-06T14:34:19.024",
- "lastUpdated": "2018-07-06T14:34:19.035",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876123,
- "payerId": 4787302,
- "profileId": 4826,
- "reference": "000421",
- "sortCode": "400004",
- "accountName": "1ST API ACCOUNT",
- "accountNumber": "40000004",
- "status": "ACTIVE",
- "paymentPlanIds": [
- 1369911
], - "created": "2018-07-06T14:32:13.946",
- "lastUpdated": "2018-07-06T14:32:13.958",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876122,
- "payerId": 4787297,
- "profileId": 4826,
- "reference": "0012351",
- "sortCode": "404040",
- "accountName": "ADHOC MULTI-CONTAC",
- "accountNumber": "16161616",
- "status": "DELETED",
- "created": "2018-07-06T14:12:19.079",
- "lastUpdated": "2018-07-06T14:17:59.072",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876121,
- "payerId": 4787296,
- "profileId": 4826,
- "reference": "0012350",
- "sortCode": "404040",
- "accountName": "REGULAR MULTI-CONT",
- "accountNumber": "15151515",
- "status": "DELETED",
- "created": "2018-07-06T14:12:19.010",
- "lastUpdated": "2018-07-06T14:17:49.583",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876108,
- "payerId": 4787273,
- "profileId": 4826,
- "reference": "0012340",
- "sortCode": "404040",
- "accountName": "ADHOC MULTI-CONTAC",
- "accountNumber": "16161616",
- "status": "DELETED",
- "created": "2018-07-06T10:59:32.731",
- "lastUpdated": "2018-07-06T14:17:28.080",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876107,
- "payerId": 4787272,
- "profileId": 4826,
- "reference": "0012349",
- "sortCode": "404040",
- "accountName": "REGULAR MULTI-CONT",
- "accountNumber": "15151515",
- "status": "DELETED",
- "created": "2018-07-06T10:59:32.673",
- "lastUpdated": "2018-07-06T14:17:14.541",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876105,
- "payerId": 4787269,
- "profileId": 4826,
- "reference": "0012347",
- "sortCode": "404040",
- "accountName": "REGULAR MULTI-CONT",
- "accountNumber": "15151515",
- "status": "DELETED",
- "created": "2018-07-06T10:48:43.538",
- "lastUpdated": "2018-07-06T10:51:44.809",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876104,
- "payerId": 4787268,
- "profileId": 4826,
- "reference": "0012345",
- "sortCode": "404040",
- "accountName": "MULTI-CONTACT API",
- "accountNumber": "15151515",
- "status": "DELETED",
- "created": "2018-07-06T10:40:28.012",
- "lastUpdated": "2018-07-06T10:51:55.125",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4863790,
- "payerId": 4774551,
- "profileId": 4826,
- "reference": "0123456",
- "sortCode": "987654",
- "accountName": "GREEN ACCOUNT",
- "accountNumber": "98765432",
- "status": "DELETED",
- "created": "2018-06-28T08:55:56.181",
- "lastUpdated": "2018-07-06T10:52:11.234",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3747035,
- "payerId": 3689140,
- "profileId": 4826,
- "reference": "1526460741354",
- "altReference": "AUTO DD REF",
- "sortCode": "654321",
- "accountName": "ACCT HOLDER NAME",
- "accountNumber": "87654321",
- "status": "ACTIVE",
- "created": "2018-05-16T09:52:21.372",
- "lastUpdated": "2018-05-16T09:54:18.900",
- "restrictedDate": "2018-05-26T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3747031,
- "payerId": 3689140,
- "profileId": 4826,
- "reference": "DDREF101",
- "altReference": "ALTREF101",
- "sortCode": "101101",
- "accountName": "ACCT NAME 101",
- "accountNumber": "10100101",
- "status": "DELETED",
- "created": "2018-05-16T08:54:47.437",
- "lastUpdated": "2018-05-16T09:37:10.997",
- "restrictedDate": "2018-05-26T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3731165,
- "payerId": 3691994,
- "profileId": 4826,
- "reference": "DDREF123",
- "altReference": "ALTREF123",
- "sortCode": "454545",
- "accountName": "TEST ACC NAME",
- "accountNumber": "54545454",
- "status": "ACTIVE",
- "paymentPlanIds": [
- 1210031
], - "created": "2018-05-10T13:31:21.620",
- "lastUpdated": "2018-07-26T14:40:08.319",
- "restrictedDate": "2018-05-24T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3720671,
- "payerId": 3691994,
- "profileId": 4826,
- "reference": "NEW ADHOC REF",
- "altReference": "NEW ALT REF",
- "sortCode": "212121",
- "accountName": "NEW ACCT NAME",
- "accountNumber": "10101010",
- "status": "ACTIVE",
- "created": "2018-05-01T15:53:09.963",
- "lastUpdated": "2018-05-14T11:59:47.354",
- "restrictedDate": "2018-05-11T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3720667,
- "payerId": 3689140,
- "profileId": 4826,
- "reference": "TESTDDREF2",
- "altReference": "ALTDDREF2",
- "sortCode": "234567",
- "accountName": "TEST ACCOUNT NAME",
- "accountNumber": "23456789",
- "status": "ACTIVE",
- "created": "2018-05-01T09:18:01.103",
- "lastUpdated": "2018-05-01T09:18:01.137",
- "restrictedDate": "2018-05-11T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 3720665,
- "payerId": 3689140,
- "profileId": 4826,
- "reference": "TESTDDREF1",
- "altReference": "ALTDDREF1",
- "sortCode": "123456",
- "accountName": "CHANGE GONNA COME",
- "accountNumber": "12345678",
- "status": "CANCELLED",
- "created": "2018-05-01T09:03:16.687",
- "lastUpdated": "2018-05-16T09:37:45.117",
- "restrictedDate": "2018-05-11T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 25
}
}
]
}
]
}
]
}
Executes a query to search for mandates between two dates that are either cancelled or suspended.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Mandates",
- "symbol": "com.bottomline.ddm.model.mandate",
- "key": "com.bottomline.ddm.model.mandate"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "created",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate.created",
- "fieldType": "TIMESTAMP",
- "key": false
}, - "operator": {
- "symbol": "BETWEEN"
}, - "queryValues": [
- {
- "@type": "dateTime",
- "$value": "2019-07-01T00:00:00.000Z"
}, - {
- "@type": "dateTime",
- "$value": "2019-07-31T23:59:59.100Z"
}
]
}, - {
- "@type": "QueryRelationship",
- "name": "AND",
- "description": "AND relationship.",
- "symbol": "AND"
}, - {
- "@type": "QueryParameter",
- "field": {
- "name": "status",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate.status",
- "fieldType": "STRING",
- "key": false
}, - "operator": {
- "symbol": "IN"
}, - "queryValues": [
- {
- "@type": "string",
- "$value": "SUSPENDED"
}, - {
- "@type": "string",
- "$value": "CANCELLED"
}
]
}
]
}, - "resultFields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876124,
- "payerId": 4787303,
- "profileId": 4826,
- "reference": "000422",
- "sortCode": "500005",
- "accountName": "2ST API ACCOUNT",
- "accountNumber": "50000005",
- "status": "CANCELLED",
- "created": "2018-07-06T14:34:19.024",
- "lastUpdated": "2019-04-15T14:50:26.968",
- "restrictedDate": "2018-07-20T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876123,
- "payerId": 4787302,
- "profileId": 4826,
- "reference": "DDREF 404",
- "sortCode": "400004",
- "accountName": "1ST API ACCOUNT",
- "accountNumber": "40000004",
- "status": "SUSPENDED",
- "paymentPlanIds": [
- 1369911
], - "created": "2018-07-06T14:32:13.946",
- "lastUpdated": "2019-04-15T14:50:11.377",
- "restrictedDate": "2018-09-14T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 2
}
}
]
}
]
}
]
}
Executes a query to search for a mandate by DD reference.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Mandates",
- "symbol": "com.bottomline.ddm.model.mandate",
- "key": "com.bottomline.ddm.model.mandate"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "reference",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate.reference",
- "fieldType": "STRING",
- "key": false
}, - "operator": {
- "symbol": "CONTAINS"
}, - "queryValue": {
- "@type": "string",
- "$value": "DDREF 404"
}
}
]
}, - "resultFields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Mandate",
- "symbol": "com.bottomline.ddm.model.mandate.Mandate",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "MandateDTO",
- "id": 4876123,
- "payerId": 4787302,
- "profileId": 4826,
- "reference": "DDREF 404",
- "sortCode": "400004",
- "accountName": "1ST API ACCOUNT",
- "accountNumber": "40000004",
- "status": "SUSPENDED",
- "paymentPlanIds": [
- 1369911
], - "created": "2018-07-06T14:32:13.946",
- "lastUpdated": "2019-04-15T14:50:11.377",
- "restrictedDate": "2018-09-14T00:00:00.000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 1
}
}
]
}
]
}
]
}
Payment plans are used for Direct Debit collections.
A payment plan specifies details of when payments are to be taken from a debtor's bank account.The API allows you to create, delete, validate and update your payment plans. You can retrieve individual payment plans as well as a list of all your payment plans.
Returns a list of all payment plans.
contactId required | string ID of contact, obtained from the List all contacts call. |
mandateId required | string ID of mandate, obtained from the List all mandates call. |
curl -H "Content-Type: application/json" -X GET https://uk.pt-x.com/payments-service/api/ddm/contacts/52/mandates/104/payment-plans
[- {
- "PaymentPlan": {
- "WeeklyPaymentPlan": {
- "@type": "WeeklyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "@type": "MonthlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "@type": "MonthlyPickPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "@type": "YearlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
}
]
Creates a new payment plan.
contactId required | string ID of contact. |
mandateId required | string ID of mandate. |
The payment plan model.
Set to WeeklyPaymentPlan, MonthlyPaymentPlan, MonthlyPickPaymentPlan or YearlyPaymentPlan.
object (WeeklyPaymentPlan) | |
object (MonthlyPaymentPlan) | |
object (MonthlyPickPaymentPlan) | |
object (YearlyPaymentPlan) |
{- "WeeklyPaymentPlan": {
- "@type": "WeeklyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "@type": "MonthlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "@type": "MonthlyPickPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "@type": "YearlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
{- "WeeklyPaymentPlan": {
- "@type": "WeeklyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "@type": "MonthlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "@type": "MonthlyPickPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "@type": "YearlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
Retrieves details of a payment plan using unique identifier.
id required | integer <int64> ID of payment plan, obtained from the List all payment plans call. |
contactId required | string ID of contact, obtained from the List all contacts call. |
mandateId required | string ID of mandate, obtained from the List all mandates call. |
curl -H "Content-Type: application/json" -X GET https://uk.pt-x.com/payments-service/api/ddm/contacts/52/mandates/104/payment-plans/32
{- "WeeklyPaymentPlan": {
- "@type": "WeeklyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "@type": "MonthlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "@type": "MonthlyPickPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "@type": "YearlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
Updates an existing payment plan.
id required | string ID of payment plan, obtained from the List all payment plans call. |
contactId required | string ID of contact, obtained from the List all contacts call. |
mandateId required | string ID of mandate, obtained from the List all mandates call. |
The payment plan model.
Set to WeeklyPaymentPlan, MonthlyPaymentPlan, MonthlyPickPaymentPlan or YearlyPaymentPlan.
object (WeeklyPaymentPlan) | |
object (MonthlyPaymentPlan) | |
object (MonthlyPickPaymentPlan) | |
object (YearlyPaymentPlan) |
{- "WeeklyPaymentPlan": {
- "@type": "WeeklyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "@type": "MonthlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "@type": "MonthlyPickPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "@type": "YearlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
{- "WeeklyPaymentPlan": {
- "@type": "WeeklyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "@type": "MonthlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "@type": "MonthlyPickPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "@type": "YearlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
Deletes an existing payment plan.
id required | integer <int64> ID of payment plan, obtained from the List all payment plans call. |
contactId required | string ID of contact, obtained from the List all contacts call. |
mandateId required | string ID of mandate, obtained from the List all mandates call. |
curl -H "Content-Type: application/json" -X DELETE https://uk.pt-x.com/payments-service/api/ddm/contacts/52/mandates/104/payment-plans/32
Updates the status of payment plan.
paymentPlanId required | integer <int64> ID of payment plan, obtained from the List all payment plans call. |
status required | string New payment plan status. |
contactId required | string ID of contact, obtained from the List all contacts call. |
mandateId required | string ID of mandate, obtained from the List all mandates call. |
- Activate plan: curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/ddm/contacts/52/mandates/104/payment-plans/32/status/ACTIVE - Suspend plan: curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/ddm/contacts/52/mandates/104/payment-plans/32/status/SUSPENDED
{- "WeeklyPaymentPlan": {
- "@type": "WeeklyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "@type": "MonthlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "@type": "MonthlyPickPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "@type": "YearlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
Validates a payment plan.
contactId required | string ID of contact, obtained from the List all contacts call. |
mandateId required | string ID of mandate, obtained from the List all mandates call. |
The payment plan is validated and its details are updated if valid.
Set to WeeklyPaymentPlan, MonthlyPaymentPlan, MonthlyPickPaymentPlan or YearlyPaymentPlan.
object (PaymentPlan) |
{- "PaymentPlan": {
- "WeeklyPaymentPlan": {
- "@type": "WeeklyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "@type": "MonthlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "@type": "MonthlyPickPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "@type": "YearlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
}
{- "WeeklyPaymentPlan": {
- "@type": "WeeklyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 109,
- "mandateId": 64,
- "profileId": 3,
- "templateId": 17,
- "parentPlanId": 25,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthWeek": 0,
- "weekDays": [
- "MONDAY",
- "FRIDAY"
]
}, - "MonthlyPaymentPlan": {
- "@type": "MonthlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 104,
- "mandateId": 104,
- "profileId": 8,
- "templateId": 14,
- "parentPlanId": 26,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "monthDays": [
- "DAY1",
- "DAY15",
- "DAY30"
]
}, - "MonthlyPickPaymentPlan": {
- "@type": "MonthlyPickPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 106,
- "mandateId": 98,
- "profileId": 6,
- "templateId": 12,
- "parentPlanId": 23,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "everyNthMonth": 0,
- "sequence": "FIRST",
- "weekDaySequence": "WORKING_DAY"
}, - "YearlyPaymentPlan": {
- "@type": "YearlyPaymentPlan",
- "amountType": 0,
- "regularAmount": "12.00",
- "firstAmount": 0,
- "lastAmount": 0,
- "totalAmount": 0,
- "id": 101,
- "mandateId": 10,
- "profileId": 1,
- "templateId": 11,
- "parentPlanId": 24,
- "status": "ACTIVE",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "restrictedDate": "2019-08-24T14:15:22Z",
- "lastCollection": "2019-08-24T14:15:22Z",
- "extracted": 0,
- "created": "2019-08-24T14:15:22Z",
- "description": "string",
- "schedule": {
- "numberOfOccurences": 0,
- "schedulePattern": "string",
- "frequencyEnd": "string",
- "comments": "My template description",
- "startDate": "2019-08-24",
- "endDate": "2019-08-24"
}, - "forecastExtracted": 0,
- "lastForecastDate": "2019-08-24T14:15:22Z",
- "forecastAction": "NONE",
- "forecasts": [
- {
- "amount": 0,
- "id": 0,
- "mandateId": 0,
- "profileId": 0,
- "planId": 0,
- "collectionDate": "2019-08-24T14:15:22Z",
- "collectionNumber": 0,
- "transactionCode": "string"
}
], - "monthOfYear": [
- "JUNE",
- "JULY",
- "AUGUST"
], - "monthDays": [
- "DAY10",
- "DAY20"
]
}
}
The API allows you to query the collection history including by status, Direct Debit reference, mandate and between two dates.
Executes a query for collection history.
In the response returned, the possible values for the status of an instruction are:
The query to be executed.
required | object (QueryEntity) The entity in the query. |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Instructions",
- "symbol": "com.bottomline.ddm.model.instruction",
- "key": "com.bottomline.ddm.model.instruction"
}, - "resultFields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-12-12T16:52:21.713",
- "lastUpdated": "2018-12-12T16:52:21.713",
- "modelId": 4525180,
- "profileId": 5761,
- "mandateId": 6544652,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "111111",
- "accountNumber": "11111111",
- "accountName": "ACC NAME",
- "reference": "NO PLAN NEW LETTER",
- "paymentDate": "2018-12-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 21881564,
- "batchId": 129203,
- "submissionId": 129202,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-12-12T16:52:21.683",
- "lastUpdated": "2018-12-12T16:52:21.683",
- "modelId": 4525179,
- "profileId": 5761,
- "mandateId": 6544652,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "111111",
- "accountNumber": "11111111",
- "accountName": "ACC NAME",
- "reference": "NO PLAN NEW",
- "paymentDate": "2018-12-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 21881563,
- "batchId": 129203,
- "submissionId": 129202,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-12-04T09:23:13.183",
- "lastUpdated": "2018-12-04T09:23:13.183",
- "modelId": 4518909,
- "profileId": 5761,
- "mandateId": 6544652,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "111111",
- "accountNumber": "11111111",
- "accountName": "ACC NAME",
- "reference": "NO PLAN NEW",
- "paymentDate": "2018-12-06T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 21658358,
- "batchId": 129203,
- "submissionId": 129202,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-11-22T12:17:47.140",
- "lastUpdated": "2018-11-22T12:17:47.140",
- "modelId": 4518244,
- "profileId": 4826,
- "mandateId": 6539570,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "111111",
- "accountNumber": "11111111",
- "accountName": "TEST NAME",
- "reference": "NEW LETTER TEST",
- "paymentDate": "2018-11-26T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 21103199,
- "batchId": 126338,
- "submissionId": 126337,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-11-13T13:55:30.220",
- "lastUpdated": "2018-11-13T13:55:30.220",
- "modelId": 4517624,
- "profileId": 4826,
- "mandateId": 5004606,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "202020",
- "accountNumber": "20202020",
- "accountName": "JOHN SMITH",
- "reference": "20202020",
- "paymentDate": "2018-11-15T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 21020727,
- "batchId": 126338,
- "submissionId": 126337,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-10-25T15:49:25.033",
- "lastUpdated": "2018-10-25T15:49:25.033",
- "modelId": 4515656,
- "profileId": 4826,
- "mandateId": 3720667,
- "status": "PENDING",
- "paymentType": "ONE_OFF",
- "sortCode": "234567",
- "accountNumber": "23456789",
- "accountName": "TEST ACCOUNT NAME",
- "reference": "TESTDDREF2",
- "altReference": "ALTDDREF2",
- "paymentDate": "2018-11-08T00:00:00.000",
- "amount": 25,
- "transactionCode": "18",
- "applicationId": 6421,
- "instructionId": 20914737,
- "batchId": 126544,
- "submissionId": 126543,
- "retryCount": 0,
- "serviceUserNumber": "100265",
- "comments": "Test trans code import"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-10-23T09:36:26.462",
- "lastUpdated": "2018-10-23T09:36:26.462",
- "modelId": 4515342,
- "profileId": 4826,
- "mandateId": 5164746,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "555555",
- "accountNumber": "44444444",
- "accountName": "NEW ACC NAME",
- "reference": "NEW REF ADHOC API",
- "altReference": "NEW ALT REF",
- "paymentDate": "2018-10-25T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20907519,
- "batchId": 126338,
- "submissionId": 126337,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-10-19T09:41:11.169",
- "lastUpdated": "2018-10-19T09:41:37.326",
- "modelId": 4515288,
- "profileId": 4826,
- "mandateId": 4876126,
- "status": "DELETED",
- "paymentType": "ONE_OFF",
- "sortCode": "700007",
- "accountNumber": "70000007",
- "accountName": "4TH API ACCOUNT",
- "reference": "000424",
- "paymentDate": "2018-11-02T00:00:00.000",
- "amount": 1.23,
- "transactionCode": "01",
- "applicationId": 6421,
- "instructionId": 20902537,
- "batchId": 126185,
- "submissionId": 126184,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-10-04T09:58:01.731",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4498689,
- "profileId": 4826,
- "mandateId": 5275599,
- "status": "DELETED",
- "paymentType": "ONE_OFF",
- "sortCode": "805508",
- "accountNumber": "80055008",
- "accountName": "EXAMPLE ACC NAME",
- "reference": "010203ABC",
- "altReference": "NEW EMAIL TEST",
- "paymentDate": "2018-10-18T00:00:00.000",
- "amount": 1.23,
- "transactionCode": "01",
- "applicationId": 6421,
- "instructionId": 20729085,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265",
- "comments": "Test email no attach"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-10-02T14:48:49.834",
- "lastUpdated": "2018-10-04T10:03:11.172",
- "modelId": 4498679,
- "profileId": 5900,
- "mandateId": 5641447,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "111111",
- "accountNumber": "12345671",
- "accountName": "T TEST",
- "reference": "05641447",
- "altReference": "TEST001",
- "paymentDate": "2018-10-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 7928,
- "instructionId": 20720183,
- "batchId": 124295,
- "submissionId": 124294,
- "retryCount": 0,
- "serviceUserNumber": "666666"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-10-02T14:44:06.938",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4498678,
- "profileId": 4826,
- "mandateId": 3720671,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "111111",
- "accountNumber": "12345671",
- "accountName": "T TEST",
- "reference": "TEST001",
- "altReference": "TEST001 ADDACS REPORTS",
- "paymentDate": "2018-10-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 20720182,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-10-02T14:43:58.108",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4498677,
- "profileId": 4826,
- "mandateId": 3720671,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "111111",
- "accountNumber": "12345671",
- "accountName": "T TEST",
- "reference": "TEST001",
- "altReference": "TEST001 ADDACS REPORTS",
- "paymentDate": "2018-10-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 20720181,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-10-02T14:39:53.019",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4498676,
- "profileId": 4826,
- "mandateId": 3720671,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "111111",
- "accountNumber": "12345671",
- "accountName": "T TEST",
- "reference": "TEST001",
- "altReference": "TEST001 ADDACS REPORTS",
- "paymentDate": "2018-10-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20718960,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-10-02T14:39:52.978",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4498675,
- "profileId": 4826,
- "mandateId": 3720671,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "212121",
- "accountNumber": "10101010",
- "accountName": "NEW ACCT NAME",
- "reference": "NEW ADHOC REF",
- "altReference": "NEW ALT REF",
- "paymentDate": "2018-10-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 20718959,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-09-20T10:53:08.548",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4486163,
- "profileId": 4826,
- "mandateId": 5275599,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "805508",
- "accountNumber": "80055008",
- "accountName": "EXAMPLE ACC NAME",
- "reference": "010203ABC",
- "paymentDate": "2018-09-24T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20604446,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-09-05T14:52:13.325",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4438908,
- "profileId": 4826,
- "mandateId": 5168729,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "888888",
- "accountNumber": "77777777",
- "accountName": "NEW REF W PLAN",
- "reference": "NEW REF W PLAN",
- "paymentDate": "2018-09-07T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 20533632,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-09-05T14:51:24.841",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4438907,
- "profileId": 4826,
- "mandateId": 5168729,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "888888",
- "accountNumber": "77777777",
- "accountName": "NEW REF W PLAN",
- "reference": "NEW REF W PLAN",
- "paymentDate": "2018-09-07T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20533631,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-09-03T09:21:04.747",
- "lastUpdated": "2018-09-06T13:14:22.319",
- "modelId": 4434588,
- "profileId": 4826,
- "mandateId": 5004606,
- "status": "SUCCESS",
- "paymentType": "ONE_OFF",
- "sortCode": "202020",
- "accountNumber": "20202020",
- "accountName": "JOHN SMITH",
- "reference": "20202020",
- "paymentDate": "2018-09-17T00:00:00.000",
- "amount": 7.65,
- "transactionCode": "17",
- "applicationId": 6421,
- "instructionId": 20516808,
- "batchId": 118895,
- "submissionId": 118894,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-31T09:38:37.445",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4407171,
- "profileId": 4826,
- "mandateId": 4876123,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "400004",
- "accountNumber": "40000004",
- "accountName": "1ST API ACCOUNT",
- "reference": "DDREF 404",
- "paymentDate": "2018-09-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20481457,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-31T09:38:37.433",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4407170,
- "profileId": 4826,
- "mandateId": 4876123,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "400004",
- "accountNumber": "40000004",
- "accountName": "1ST API ACCOUNT",
- "reference": "000421",
- "paymentDate": "2018-09-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 20481456,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-31T09:37:20.127",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4407169,
- "profileId": 4826,
- "mandateId": 3747035,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "654321",
- "accountNumber": "87654321",
- "accountName": "ACCT HOLDER NAME",
- "reference": "AUTO DD REF",
- "altReference": "AUTO DD ALT REF",
- "paymentDate": "2018-09-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20481455,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-31T09:37:20.116",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4407168,
- "profileId": 4826,
- "mandateId": 3747035,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "654321",
- "accountNumber": "87654321",
- "accountName": "ACCT HOLDER NAME",
- "reference": "1526460741354",
- "altReference": "AUTO DD REF",
- "paymentDate": "2018-09-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 20481454,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-31T09:35:12.209",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4407167,
- "profileId": 4826,
- "mandateId": 5011395,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "1ST API ACCOUNT",
- "reference": "987650",
- "paymentDate": "2018-09-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 20481453,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-31T09:34:53.239",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4407166,
- "profileId": 4826,
- "mandateId": 5011394,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "402204",
- "accountNumber": "44022044",
- "accountName": "2ND API ACCOUNT",
- "reference": "987653",
- "paymentDate": "2018-09-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 20481452,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-31T09:34:21.659",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4407165,
- "profileId": 4826,
- "mandateId": 5011396,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "3RD API ACCOUNT",
- "reference": "917650",
- "paymentDate": "2018-09-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 20481451,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-31T09:32:59.168",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4407164,
- "profileId": 4826,
- "mandateId": 5011398,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "402204",
- "accountNumber": "44022044",
- "accountName": "4TH API ACCOUNT",
- "reference": "937650",
- "altReference": "ALTREFHERE",
- "paymentDate": "2018-09-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 20481450,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-31T09:32:20.739",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4407163,
- "profileId": 4826,
- "mandateId": 5011393,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "1ST API ACCOUNT",
- "reference": "987654",
- "paymentDate": "2018-09-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 20481449,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-31T09:32:02.156",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4407162,
- "profileId": 4826,
- "mandateId": 5010059,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "402204",
- "accountNumber": "44022044",
- "accountName": "2ND API ACCOUNT",
- "reference": "010204",
- "paymentDate": "2018-09-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 20481448,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-31T09:30:26.178",
- "lastUpdated": "2018-10-04T10:04:23.682",
- "modelId": 4407161,
- "profileId": 4826,
- "mandateId": 5011397,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "3RD API ACCOUNT",
- "reference": "927650",
- "paymentDate": "2018-09-04T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 20481447,
- "batchId": 118301,
- "submissionId": 118300,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-30T08:11:08.743",
- "lastUpdated": "2018-08-31T09:23:51.087",
- "modelId": 4402841,
- "profileId": 4826,
- "mandateId": 5011398,
- "status": "DELETED",
- "paymentType": "ONE_OFF",
- "sortCode": "402204",
- "accountNumber": "44022044",
- "accountName": "4TH API ACCOUNT",
- "reference": "937650",
- "altReference": "ALTREFHERE",
- "paymentDate": "2018-09-13T00:00:00.000",
- "amount": 2.34,
- "transactionCode": "17",
- "applicationId": 6421,
- "instructionId": 20476708,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265",
- "comments": "ALTREFCOMMENTS"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-17T13:21:24.320",
- "lastUpdated": "2018-08-31T09:23:51.087",
- "modelId": 4239289,
- "profileId": 4826,
- "mandateId": 3747035,
- "status": "DELETED",
- "paymentType": "REFUND",
- "sortCode": "654321",
- "accountNumber": "87654321",
- "accountName": "ACCT HOLDER NAME",
- "reference": "1526460741354",
- "altReference": "AUTO DD REF",
- "paymentDate": "2018-08-31T00:00:00.000",
- "amount": 11,
- "transactionCode": "99",
- "applicationId": 6421,
- "instructionId": 20256049,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265",
- "comments": "REFUND COMMENTS"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T18:49:28.068",
- "lastUpdated": "2018-08-31T09:29:41.758",
- "modelId": 4199443,
- "profileId": 5761,
- "mandateId": 5046890,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "55555555",
- "accountName": "ACC NAME",
- "reference": "DDREF1234",
- "altReference": "ALTREF1234",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 8308,
- "instructionId": 20135319,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T18:48:53.453",
- "lastUpdated": "2018-08-31T09:29:41.758",
- "modelId": 4199442,
- "profileId": 5761,
- "mandateId": 5046891,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "55555555",
- "accountName": "ONGOING ACC NAME",
- "reference": "DDREF2347",
- "altReference": "ALTERF2345",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 8308,
- "instructionId": 20135318,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T15:38:02.466",
- "lastUpdated": "2018-08-31T09:29:41.758",
- "modelId": 4199433,
- "profileId": 5761,
- "mandateId": 5046890,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "55555555",
- "accountName": "ACC NAME",
- "reference": "DDREF1234",
- "altReference": "ALTREF1234",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 8308,
- "instructionId": 20135307,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T15:38:02.411",
- "lastUpdated": "2018-08-31T09:29:41.758",
- "modelId": 4199432,
- "profileId": 5761,
- "mandateId": 5046890,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "33333333",
- "accountName": "ACC NAME",
- "reference": "DDREF1234",
- "altReference": "ALTREF1234",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 8308,
- "instructionId": 20135306,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T15:34:08.630",
- "lastUpdated": "2018-08-31T09:29:41.758",
- "modelId": 4199431,
- "profileId": 5761,
- "mandateId": 5046891,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "55555555",
- "accountName": "ONGOING ACC NAME",
- "reference": "DDREF2347",
- "altReference": "ALTERF2345",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 8308,
- "instructionId": 20135305,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T15:34:08.620",
- "lastUpdated": "2018-08-31T09:29:41.758",
- "modelId": 4199430,
- "profileId": 5761,
- "mandateId": 5046891,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "55555555",
- "accountName": "ANOTHER ACC NAME",
- "reference": "DDREF2345",
- "altReference": "ALTERF2345",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 8308,
- "instructionId": 20135304,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T15:32:54.147",
- "lastUpdated": "2018-08-31T09:29:41.758",
- "modelId": 4199429,
- "profileId": 5761,
- "mandateId": 5046891,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "55555555",
- "accountName": "ANOTHER ACC NAME",
- "reference": "DDREF2345",
- "altReference": "ALTERF2345",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 8308,
- "instructionId": 20135303,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T15:22:17.259",
- "lastUpdated": "2018-08-31T09:29:41.758",
- "modelId": 4199427,
- "profileId": 5761,
- "mandateId": 5046890,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "33333333",
- "accountName": "ACC NAME",
- "reference": "DDREF1234",
- "altReference": "ALTREF1234",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 8308,
- "instructionId": 20135292,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-09T16:45:17.842",
- "lastUpdated": "2018-08-31T09:23:51.087",
- "modelId": 4194422,
- "profileId": 4826,
- "mandateId": 5011398,
- "status": "DELETED",
- "paymentType": "ONE_OFF",
- "sortCode": "402204",
- "accountNumber": "44022044",
- "accountName": "4TH API ACCOUNT",
- "reference": "937650",
- "paymentDate": "2018-08-23T00:00:00.000",
- "amount": 1.23,
- "transactionCode": "01",
- "applicationId": 6421,
- "instructionId": 20129741,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-03T08:54:43.873",
- "lastUpdated": "2018-08-31T09:26:35.664",
- "modelId": 4151834,
- "profileId": 4826,
- "mandateId": 5004606,
- "status": "DELETED",
- "paymentType": "ONE_OFF",
- "sortCode": "202020",
- "accountNumber": "20202020",
- "accountName": "JOHN SMITH",
- "reference": "20202020",
- "paymentDate": "2018-08-17T00:00:00.000",
- "amount": 1234.56,
- "transactionCode": "17",
- "applicationId": 6421,
- "instructionId": 20068908,
- "batchId": 113205,
- "submissionId": 113204,
- "retryCount": 0,
- "serviceUserNumber": "100265",
- "comments": "Home Office Direct Debit"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T15:55:40.656",
- "lastUpdated": "2018-08-31T09:23:51.087",
- "modelId": 4148254,
- "profileId": 4826,
- "mandateId": 5011398,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "402204",
- "accountNumber": "44022044",
- "accountName": "4TH API ACCOUNT",
- "reference": "937650",
- "paymentDate": "2018-08-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20064161,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T15:55:40.602",
- "lastUpdated": "2018-08-31T09:23:51.087",
- "modelId": 4148253,
- "profileId": 4826,
- "mandateId": 5011397,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "3RD API ACCOUNT",
- "reference": "927650",
- "paymentDate": "2018-08-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20064160,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T15:55:22.938",
- "lastUpdated": "2018-08-31T09:23:51.087",
- "modelId": 4148252,
- "profileId": 4826,
- "mandateId": 5011396,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "3RD API ACCOUNT",
- "reference": "917650",
- "paymentDate": "2018-08-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20064159,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T15:54:14.814",
- "lastUpdated": "2018-08-31T09:23:51.087",
- "modelId": 4148251,
- "profileId": 4826,
- "mandateId": 5011395,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "1ST API ACCOUNT",
- "reference": "987650",
- "paymentDate": "2018-08-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20064155,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T15:52:03.748",
- "lastUpdated": "2018-08-31T09:23:51.087",
- "modelId": 4148250,
- "profileId": 4826,
- "mandateId": 5011394,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "402204",
- "accountNumber": "44022044",
- "accountName": "2ND API ACCOUNT",
- "reference": "987653",
- "paymentDate": "2018-08-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20064154,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T15:52:03.684",
- "lastUpdated": "2018-08-31T09:23:51.087",
- "modelId": 4148249,
- "profileId": 4826,
- "mandateId": 5011393,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "1ST API ACCOUNT",
- "reference": "987654",
- "paymentDate": "2018-08-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20064153,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T15:46:05.498",
- "lastUpdated": "2018-08-31T09:23:51.087",
- "modelId": 4148244,
- "profileId": 4826,
- "mandateId": 5010059,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "402204",
- "accountNumber": "44022044",
- "accountName": "2ND API ACCOUNT",
- "reference": "010204",
- "paymentDate": "2018-08-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20064145,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T14:40:05.583",
- "lastUpdated": "2018-08-31T09:28:22.258",
- "modelId": 4148232,
- "profileId": 4826,
- "mandateId": 3720671,
- "status": "DELETED",
- "paymentType": "ONE_OFF",
- "sortCode": "212121",
- "accountNumber": "10101010",
- "accountName": "NEW ACCT NAME",
- "reference": "NEW ADHOC REF",
- "altReference": "NEW ALT REF",
- "paymentDate": "2018-08-16T00:00:00.000",
- "amount": 25,
- "transactionCode": "17",
- "applicationId": 6421,
- "instructionId": 20064108,
- "batchId": 84601,
- "submissionId": 84600,
- "retryCount": 0,
- "serviceUserNumber": "100265",
- "comments": "Test comments"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-26T14:56:44.607",
- "lastUpdated": "2018-08-31T09:23:51.087",
- "modelId": 4104856,
- "profileId": 4826,
- "mandateId": 5004606,
- "status": "DELETED",
- "paymentType": "ONE_OFF",
- "sortCode": "202020",
- "accountNumber": "20202020",
- "accountName": "JOHN SMITH",
- "reference": "20202020",
- "paymentDate": "2018-08-09T00:00:00.000",
- "amount": 234,
- "transactionCode": "17",
- "applicationId": 6421,
- "instructionId": 20015613,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265",
- "comments": "TEST TEST TEST"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 119
}
}
]
}
]
}
]
}
Executes a query for collection history between two dates.
In the response returned, the possible values for the status of an instruction are:
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Instructions",
- "symbol": "com.bottomline.ddm.model.instruction",
- "key": "com.bottomline.ddm.model.instruction"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "paymentDate",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction.paymentDate",
- "fieldType": "DATE",
- "key": false
}, - "operator": {
- "symbol": "BETWEEN"
}, - "queryValues": [
- {
- "@type": "date",
- "$value": "2022-10-31T00:00:00.000Z"
}, - {
- "@type": "date",
- "$value": "2022-11-20T23:59:59.100Z"
}
]
}
]
}, - "resultFields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2022-11-13T13:55:30.220",
- "lastUpdated": "2022-11-13T13:55:30.220",
- "modelId": 4517624,
- "profileId": 4826,
- "mandateId": 5004606,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "202020",
- "accountNumber": "20202020",
- "accountName": "JOHN SMITH",
- "reference": "20202020",
- "paymentDate": "2022-11-15T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 21020727,
- "batchId": 126338,
- "submissionId": 126337,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2022-10-25T15:49:25.033",
- "lastUpdated": "2022-10-25T15:49:25.033",
- "modelId": 4515656,
- "profileId": 4826,
- "mandateId": 3720667,
- "status": "PENDING",
- "paymentType": "ONE_OFF",
- "sortCode": "234567",
- "accountNumber": "23456789",
- "accountName": "TEST ACCOUNT NAME",
- "reference": "TESTDDREF2",
- "altReference": "ALTDDREF2",
- "paymentDate": "2022-11-08T00:00:00.000",
- "amount": 25,
- "transactionCode": "18",
- "applicationId": 6421,
- "instructionId": 20914737,
- "batchId": 126544,
- "submissionId": 126543,
- "retryCount": 0,
- "serviceUserNumber": "100265",
- "comments": "Test trans code import"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2022-10-19T09:41:11.169",
- "lastUpdated": "2022-10-19T09:41:37.326",
- "modelId": 4515288,
- "profileId": 4826,
- "mandateId": 4876126,
- "status": "DELETED",
- "paymentType": "ONE_OFF",
- "sortCode": "700007",
- "accountNumber": "70000007",
- "accountName": "4TH API ACCOUNT",
- "reference": "000424",
- "paymentDate": "2022-11-02T00:00:00.000",
- "amount": 1.23,
- "transactionCode": "01",
- "applicationId": 6421,
- "instructionId": 20902537,
- "batchId": 126185,
- "submissionId": 126184,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 3
}
}
]
}
]
}
]
}
Executes a query for collection history by status.
In the response returned, the possible values for the status of an instruction are:
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Instructions",
- "symbol": "com.bottomline.ddm.model.instruction",
- "key": "com.bottomline.ddm.model.instruction"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "status",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction.status",
- "fieldType": "STRING",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "string",
- "$value": "PENDING"
}
}
]
}, - "resultFields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T18:49:28.068",
- "lastUpdated": "2018-08-10T18:49:28.069",
- "modelId": 4199443,
- "profileId": 5761,
- "mandateId": 5046890,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "55555555",
- "accountName": "ACC NAME",
- "reference": "DDREF1234",
- "altReference": "ALTREF1234",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 8308,
- "instructionId": 20135319,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T18:48:53.453",
- "lastUpdated": "2018-08-10T18:48:53.453",
- "modelId": 4199442,
- "profileId": 5761,
- "mandateId": 5046891,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "55555555",
- "accountName": "ONGOING ACC NAME",
- "reference": "DDREF2347",
- "altReference": "ALTERF2345",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 8308,
- "instructionId": 20135318,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T15:38:02.466",
- "lastUpdated": "2018-08-10T15:38:02.466",
- "modelId": 4199433,
- "profileId": 5761,
- "mandateId": 5046890,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "55555555",
- "accountName": "ACC NAME",
- "reference": "DDREF1234",
- "altReference": "ALTREF1234",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 8308,
- "instructionId": 20135307,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T15:38:02.411",
- "lastUpdated": "2018-08-10T15:38:02.411",
- "modelId": 4199432,
- "profileId": 5761,
- "mandateId": 5046890,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "33333333",
- "accountName": "ACC NAME",
- "reference": "DDREF1234",
- "altReference": "ALTREF1234",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 8308,
- "instructionId": 20135306,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T15:34:08.630",
- "lastUpdated": "2018-08-10T15:34:08.630",
- "modelId": 4199431,
- "profileId": 5761,
- "mandateId": 5046891,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "55555555",
- "accountName": "ONGOING ACC NAME",
- "reference": "DDREF2347",
- "altReference": "ALTERF2345",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 8308,
- "instructionId": 20135305,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T15:34:08.620",
- "lastUpdated": "2018-08-10T15:34:08.620",
- "modelId": 4199430,
- "profileId": 5761,
- "mandateId": 5046891,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "55555555",
- "accountName": "ANOTHER ACC NAME",
- "reference": "DDREF2345",
- "altReference": "ALTERF2345",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 8308,
- "instructionId": 20135304,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T15:32:54.147",
- "lastUpdated": "2018-08-10T15:32:54.147",
- "modelId": 4199429,
- "profileId": 5761,
- "mandateId": 5046891,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "55555555",
- "accountName": "ANOTHER ACC NAME",
- "reference": "DDREF2345",
- "altReference": "ALTERF2345",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 8308,
- "instructionId": 20135303,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-10T15:22:17.259",
- "lastUpdated": "2018-08-10T15:22:17.259",
- "modelId": 4199427,
- "profileId": 5761,
- "mandateId": 5046890,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "200000",
- "accountNumber": "33333333",
- "accountName": "ACC NAME",
- "reference": "DDREF1234",
- "altReference": "ALTREF1234",
- "paymentDate": "2018-08-14T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 8308,
- "instructionId": 20135292,
- "batchId": 116278,
- "submissionId": 116277,
- "retryCount": 0,
- "serviceUserNumber": "414802"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-09T16:45:17.842",
- "lastUpdated": "2018-08-09T16:45:17.842",
- "modelId": 4194422,
- "profileId": 4826,
- "mandateId": 5011398,
- "status": "PENDING",
- "paymentType": "ONE_OFF",
- "sortCode": "402204",
- "accountNumber": "44022044",
- "accountName": "4TH API ACCOUNT",
- "reference": "937650",
- "paymentDate": "2018-08-23T00:00:00.000",
- "amount": 1.23,
- "transactionCode": "01",
- "applicationId": 6421,
- "instructionId": 20129741,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-03T08:54:43.873",
- "lastUpdated": "2018-08-03T08:54:43.873",
- "modelId": 4151834,
- "profileId": 4826,
- "mandateId": 5004606,
- "status": "PENDING",
- "paymentType": "ONE_OFF",
- "sortCode": "202020",
- "accountNumber": "20202020",
- "accountName": "JOHN SMITH",
- "reference": "20202020",
- "paymentDate": "2018-08-17T00:00:00.000",
- "amount": 1234.56,
- "transactionCode": "17",
- "applicationId": 6421,
- "instructionId": 20068908,
- "batchId": 113205,
- "submissionId": 113204,
- "retryCount": 0,
- "serviceUserNumber": "100265",
- "comments": "Home Office Direct Debit"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T15:55:40.656",
- "lastUpdated": "2018-08-02T15:55:40.656",
- "modelId": 4148254,
- "profileId": 4826,
- "mandateId": 5011398,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "402204",
- "accountNumber": "44022044",
- "accountName": "4TH API ACCOUNT",
- "reference": "937650",
- "paymentDate": "2018-08-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20064161,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T15:55:40.602",
- "lastUpdated": "2018-08-02T15:55:40.602",
- "modelId": 4148253,
- "profileId": 4826,
- "mandateId": 5011397,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "3RD API ACCOUNT",
- "reference": "927650",
- "paymentDate": "2018-08-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20064160,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T15:55:22.938",
- "lastUpdated": "2018-08-02T15:55:22.938",
- "modelId": 4148252,
- "profileId": 4826,
- "mandateId": 5011396,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "3RD API ACCOUNT",
- "reference": "917650",
- "paymentDate": "2018-08-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20064159,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T15:54:14.814",
- "lastUpdated": "2018-08-02T15:54:14.814",
- "modelId": 4148251,
- "profileId": 4826,
- "mandateId": 5011395,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "1ST API ACCOUNT",
- "reference": "987650",
- "paymentDate": "2018-08-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20064155,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T15:52:03.748",
- "lastUpdated": "2018-08-02T15:52:03.748",
- "modelId": 4148250,
- "profileId": 4826,
- "mandateId": 5011394,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "402204",
- "accountNumber": "44022044",
- "accountName": "2ND API ACCOUNT",
- "reference": "987653",
- "paymentDate": "2018-08-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20064154,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T15:52:03.684",
- "lastUpdated": "2018-08-02T15:52:03.684",
- "modelId": 4148249,
- "profileId": 4826,
- "mandateId": 5011393,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "1ST API ACCOUNT",
- "reference": "987654",
- "paymentDate": "2018-08-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20064153,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T15:46:05.498",
- "lastUpdated": "2018-08-02T15:46:05.498",
- "modelId": 4148244,
- "profileId": 4826,
- "mandateId": 5010059,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "402204",
- "accountNumber": "44022044",
- "accountName": "2ND API ACCOUNT",
- "reference": "010204",
- "paymentDate": "2018-08-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20064145,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-08-02T14:40:05.583",
- "lastUpdated": "2018-08-02T14:40:05.583",
- "modelId": 4148232,
- "profileId": 4826,
- "mandateId": 3720671,
- "status": "PENDING",
- "paymentType": "ONE_OFF",
- "sortCode": "212121",
- "accountNumber": "10101010",
- "accountName": "NEW ACCT NAME",
- "reference": "NEW ADHOC REF",
- "altReference": "NEW ALT REF",
- "paymentDate": "2018-08-16T00:00:00.000",
- "amount": 25,
- "transactionCode": "17",
- "applicationId": 6421,
- "instructionId": 20064108,
- "batchId": 84601,
- "submissionId": 84600,
- "retryCount": 0,
- "serviceUserNumber": "100265",
- "comments": "Test comments"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-26T14:56:44.607",
- "lastUpdated": "2018-07-26T14:56:44.607",
- "modelId": 4104856,
- "profileId": 4826,
- "mandateId": 5004606,
- "status": "PENDING",
- "paymentType": "ONE_OFF",
- "sortCode": "202020",
- "accountNumber": "20202020",
- "accountName": "JOHN SMITH",
- "reference": "20202020",
- "paymentDate": "2018-08-09T00:00:00.000",
- "amount": 234,
- "transactionCode": "17",
- "applicationId": 6421,
- "instructionId": 20015613,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265",
- "comments": "TEST TEST TEST"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-26T14:54:38.495",
- "lastUpdated": "2018-07-26T14:54:38.495",
- "modelId": 4104854,
- "profileId": 4826,
- "mandateId": 5004606,
- "status": "PENDING",
- "paymentType": "ONE_OFF",
- "sortCode": "202020",
- "accountNumber": "20202020",
- "accountName": "JOHN SMITH",
- "reference": "20202020",
- "paymentDate": "2018-08-09T00:00:00.000",
- "amount": 120,
- "transactionCode": "17",
- "applicationId": 6421,
- "instructionId": 20015611,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265",
- "comments": "One-OFF TEST"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-26T14:53:46.742",
- "lastUpdated": "2018-07-26T14:53:46.742",
- "modelId": 4104853,
- "profileId": 4826,
- "mandateId": 5004606,
- "status": "PENDING",
- "paymentType": "ONE_OFF",
- "sortCode": "202020",
- "accountNumber": "20202020",
- "accountName": "JOHN SMITH",
- "reference": "20202020",
- "paymentDate": "2018-08-09T00:00:00.000",
- "amount": 12.34,
- "transactionCode": "01",
- "applicationId": 6421,
- "instructionId": 20015607,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265",
- "comments": "One Off TEST Comments"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-26T14:46:04.149",
- "lastUpdated": "2018-07-26T14:46:04.149",
- "modelId": 4104846,
- "profileId": 4826,
- "mandateId": 5004606,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "202020",
- "accountNumber": "20202020",
- "accountName": "JOHN SMITH",
- "reference": "20202020",
- "paymentDate": "2018-07-27T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 20015592,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-26T14:40:08.285",
- "lastUpdated": "2018-07-26T14:40:08.285",
- "modelId": 4104839,
- "profileId": 4826,
- "mandateId": 3731165,
- "status": "PENDING",
- "paymentType": "ONE_OFF",
- "sortCode": "454545",
- "accountNumber": "54545454",
- "accountName": "TEST ACC NAME",
- "reference": "DDREF123",
- "altReference": "ALTREF123",
- "paymentDate": "2018-08-15T00:00:00.000",
- "amount": 45.5,
- "transactionCode": "01",
- "applicationId": 6421,
- "instructionId": 20015585,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265",
- "comments": "Additional one-off collection as agreed with client.*TEST*"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T14:37:47.331",
- "lastUpdated": "2018-07-06T14:37:47.331",
- "modelId": 3943626,
- "profileId": 4826,
- "mandateId": 4876126,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "700007",
- "accountNumber": "70000007",
- "accountName": "4TH API ACCOUNT",
- "reference": "000424",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19832934,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T14:37:47.258",
- "lastUpdated": "2018-07-06T14:37:47.258",
- "modelId": 3943625,
- "profileId": 4826,
- "mandateId": 4876125,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "600006",
- "accountNumber": "60000006",
- "accountName": "3RD API ACCOUNT",
- "reference": "000423",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19832933,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T14:34:19.060",
- "lastUpdated": "2018-07-06T14:34:19.060",
- "modelId": 3943624,
- "profileId": 4826,
- "mandateId": 4876124,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "500005",
- "accountNumber": "50000005",
- "accountName": "2ST API ACCOUNT",
- "reference": "000422",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19832932,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T14:32:13.979",
- "lastUpdated": "2018-07-06T14:32:13.979",
- "modelId": 3943623,
- "profileId": 4826,
- "mandateId": 4876123,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "400004",
- "accountNumber": "40000004",
- "accountName": "1ST API ACCOUNT",
- "reference": "000421",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19832928,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T14:17:56.643",
- "lastUpdated": "2018-07-06T14:17:56.643",
- "modelId": 3943622,
- "profileId": 4826,
- "mandateId": 4876122,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "404040",
- "accountNumber": "16161616",
- "accountName": "ADHOC MULTI-CONTAC",
- "reference": "0012351",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 19832921,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T14:17:42.819",
- "lastUpdated": "2018-07-06T14:17:42.819",
- "modelId": 3943621,
- "profileId": 4826,
- "mandateId": 4876121,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "404040",
- "accountNumber": "15151515",
- "accountName": "REGULAR MULTI-CONT",
- "reference": "0012350",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 19832920,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T14:17:25.491",
- "lastUpdated": "2018-07-06T14:17:25.491",
- "modelId": 3943620,
- "profileId": 4826,
- "mandateId": 4876108,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "404040",
- "accountNumber": "16161616",
- "accountName": "ADHOC MULTI-CONTAC",
- "reference": "0012340",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 19832919,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T14:17:03.665",
- "lastUpdated": "2018-07-06T14:17:03.665",
- "modelId": 3943619,
- "profileId": 4826,
- "mandateId": 4876107,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "404040",
- "accountNumber": "15151515",
- "accountName": "REGULAR MULTI-CONT",
- "reference": "0012349",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 19832918,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T14:12:19.097",
- "lastUpdated": "2018-07-06T14:12:19.097",
- "modelId": 3943618,
- "profileId": 4826,
- "mandateId": 4876122,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "404040",
- "accountNumber": "16161616",
- "accountName": "ADHOC MULTI-CONTAC",
- "reference": "0012351",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19832917,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T14:12:19.050",
- "lastUpdated": "2018-07-06T14:12:19.050",
- "modelId": 3943617,
- "profileId": 4826,
- "mandateId": 4876121,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "404040",
- "accountNumber": "15151515",
- "accountName": "REGULAR MULTI-CONT",
- "reference": "0012350",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19832916,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T10:59:32.751",
- "lastUpdated": "2018-07-06T10:59:32.751",
- "modelId": 3943607,
- "profileId": 4826,
- "mandateId": 4876108,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "404040",
- "accountNumber": "16161616",
- "accountName": "ADHOC MULTI-CONTAC",
- "reference": "0012340",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19832216,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T10:59:32.703",
- "lastUpdated": "2018-07-06T10:59:32.703",
- "modelId": 3943606,
- "profileId": 4826,
- "mandateId": 4876107,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "404040",
- "accountNumber": "15151515",
- "accountName": "REGULAR MULTI-CONT",
- "reference": "0012349",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19832215,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T10:51:30.691",
- "lastUpdated": "2018-07-06T10:51:30.691",
- "modelId": 3943605,
- "profileId": 4826,
- "mandateId": 4876105,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "404040",
- "accountNumber": "15151515",
- "accountName": "REGULAR MULTI-CONT",
- "reference": "0012347",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 19832211,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T10:51:22.591",
- "lastUpdated": "2018-07-06T10:51:22.591",
- "modelId": 3943604,
- "profileId": 4826,
- "mandateId": 4876104,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "404040",
- "accountNumber": "15151515",
- "accountName": "MULTI-CONTACT API",
- "reference": "0012345",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 19832210,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T10:51:13.606",
- "lastUpdated": "2018-07-06T10:51:13.606",
- "modelId": 3943603,
- "profileId": 4826,
- "mandateId": 4863790,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "GREEN ACCOUNT",
- "reference": "0123456",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 19832209,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T10:50:50.739",
- "lastUpdated": "2018-07-06T10:50:50.739",
- "modelId": 3943602,
- "profileId": 4826,
- "mandateId": 4863790,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "GREEN ACCOUNT",
- "reference": "0123456",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19832208,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T10:50:20.111",
- "lastUpdated": "2018-07-06T10:50:20.111",
- "modelId": 3943601,
- "profileId": 4826,
- "mandateId": 4863790,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "GREEN ACCOUNT",
- "reference": "0123456",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 19832207,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T10:48:43.577",
- "lastUpdated": "2018-07-06T10:48:43.577",
- "modelId": 3943600,
- "profileId": 4826,
- "mandateId": 4876105,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "404040",
- "accountNumber": "15151515",
- "accountName": "REGULAR MULTI-CONT",
- "reference": "0012347",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19832206,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-07-06T10:40:28.230",
- "lastUpdated": "2018-07-06T10:40:28.230",
- "modelId": 3943599,
- "profileId": 4826,
- "mandateId": 4876104,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "404040",
- "accountNumber": "15151515",
- "accountName": "MULTI-CONTACT API",
- "reference": "0012345",
- "paymentDate": "2018-07-09T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19832202,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-06-28T08:55:56.282",
- "lastUpdated": "2018-06-28T08:55:56.282",
- "modelId": 3880378,
- "profileId": 4826,
- "mandateId": 4863790,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "987654",
- "accountNumber": "98765432",
- "accountName": "GREEN ACCOUNT",
- "reference": "0123456",
- "paymentDate": "2018-06-29T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19751175,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-06-11T13:16:31.905",
- "lastUpdated": "2018-06-11T13:16:31.905",
- "modelId": 3702635,
- "profileId": 4826,
- "mandateId": 3720671,
- "status": "PENDING",
- "paymentType": "ONE_OFF",
- "sortCode": "212121",
- "accountNumber": "10101010",
- "accountName": "NEW ACCT NAME",
- "reference": "NEW ADHOC REF",
- "altReference": "NEW ALT REF",
- "paymentDate": "2018-06-25T00:00:00.000",
- "amount": 25,
- "transactionCode": "17",
- "applicationId": 6421,
- "instructionId": 19546021,
- "batchId": 84601,
- "submissionId": 84600,
- "retryCount": 0,
- "serviceUserNumber": "000000",
- "comments": "Test comments"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-06-11T13:13:56.672",
- "lastUpdated": "2018-06-11T13:13:56.672",
- "modelId": 3702634,
- "profileId": 4826,
- "mandateId": 3720671,
- "status": "PENDING",
- "paymentType": "ONE_OFF",
- "sortCode": "212121",
- "accountNumber": "10101010",
- "accountName": "NEW ACCT NAME",
- "reference": "NEW ADHOC REF",
- "altReference": "NEW ALT REF",
- "paymentDate": "2018-06-25T00:00:00.000",
- "amount": 21,
- "transactionCode": "17",
- "applicationId": 6421,
- "instructionId": 19546017,
- "batchId": 84161,
- "submissionId": 84160,
- "retryCount": 0,
- "serviceUserNumber": "000000",
- "comments": "Test comments"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-05-16T11:17:35.573",
- "lastUpdated": "2018-05-16T11:17:35.573",
- "modelId": 3539137,
- "profileId": 4826,
- "mandateId": 3720671,
- "status": "PENDING",
- "paymentType": "ONE_OFF",
- "sortCode": "212121",
- "accountNumber": "10101010",
- "accountName": "NEW ACCT NAME",
- "reference": "NEW ADHOC REF",
- "altReference": "NEW ALT REF",
- "paymentDate": "2018-05-30T00:00:00.000",
- "amount": 21,
- "transactionCode": "17",
- "applicationId": 6421,
- "instructionId": 19361538,
- "batchId": 84161,
- "submissionId": 84160,
- "retryCount": 0,
- "serviceUserNumber": "000000",
- "comments": "Test comments"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-05-16T09:52:21.509",
- "lastUpdated": "2018-05-16T09:52:21.509",
- "modelId": 3539128,
- "profileId": 4826,
- "mandateId": 3747035,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "654321",
- "accountNumber": "87654321",
- "accountName": "ACCT HOLDER NAME",
- "reference": "1526460741354",
- "paymentDate": "2018-05-18T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19361464,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "000000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-05-16T09:37:45.148",
- "lastUpdated": "2018-05-16T09:37:45.148",
- "modelId": 3539127,
- "profileId": 4826,
- "mandateId": 3720665,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "123456",
- "accountNumber": "12345678",
- "accountName": "CHANGE GONNA COME",
- "reference": "TESTDDREF1",
- "altReference": "ALTDDREF1",
- "paymentDate": "2018-05-18T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 19361460,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "000000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-05-16T09:35:48.992",
- "lastUpdated": "2018-05-16T09:35:48.992",
- "modelId": 3539126,
- "profileId": 4826,
- "mandateId": 3720665,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "123456",
- "accountNumber": "12345678",
- "accountName": "CHANGE GONNA COME",
- "reference": "TESTDDREF1",
- "altReference": "ALTDDREF1",
- "paymentDate": "2018-05-18T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19361459,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "000000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-05-16T08:54:52.406",
- "lastUpdated": "2018-05-16T08:54:52.406",
- "modelId": 3539122,
- "profileId": 4826,
- "mandateId": 3747031,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "101101",
- "accountNumber": "10100101",
- "accountName": "ACCT NAME 101",
- "reference": "DDREF101",
- "altReference": "ALTREF101",
- "paymentDate": "2018-05-18T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 19361437,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "000000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 88
}
}
]
}
]
}
]
}
Executes a query for collection history using alternate reference and between two dates.
In the response returned, the possible values for the status of an instruction are:
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Instructions",
- "symbol": "com.bottomline.ddm.model.instruction",
- "key": "com.bottomline.ddm.model.instruction"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "altReference",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction.altReference",
- "fieldType": "STRING",
- "key": false
}, - "operator": {
- "symbol": "CONTAINS"
}, - "queryValue": {
- "@type": "string",
- "$value": "ALTDDREF2"
}
}, - {
- "@type": "QueryRelationship",
- "name": "AND",
- "description": "AND relationship.",
- "symbol": "AND"
}, - {
- "@type": "QueryParameter",
- "field": {
- "name": "paymentDate",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction.paymentDate",
- "fieldType": "DATE",
- "key": false
}, - "operator": {
- "symbol": "BETWEEN"
}, - "queryValues": [
- {
- "@type": "date",
- "$value": "2018-10-31T00:00:00.000Z"
}, - {
- "@type": "date",
- "$value": "2018-11-20T23:59:59.100Z"
}
]
}
]
}, - "resultFields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2018-05-01T09:18:01.181",
- "lastUpdated": "2018-05-01T09:18:01.181",
- "modelId": 3510589,
- "profileId": 4826,
- "mandateId": 3720667,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "234567",
- "accountNumber": "23456789",
- "accountName": "TEST ACCOUNT NAME",
- "reference": "TESTDDREF2",
- "altReference": "ALTDDREF2",
- "paymentDate": "2018-05-03T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19299866,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "000000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 1
}
}
]
}
]
}
]
}
Executes a query for collection history using profile ID and between two dates.
In the response returned, the possible values for the status of an instruction are:
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Instructions",
- "symbol": "com.bottomline.ddm.model.instruction",
- "key": "com.bottomline.ddm.model.instruction"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "profileId",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction.profileId",
- "fieldType": "LONG",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "long",
- "$value": 4826
}
}, - {
- "@type": "QueryRelationship",
- "name": "AND",
- "description": "AND relationship.",
- "symbol": "AND"
}, - {
- "@type": "QueryParameter",
- "field": {
- "name": "paymentDate",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction.paymentDate",
- "fieldType": "DATE",
- "key": false
}, - "operator": {
- "symbol": "BETWEEN"
}, - "queryValues": [
- {
- "@type": "date",
- "$value": "2021-06-17T14:01:34.238Z"
}, - {
- "@type": "date",
- "$value": "2021-06-18T14:01:34.238Z"
}
]
}
]
}, - "resultFields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2021-06-17T09:18:01.181",
- "lastUpdated": "2021-06-17T09:18:01.181",
- "modelId": 3510589,
- "profileId": 4826,
- "mandateId": 3720667,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "234567",
- "accountNumber": "23456789",
- "accountName": "TEST ACCOUNT NAME",
- "reference": "TESTDDREF2",
- "paymentDate": "2021-06-18T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 19299866,
- "batchId": 80404,
- "submissionId": 80403,
- "retryCount": 0,
- "serviceUserNumber": "000000"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 1
}
}
]
}
]
}
]
}
Executes a query for collection history by mandate.
In the response returned, the possible values for the status of an instruction are:
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Instructions",
- "symbol": "com.bottomline.ddm.model.instruction",
- "key": "com.bottomline.ddm.model.instruction"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "mandateId",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction.mandateId",
- "fieldType": "LONG",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "long",
- "$value": 9482302
}
}
]
}, - "resultFields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2021-08-10T08:39:50.362",
- "lastUpdated": "2021-08-10T08:39:50.362",
- "modelId": 10451359,
- "profileId": 4826,
- "mandateId": 9482302,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "555555",
- "accountNumber": "55555555",
- "accountName": "LODGEMAN",
- "reference": "0109482302",
- "paymentDate": "2021-08-12T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 72859798,
- "batchId": 222502,
- "submissionId": 222501,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2021-08-10T08:39:50.287",
- "lastUpdated": "2021-08-10T08:39:50.287",
- "modelId": 10451358,
- "profileId": 4826,
- "mandateId": 9482302,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "666666",
- "accountNumber": "66666666",
- "accountName": "LODGEMAN",
- "reference": "0109482302",
- "paymentDate": "2021-08-12T00:00:00.000",
- "amount": 0,
- "transactionCode": "0C",
- "applicationId": 6421,
- "instructionId": 72859797,
- "batchId": 222502,
- "submissionId": 222501,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2020-10-16T11:35:57.753",
- "lastUpdated": "2021-01-18T08:25:29.742",
- "modelId": 6462368,
- "profileId": 4826,
- "mandateId": 9482302,
- "status": "DELETED",
- "paymentType": "AUDDIS",
- "sortCode": "666666",
- "accountNumber": "66666666",
- "accountName": "LODGEMAN",
- "reference": "0109482302",
- "paymentDate": "2020-10-28T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 6421,
- "instructionId": 49221807,
- "batchId": 184074,
- "submissionId": 184073,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 3
}
}
]
}
]
}
]
}
Executes a query for collection history by Direct Debit reference.
In the response returned, the possible values for the status of an instruction are:
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Instructions",
- "symbol": "com.bottomline.ddm.model.instruction",
- "key": "com.bottomline.ddm.model.instruction"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "reference",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction.reference",
- "fieldType": "INTEGER",
- "key": false
}, - "operator": {
- "symbol": "CONTAINS"
}, - "queryValue": {
- "@type": "string",
- "$value": "ref1234"
}
}
]
}, - "resultFields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2019-02-14T17:13:32.941",
- "lastUpdated": "2019-02-14T17:13:32.941",
- "modelId": 4663784,
- "profileId": 5776,
- "mandateId": 6795346,
- "status": "PENDING",
- "paymentType": "AUDDIS",
- "sortCode": "123456",
- "accountNumber": "12345678",
- "accountName": "MR API",
- "reference": "ref1234",
- "paymentDate": "2019-02-18T00:00:00.000",
- "amount": 0,
- "transactionCode": "0N",
- "applicationId": 8281,
- "instructionId": 22190158,
- "batchId": 121656,
- "submissionId": 121655,
- "retryCount": 0,
- "serviceUserNumber": "111111"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 1
}
}
]
}
]
}
]
}
Executes a query for collection history using status, payment type and between two dates.
In the response returned, the possible values for the status of an instruction are:
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Instructions",
- "symbol": "com.bottomline.ddm.model.instruction",
- "key": "com.bottomline.ddm.model.instruction"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "paymentDate",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction.paymentDate",
- "fieldType": "DATE",
- "key": false
}, - "operator": {
- "symbol": "BETWEEN"
}, - "queryValues": [
- {
- "@type": "date",
- "$value": "2022-09-01T00:00:00.000Z"
}, - {
- "@type": "date",
- "$value": "2022-09-30T23:59:59.100Z"
}
]
}, - {
- "@type": "QueryRelationship",
- "name": "AND",
- "description": "AND relationship.",
- "symbol": "AND"
}, - {
- "@type": "QueryParameter",
- "field": {
- "name": "status",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction.status",
- "fieldType": "STRING",
- "key": false
}, - "operator": {
- "symbol": "IN"
}, - "queryValues": [
- {
- "@type": "string",
- "$value": "SUCCESS"
}, - {
- "@type": "string",
- "$value": "FAILURE"
}
]
}, - {
- "@type": "QueryRelationship",
- "name": "AND",
- "description": "AND relationship.",
- "symbol": "AND"
}, - {
- "@type": "QueryParameter",
- "field": {
- "name": "paymentType",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction.paymentType",
- "fieldType": "ENUM",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": [
- {
- "@type": "string",
- "$value": "ONE_OFF"
}
]
}
]
}, - "resultFields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Instruction",
- "symbol": "com.bottomline.ddm.model.instruction.Instruction",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "Instruction",
- "created": "2022-09-03T09:21:04.747",
- "lastUpdated": "2023-03-01T11:44:59.699",
- "modelId": 4434588,
- "profileId": 4826,
- "mandateId": 5004606,
- "status": "SUCCESS",
- "paymentType": "ONE_OFF",
- "sortCode": "202020",
- "accountNumber": "20202020",
- "accountName": "JOHN SMITH",
- "reference": "20202020",
- "paymentDate": "2022-09-17T00:00:00.000",
- "amount": 7.65,
- "transactionCode": "17",
- "applicationId": 6421,
- "instructionId": 20516808,
- "batchId": 118895,
- "submissionId": 118894,
- "retryCount": 0,
- "serviceUserNumber": "100265"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 1
}
}
]
}
]
}
]
}
Correspondence for a contact is used for Direct Debit collections.
The API allows you to execute a query to list all correspondence IDs by profile ID and status, the correspondence can then be suppressed if required.
The API also allows you to generate a report for a given correspondence and then retrieve it.
Generates a report for a given correspondence.
id required | integer <long> ID of the correspondence which can be obtained from the Query DDM correspondence by ID and status call. |
curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/ddm/reports/generate/communication/89337
{- "@type": "PollUrlResponse",
}
Retrieves a report for a given correspondence.
The URL for this API call is the value of the pollURL field returned in the response of the Generate report call.
id required | integer <long> Report ID which can be obtained from the Generate report call. |
curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/reporting/14410/download/PDF
Suspends communication using communcation ID if required.
id required | integer <int64> ID of the correspondence obtained from the Query DDM correspondence by ID and status call. |
curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/ddm/communications/2827208/suppress
{- "@type": "Auditable",
- "created": "2021-09-23T09:46:59.318",
- "lastUpdated": "2021-10-06T10:47:47.172"
}
Executes a query to return the correspondence for all mandates.
Note: By default only the first 50 entries will be returned.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Communications",
- "symbol": "com.bottomline.ddm.model.communication",
- "key": "com.bottomline.ddm.model.communication"
}, - "resultFields": [
- {
- "name": "Communication",
- "symbol": "com.bottomline.ddm.model.communication.Communication",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Communication",
- "symbol": "com.bottomline.ddm.model.communication.Communication",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1806257,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 8230901,
- "contactId": 7042919,
- "profileId": 6257,
- "trigger": "CHANGE_MANDATE",
- "reference": "12354684351-02",
- "accountName": "THYGHHH",
- "accountNumber": "11111111",
- "sortCode": "111111",
- "sun": "440044",
- "title": "Mr",
- "firstName": "David",
- "lastName": "Archer",
- "town": "Westbury",
- "contactAddressLines": [
- "530",
- "High St"
], - "code": "BA133BN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-02-10T17:29:28.544",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Agent Martin",
- "profileContactCompany": "Agent Industries",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "A@B.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "AGENT COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1806226,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7554375,
- "profileId": 6140,
- "trigger": "CANCEL_MANDATE",
- "reference": "68161618",
- "accountName": "OUBHUYVUBVUVYVTY",
- "accountNumber": "11111111",
- "sortCode": "111111",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-02-10T11:54:21.788",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1805950,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7554375,
- "profileId": 6257,
- "trigger": "CANCEL_MANDATE",
- "reference": "84965816161",
- "accountName": "IBUV",
- "accountNumber": "22222222",
- "sortCode": "222222",
- "sun": "440044",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-02-10T11:54:02.744",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Agent Martin",
- "profileContactCompany": "Agent Industries",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "A@B.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "AGENT COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1805892,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7554375,
- "profileId": 6257,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "84965816161",
- "accountName": "IBUV",
- "accountNumber": "22222222",
- "sortCode": "222222",
- "sun": "440044",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-02-10T11:52:36.893",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Agent Martin",
- "profileContactCompany": "Agent Industries",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "A@B.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "AGENT COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1805891,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 8230901,
- "contactId": 7042919,
- "profileId": 6257,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "12354684351",
- "accountName": "THYGHHH",
- "accountNumber": "11111111",
- "sortCode": "111111",
- "sun": "440044",
- "title": "Mr",
- "firstName": "David",
- "lastName": "Archer",
- "town": "Westbury",
- "contactAddressLines": [
- "530",
- "High St"
], - "code": "BA133BN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-02-10T11:50:58.535",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Agent Martin",
- "profileContactCompany": "Agent Industries",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "A@B.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "AGENT COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1803951,
- "type": "LOCAL_PRINT",
- "status": "CREATED",
- "mandateId": 4876125,
- "contactId": 4787304,
- "profileId": 4826,
- "trigger": "CHANGE_MANDATE",
- "reference": "000423",
- "accountName": "3RD API ACCOUNT",
- "accountNumber": "60000006",
- "sortCode": "606060",
- "sun": "100265",
- "title": "Mr",
- "firstName": "Import",
- "lastName": "Multiple",
- "contactAddressLines": [
- "1 Avenue"
], - "code": "JK44 0ER",
- "country": "UK",
- "email": "J@K.com",
- "created": "2020-01-29T12:48:57.302",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": false,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1803369,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 7989968,
- "contactId": 7554375,
- "profileId": 6140,
- "trigger": "CHANGE_MANDATE",
- "reference": "1579099737565",
- "accountName": "LISA JALI",
- "accountNumber": "00007338",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-01-28T11:48:14.026",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1801009,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 7989968,
- "contactId": 7554375,
- "profileId": 6140,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "1579099737565",
- "accountName": "LISA JALI",
- "accountNumber": "00007338",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-01-15T14:48:57.734",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1798820,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 7237577,
- "contactId": 3691994,
- "profileId": 4826,
- "trigger": "CHANGE_MANDATE",
- "reference": "DRAFTACTIVEPLAN",
- "altReference": "DRAFTACTIVEPLAN REF",
- "accountName": "DRAFTACTIVEPLAN",
- "accountNumber": "44444444",
- "sortCode": "555555",
- "sun": "100265",
- "title": "MRS",
- "firstName": "Updated firstName",
- "lastName": "Updated lastName",
- "companyName": "Updated Co Name",
- "town": "Updated Town Name",
- "contactAddressLines": [
- "123 Update Road ",
- "Updated Street Name"
], - "code": "AB1 2CD",
- "county": "Updated County Name",
- "country": "Updated UK",
- "email": "Alex.Martin@bottomline.com",
- "created": "2020-01-09T13:54:09.226",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": false,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1797173,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7109222,
- "profileId": 4826,
- "trigger": "CANCEL_MANDATE",
- "reference": "REF0123",
- "altReference": "ALTREF0123",
- "accountName": "MR ACCOUNT",
- "accountNumber": "01230123",
- "sortCode": "012012",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-01-09T09:55:18.287",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1797172,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7109222,
- "profileId": 4826,
- "trigger": "CANCEL_MANDATE",
- "reference": "REF0123456",
- "altReference": "ALTREF0123F",
- "accountName": "MR ACCOUNT",
- "accountNumber": "01230123",
- "sortCode": "012012",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-01-09T09:55:01.092",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1797171,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7109222,
- "profileId": 4826,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "REF0123456",
- "altReference": "ALTREF0123F",
- "accountName": "MR ACCOUNT",
- "accountNumber": "01230123",
- "sortCode": "012012",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-01-09T09:54:59.237",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1797170,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7109222,
- "profileId": 4826,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "REF0123",
- "altReference": "ALTREF0123",
- "accountName": "MR ACCOUNT",
- "accountNumber": "01230123",
- "sortCode": "012012",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-01-09T09:53:20.239",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1797169,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7060099,
- "profileId": 4826,
- "trigger": "CANCEL_MANDATE",
- "reference": "123456789",
- "accountName": "API USER",
- "accountNumber": "12345678",
- "sortCode": "200000",
- "sun": "100265",
- "title": "Dr",
- "firstName": "A",
- "lastName": "PI",
- "town": "Reading",
- "contactAddressLines": [
- "99 Post Lane"
], - "code": "RG1 1GR",
- "country": "UK",
- "email": "test@test.com",
- "created": "2020-01-09T09:47:17.942",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1797168,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7060099,
- "profileId": 4826,
- "trigger": "CHANGE_MANDATE",
- "reference": "123456789",
- "accountName": "API USER",
- "accountNumber": "12345678",
- "sortCode": "200000",
- "sun": "100265",
- "title": "Dr",
- "firstName": "A",
- "lastName": "PI",
- "town": "Reading",
- "contactAddressLines": [
- "99 Post Lane"
], - "code": "RG1 1GR",
- "country": "UK",
- "email": "test@test.com",
- "created": "2020-01-09T09:47:14.716",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1797167,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7478444,
- "profileId": 6140,
- "trigger": "CANCEL_MANDATE",
- "reference": "1576140041356",
- "accountName": "LISA JALI",
- "accountNumber": "00007338",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-01-09T09:46:02.379",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1797166,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7478444,
- "profileId": 6140,
- "trigger": "CHANGE_MANDATE",
- "reference": "1576140041356",
- "accountName": "LISA JALI",
- "accountNumber": "00007338",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-01-09T09:45:55.240",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1796357,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 6544652,
- "contactId": 5118122,
- "profileId": 5761,
- "trigger": "CHANGE_MANDATE",
- "reference": "123456789012345678",
- "altReference": "NEW EMAIL TEST1",
- "accountName": "123456789012345678",
- "accountNumber": "11111111",
- "sortCode": "111111",
- "sun": "100265",
- "firstName": "!\"£$%^&*()_+=-#';",
- "lastName": "12345678901234567890123456789012",
- "contactAddressLines": [
- "n/a"
], - "code": "n/a",
- "country": "UK",
- "email": "1@2.com",
- "created": "2020-01-08T09:22:56.826",
- "mandateNoticePeriod": 5,
- "oneOffNoticePeriod": 10,
- "profileContactName": "John Smith",
- "profileContactCompany": "John Smith Industries",
- "profileContactPhone": "012345",
- "profileContactEmail": "Z@Z.com",
- "isAttachmentUsed": false,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE 2"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1700110,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7478444,
- "profileId": 6140,
- "trigger": "CHANGE_MANDATE",
- "reference": "1576140041356",
- "accountName": "LISA JALI",
- "accountNumber": "00007338",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2019-12-12T08:51:52.557",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1700108,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7478444,
- "profileId": 6140,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "1576140041356",
- "accountName": "LISA JALI",
- "accountNumber": "00007338",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2019-12-12T08:40:41.695",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1700013,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 6544652,
- "contactId": 5118122,
- "profileId": 5761,
- "trigger": "ONE_OFF_PAYMENT",
- "reference": "NO PLAN NEW LETTER",
- "altReference": "NEW EMAIL TEST1",
- "accountName": "ACC NAME",
- "accountNumber": "11111111",
- "sortCode": "111111",
- "sun": "100265",
- "lastName": "Contact",
- "contactAddressLines": [
- "n/a"
], - "code": "n/a",
- "country": "UK",
- "email": "1@2.com",
- "amount": 3.33,
- "comments": "EXAMPLE3.33",
- "dueDate": "2019-12-24T00:00:00.000",
- "created": "2019-12-10T16:06:02.360",
- "mandateNoticePeriod": 5,
- "oneOffNoticePeriod": 10,
- "profileContactName": "John Smith",
- "profileContactCompany": "John Smith Industries",
- "profileContactPhone": "012345",
- "profileContactEmail": "Z@Z.com",
- "isAttachmentUsed": false,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE 2"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1700012,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 6544652,
- "contactId": 5118122,
- "profileId": 5761,
- "trigger": "CHANGE_MANDATE",
- "reference": "NO PLAN NEW LETTER",
- "altReference": "NEW EMAIL TEST1",
- "accountName": "ACC NAME",
- "accountNumber": "11111111",
- "sortCode": "111111",
- "sun": "100265",
- "lastName": "Contact",
- "contactAddressLines": [
- "n/a"
], - "code": "n/a",
- "country": "UK",
- "email": "1@2.com",
- "created": "2019-12-10T16:05:46.749",
- "mandateNoticePeriod": 5,
- "oneOffNoticePeriod": 10,
- "profileContactName": "John Smith",
- "profileContactCompany": "John Smith Industries",
- "profileContactPhone": "012345",
- "profileContactEmail": "Z@Z.com",
- "isAttachmentUsed": false,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE 2"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1698918,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 7237577,
- "contactId": 3691994,
- "profileId": 4826,
- "trigger": "CHANGE_MANDATE",
- "reference": "DRAFTACTIVEPLAN",
- "altReference": "DRAFTACTIVEPLAN REF",
- "accountName": "DRAFTACTIVEPLAN",
- "accountNumber": "44444444",
- "sortCode": "555555",
- "sun": "100265",
- "title": "MRS",
- "firstName": "Updated firstName",
- "lastName": "Updated lastName",
- "companyName": "Updated Co Name",
- "town": "Updated Town Name",
- "contactAddressLines": [
- "123 Update Road ",
- "Updated Street Name"
], - "code": "AB1 2CD",
- "county": "Updated County Name",
- "country": "Updated UK",
- "email": "Alex.Martin@bottomline.com",
- "created": "2019-12-05T11:16:41.874",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": false,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1692101,
- "type": "LOCAL_PRINT",
- "status": "CREATED",
- "mandateId": 7530658,
- "contactId": 6820801,
- "profileId": 6257,
- "trigger": "CHANGE_MANDATE",
- "reference": "REF1234",
- "accountName": "MR ONE",
- "accountNumber": "11111111",
- "sortCode": "100001",
- "sun": "440044",
- "title": "MR",
- "firstName": "firstName NOREF",
- "lastName": "NOREF lastName",
- "companyName": "No REF COMPANY",
- "town": "NOREF Town",
- "contactAddressLines": [
- "123 ",
- "Street Name"
], - "code": "AB1 2CD",
- "county": "NOREF County",
- "country": "UK",
- "email": "NOREF@b.com",
- "created": "2019-11-27T11:45:52.414",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Agent Martin",
- "profileContactCompany": "Agent Industries",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "A@B.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "AGENT COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1686532,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 7303851,
- "contactId": 7109222,
- "profileId": 6140,
- "trigger": "REFUND_PAYMENT",
- "reference": "1567516486992",
- "accountName": "LISA JALI",
- "accountNumber": "00007338",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "amount": 17.5,
- "comments": "multi refund oneoff",
- "dueDate": "2019-11-25T00:00:00.000",
- "created": "2019-11-21T09:38:34.673",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1686531,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 7451379,
- "contactId": 7205588,
- "profileId": 6140,
- "trigger": "REFUND_PAYMENT",
- "reference": "1570183864076",
- "accountName": "ASHELY MARMA",
- "accountNumber": "00003036",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Ashely",
- "lastName": "Marma",
- "contactAddressLines": [
- "Abbey Lodge",
- "Wydeville Manor Road"
], - "code": "SE120ES",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "amount": 19,
- "comments": "multi refund oneoff",
- "dueDate": "2019-11-25T00:00:00.000",
- "created": "2019-11-21T09:38:34.634",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1686440,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 7303851,
- "contactId": 7109222,
- "profileId": 6140,
- "trigger": "REFUND_PAYMENT",
- "reference": "1567516486992",
- "accountName": "LISA JALI",
- "accountNumber": "00007338",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "amount": 17.5,
- "comments": "multi refund oneoff",
- "dueDate": "2019-11-25T00:00:00.000",
- "created": "2019-11-21T09:20:13.472",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1686439,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 7451379,
- "contactId": 7205588,
- "profileId": 6140,
- "trigger": "REFUND_PAYMENT",
- "reference": "1570183864076",
- "accountName": "ASHELY MARMA",
- "accountNumber": "00003036",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Ashely",
- "lastName": "Marma",
- "contactAddressLines": [
- "Abbey Lodge",
- "Wydeville Manor Road"
], - "code": "SE120ES",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "amount": 19,
- "comments": "multi refund oneoff",
- "dueDate": "2019-11-25T00:00:00.000",
- "created": "2019-11-21T09:20:13.423",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1686438,
- "type": "LOCAL_PRINT",
- "status": "CREATED",
- "mandateId": 7530658,
- "contactId": 6820801,
- "profileId": 6257,
- "trigger": "REFUND_PAYMENT",
- "reference": "REF1111",
- "accountName": "MR ONE",
- "accountNumber": "11111111",
- "sortCode": "100001",
- "sun": "440044",
- "title": "MR",
- "firstName": "firstName NOREF",
- "lastName": "NOREF lastName",
- "companyName": "No REF COMPANY",
- "town": "NOREF Town",
- "contactAddressLines": [
- "123 ",
- "Street Name"
], - "code": "AB1 2CD",
- "county": "NOREF County",
- "country": "UK",
- "email": "NOREF@b.com",
- "amount": 25,
- "comments": "test refund oneoff",
- "dueDate": "2019-11-25T00:00:00.000",
- "created": "2019-11-21T09:14:04.403",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Agent Martin",
- "profileContactCompany": "Agent Industries",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "A@B.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "AGENT COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1686437,
- "type": "LOCAL_PRINT",
- "status": "CREATED",
- "mandateId": 7530658,
- "contactId": 6820801,
- "profileId": 6257,
- "trigger": "REFUND_PAYMENT",
- "reference": "REF1111",
- "accountName": "MR ONE",
- "accountNumber": "11111111",
- "sortCode": "100001",
- "sun": "440044",
- "title": "MR",
- "firstName": "firstName NOREF",
- "lastName": "NOREF lastName",
- "companyName": "No REF COMPANY",
- "town": "NOREF Town",
- "contactAddressLines": [
- "123 ",
- "Street Name"
], - "code": "AB1 2CD",
- "county": "NOREF County",
- "country": "UK",
- "email": "NOREF@b.com",
- "amount": 3.21,
- "comments": "Single One-Off Refund",
- "dueDate": "2019-11-25T00:00:00.000",
- "created": "2019-11-21T09:07:16.616",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Agent Martin",
- "profileContactCompany": "Agent Industries",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "A@B.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "AGENT COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1686328,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 5164746,
- "contactId": 3691994,
- "profileId": 4826,
- "trigger": "CHANGE_MANDATE",
- "reference": "NEW REF ADHOC API",
- "altReference": "NEW ALT REF",
- "accountName": "NEW ACC NAME",
- "accountNumber": "44444444",
- "sortCode": "555555",
- "sun": "100265",
- "title": "MRS",
- "firstName": "Updated firstName",
- "lastName": "Updated lastName",
- "companyName": "Updated Co Name",
- "town": "Updated Town Name",
- "contactAddressLines": [
- "123 Update Road ",
- "Updated Street Name"
], - "code": "AB1 2CD",
- "county": "Updated County Name",
- "country": "Updated UK",
- "email": "Alex.Martin@bottomline.com",
- "created": "2019-11-20T10:44:36.440",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": false,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1686327,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 5164746,
- "contactId": 3691994,
- "profileId": 4826,
- "trigger": "CHANGE_MANDATE",
- "reference": "NEW REF ADHOC API",
- "altReference": "NEW ALT REF",
- "accountName": "NEW ACC NAME",
- "accountNumber": "44444444",
- "sortCode": "555555",
- "sun": "100265",
- "title": "MRS",
- "firstName": "Updated firstName",
- "lastName": "Updated lastName",
- "companyName": "Updated Co Name",
- "town": "Updated Town Name",
- "contactAddressLines": [
- "123 Update Road ",
- "Updated Street Name"
], - "code": "AB1 2CD",
- "county": "Updated County Name",
- "country": "Updated UK",
- "email": "Alex.Martin@bottomline.com",
- "created": "2019-11-20T10:43:40.633",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": false,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1683250,
- "type": "EMAIL",
- "status": "EMAILED",
- "mandateId": 7303851,
- "contactId": 7109222,
- "profileId": 6140,
- "trigger": "CHANGE_MANDATE",
- "reference": "1567516486992",
- "accountName": "LISA JALI",
- "accountNumber": "00007338",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2019-11-14T09:49:36.649",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1683249,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 5164746,
- "contactId": 3691994,
- "profileId": 4826,
- "trigger": "CHANGE_MANDATE",
- "reference": "NEW REF ADHOC API",
- "altReference": "NEW ALT REF",
- "accountName": "NEW ACC NAME",
- "accountNumber": "44444444",
- "sortCode": "555555",
- "sun": "100265",
- "title": "MRS",
- "firstName": "Updated firstName",
- "lastName": "Updated lastName",
- "companyName": "Updated Co Name",
- "town": "Updated Town Name",
- "contactAddressLines": [
- "123 Update Road ",
- "Updated Street Name"
], - "code": "AB1 2CD",
- "county": "Updated County Name",
- "country": "Updated UK",
- "email": "Alex.Martin@bottomline.com",
- "created": "2019-11-14T09:37:25.407",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": false,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1682887,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 5004606,
- "contactId": 4787304,
- "profileId": 4826,
- "trigger": "ONE_OFF_PAYMENT",
- "reference": "20202020",
- "accountName": "JOHN SMITH",
- "accountNumber": "20202020",
- "sortCode": "202020",
- "sun": "100265",
- "title": "Mr",
- "firstName": "Import",
- "lastName": "Multiple",
- "contactAddressLines": [
- "1 Avenue"
], - "code": "JK44 0ER",
- "country": "UK",
- "email": "J@K.com",
- "amount": 45.5,
- "comments": "Comments Here",
- "dueDate": "2019-12-12T00:00:00.000",
- "created": "2019-11-13T09:39:19.121",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1682886,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 5004606,
- "contactId": 4787304,
- "profileId": 4826,
- "trigger": "ONE_OFF_PAYMENT",
- "reference": "20202020",
- "accountName": "JOHN SMITH",
- "accountNumber": "20202020",
- "sortCode": "202020",
- "sun": "100265",
- "title": "Mr",
- "firstName": "Import",
- "lastName": "Multiple",
- "contactAddressLines": [
- "1 Avenue"
], - "code": "JK44 0ER",
- "country": "UK",
- "email": "J@K.com",
- "amount": 45.5,
- "comments": "Comments Here",
- "dueDate": "2019-12-12T00:00:00.000",
- "created": "2019-11-13T09:35:45.224",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1682885,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 5004606,
- "contactId": 4787304,
- "profileId": 4826,
- "trigger": "ONE_OFF_PAYMENT",
- "reference": "20202020",
- "accountName": "JOHN SMITH",
- "accountNumber": "20202020",
- "sortCode": "202020",
- "sun": "100265",
- "title": "Mr",
- "firstName": "Import",
- "lastName": "Multiple",
- "contactAddressLines": [
- "1 Avenue"
], - "code": "JK44 0ER",
- "country": "UK",
- "email": "J@K.com",
- "amount": 45.5,
- "comments": "One-off after mandate already cancelled *TEST*",
- "dueDate": "2019-12-12T00:00:00.000",
- "created": "2019-11-13T09:35:19.205",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1681851,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 6544652,
- "contactId": 5118122,
- "profileId": 5761,
- "trigger": "REFUND_PAYMENT",
- "reference": "NO PLAN NEW LETTER",
- "altReference": "NEW EMAIL TEST1",
- "accountName": "ACC NAME",
- "accountNumber": "11111111",
- "sortCode": "111111",
- "sun": "100265",
- "lastName": "Contact",
- "contactAddressLines": [
- "n/a"
], - "code": "n/a",
- "country": "UK",
- "email": "1@2.com",
- "amount": 14.14,
- "comments": "test trans code import",
- "dueDate": "2019-11-11T00:00:00.000",
- "created": "2019-11-05T14:26:22.045",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "John Smith",
- "profileContactCompany": "John Smith Industries",
- "profileContactPhone": "012345",
- "profileContactEmail": "Z@Z.com",
- "isAttachmentUsed": false,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE 2"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1680582,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 4876126,
- "contactId": 4787305,
- "profileId": 4826,
- "trigger": "REACTIVATE_MANDATE",
- "reference": "000424",
- "accountName": "4TH API ACCOUNT",
- "accountNumber": "70000007",
- "sortCode": "700007",
- "sun": "100265",
- "title": "Mr",
- "firstName": "Adhoc",
- "lastName": "Multiple",
- "contactAddressLines": [
- "1 Avenue"
], - "code": "JK44 0ER",
- "country": "UK",
- "email": "J@K.com",
- "created": "2019-10-30T15:06:00.410",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1680581,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 4876126,
- "contactId": 4787305,
- "profileId": 4826,
- "trigger": "CANCEL_MANDATE",
- "reference": "000424",
- "accountName": "4TH API ACCOUNT",
- "accountNumber": "70000007",
- "sortCode": "700007",
- "sun": "100265",
- "title": "Mr",
- "firstName": "Adhoc",
- "lastName": "Multiple",
- "contactAddressLines": [
- "1 Avenue"
], - "code": "JK44 0ER",
- "country": "UK",
- "email": "J@K.com",
- "created": "2019-10-30T15:05:56.028",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1677471,
- "type": "LOCAL_PRINT",
- "status": "CREATED",
- "mandateId": 7530658,
- "contactId": 6820801,
- "profileId": 6257,
- "trigger": "CHANGE_MANDATE",
- "reference": "REF1111",
- "accountName": "MR ONE",
- "accountNumber": "11111111",
- "sortCode": "100001",
- "sun": "440044",
- "title": "MR",
- "firstName": "NOREF firstName",
- "lastName": "NOREF lastName",
- "companyName": "No REF COMPANY",
- "town": "NOREF Town",
- "contactAddressLines": [
- "123 ",
- "Street Name"
], - "code": "AB1 2CD",
- "county": "NOREF County",
- "country": "UK",
- "email": "NOREF@b.com",
- "created": "2019-10-18T10:34:38.649",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Agent Martin",
- "profileContactCompany": "Agent Industries",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "A@B.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "AGENT COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1677470,
- "type": "LOCAL_PRINT",
- "status": "CREATED",
- "mandateId": 7530658,
- "contactId": 6820801,
- "profileId": 6257,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "REF1111",
- "accountName": "MR ONE",
- "accountNumber": "11111111",
- "sortCode": "111111",
- "sun": "440044",
- "title": "MR",
- "firstName": "NOREF firstName",
- "lastName": "NOREF lastName",
- "companyName": "No REF COMPANY",
- "town": "NOREF Town",
- "contactAddressLines": [
- "123 ",
- "Street Name"
], - "code": "AB1 2CD",
- "county": "NOREF County",
- "country": "UK",
- "email": "NOREF@b.com",
- "created": "2019-10-18T10:34:22.302",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Agent Martin",
- "profileContactCompany": "Agent Industries",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "A@B.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "AGENT COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1677469,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7041946,
- "profileId": 6140,
- "trigger": "CHANGE_MANDATE",
- "reference": "1563283687740",
- "accountName": "MR D ARCHER",
- "accountNumber": "40308669",
- "sortCode": "560036",
- "sun": "100265",
- "firstName": "David",
- "lastName": "Archer",
- "town": "Westbury",
- "contactAddressLines": [
- "530",
- "High St"
], - "code": "BA133BN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2019-10-18T10:31:29.480",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1677468,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7041946,
- "profileId": 6140,
- "trigger": "CANCEL_MANDATE",
- "reference": "1563283687740",
- "accountName": "MR D ARCHER",
- "accountNumber": "40308669",
- "sortCode": "560036",
- "sun": "100265",
- "firstName": "David",
- "lastName": "Archer",
- "town": "Westbury",
- "contactAddressLines": [
- "530",
- "High St"
], - "code": "BA133BN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2019-10-18T10:31:24.725",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1677467,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 3691994,
- "profileId": 4826,
- "trigger": "CANCEL_MANDATE",
- "reference": "MAN-EGN76ADF",
- "altReference": "NEW ALT REF",
- "accountName": "MRS B BROWN",
- "accountNumber": "11111111",
- "sortCode": "123456",
- "sun": "100265",
- "title": "MRS",
- "firstName": "Updated firstName",
- "lastName": "Updated lastName",
- "companyName": "Updated Co Name",
- "town": "Updated Town Name",
- "contactAddressLines": [
- "123 Update Road ",
- "Updated Street Name"
], - "code": "AB1 2CD",
- "county": "Updated County Name",
- "country": "Updated UK",
- "email": "Alex.Martin@bottomline.com",
- "created": "2019-10-18T10:30:47.521",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": false,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1677466,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 3691994,
- "profileId": 4826,
- "trigger": "SUSPEND_MANDATE",
- "reference": "MAN-EGN76ADF",
- "altReference": "NEW ALT REF",
- "accountName": "MRS B BROWN",
- "accountNumber": "11111111",
- "sortCode": "123456",
- "sun": "100265",
- "title": "MRS",
- "firstName": "Updated firstName",
- "lastName": "Updated lastName",
- "companyName": "Updated Co Name",
- "town": "Updated Town Name",
- "contactAddressLines": [
- "123 Update Road ",
- "Updated Street Name"
], - "code": "AB1 2CD",
- "county": "Updated County Name",
- "country": "Updated UK",
- "email": "Alex.Martin@bottomline.com",
- "created": "2019-10-18T10:30:43.851",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": false,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1677465,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 3691994,
- "profileId": 4826,
- "trigger": "CHANGE_MANDATE",
- "reference": "MAN-EGN76ADF",
- "altReference": "NEW ALT REF",
- "accountName": "MRS B BROWN",
- "accountNumber": "11111111",
- "sortCode": "123456",
- "sun": "100265",
- "title": "MRS",
- "firstName": "Updated firstName",
- "lastName": "Updated lastName",
- "companyName": "Updated Co Name",
- "town": "Updated Town Name",
- "contactAddressLines": [
- "123 Update Road ",
- "Updated Street Name"
], - "code": "AB1 2CD",
- "county": "Updated County Name",
- "country": "Updated UK",
- "email": "Alex.Martin@bottomline.com",
- "created": "2019-10-18T10:30:38.930",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": false,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1676429,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7060099,
- "profileId": 4826,
- "trigger": "CHANGE_MANDATE",
- "reference": "123456789",
- "accountName": "API USER",
- "accountNumber": "12345678",
- "sortCode": "200000",
- "sun": "100265",
- "title": "Dr",
- "firstName": "A",
- "lastName": "PI",
- "town": "Reading",
- "contactAddressLines": [
- "99 Post Lane"
], - "code": "RG1 1GR",
- "country": "UK",
- "email": "test@test.com",
- "created": "2019-10-11T12:51:57.051",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1676221,
- "type": "LOCAL_PRINT",
- "status": "PRINTED",
- "mandateId": 7237577,
- "contactId": 3691994,
- "profileId": 4826,
- "trigger": "CHANGE_MANDATE",
- "reference": "DRAFTACTIVEPLAN",
- "altReference": "DRAFTACTIVEPLAN REF",
- "accountName": "DRAFTACTIVEPLAN",
- "accountNumber": "44444444",
- "sortCode": "555555",
- "sun": "100265",
- "title": "MRS",
- "firstName": "Updated firstName",
- "lastName": "Updated lastName",
- "companyName": "Updated Co Name",
- "town": "Updated Town Name",
- "contactAddressLines": [
- "123 Update Road ",
- "Updated Street Name"
], - "code": "AB1 2CD",
- "county": "Updated County Name",
- "country": "Updated UK",
- "email": "UpdatedfirstlastNames@b.com",
- "created": "2019-10-09T11:33:16.315",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1676220,
- "type": "LOCAL_PRINT",
- "status": "CREATED",
- "mandateId": 7237577,
- "contactId": 3691994,
- "profileId": 4826,
- "trigger": "REACTIVATE_MANDATE",
- "reference": "DRAFTACTIVEPLAN",
- "altReference": "DRAFTACTIVEPLAN REF",
- "accountName": "DRAFTACTIVEPLAN",
- "accountNumber": "44444444",
- "sortCode": "555555",
- "sun": "100265",
- "title": "MRS",
- "firstName": "Updated firstName",
- "lastName": "Updated lastName",
- "companyName": "Updated Co Name",
- "town": "Updated Town Name",
- "contactAddressLines": [
- "123 Update Road ",
- "Updated Street Name"
], - "code": "AB1 2CD",
- "county": "Updated County Name",
- "country": "Updated UK",
- "email": "UpdatedfirstlastNames@b.com",
- "created": "2019-10-09T11:29:52.145",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 316
}
}
]
}
]
}
]
}
Executes a query to return the correspondence by subject for all mandates.
Possible values for the subject are:
Notes:
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Communications",
- "symbol": "com.bottomline.ddm.model.communication",
- "key": "com.bottomline.ddm.model.communication"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "trigger",
- "symbol": "com.bottomline.ddm.model.communication.Communication.trigger",
- "fieldType": "ENUM",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "string",
- "$value": "NEW_MANDATE_NO_PLAN"
}
}
]
}, - "resultFields": [
- {
- "name": "Communication",
- "symbol": "com.bottomline.ddm.model.communication.Communication",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Communication",
- "symbol": "com.bottomline.ddm.model.communication.Communication",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1805892,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7554375,
- "profileId": 6257,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "84965816161",
- "accountName": "IBUV",
- "accountNumber": "22222222",
- "sortCode": "222222",
- "sun": "440044",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-02-10T11:52:36.893",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Agent Martin",
- "profileContactCompany": "Agent Industries",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "A@B.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "AGENT COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1805891,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 8230901,
- "contactId": 7042919,
- "profileId": 6257,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "12354684351",
- "accountName": "THYGHHH",
- "accountNumber": "11111111",
- "sortCode": "111111",
- "sun": "440044",
- "title": "Mr",
- "firstName": "David",
- "lastName": "Archer",
- "town": "Westbury",
- "contactAddressLines": [
- "530",
- "High St"
], - "code": "BA133BN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-02-10T11:50:58.535",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Agent Martin",
- "profileContactCompany": "Agent Industries",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "A@B.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "AGENT COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1801009,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7554375,
- "profileId": 6140,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "1579099737565",
- "accountName": "LISA JALI",
- "accountNumber": "00007338",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-01-15T14:48:57.734",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1797171,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7109222,
- "profileId": 4826,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "REF0123456",
- "altReference": "ALTREF0123F",
- "accountName": "MR ACCOUNT",
- "accountNumber": "01230123",
- "sortCode": "012012",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-01-09T09:54:59.237",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1797170,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7109222,
- "profileId": 4826,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "REF0123",
- "altReference": "ALTREF0123",
- "accountName": "MR ACCOUNT",
- "accountNumber": "01230123",
- "sortCode": "012012",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2020-01-09T09:53:20.239",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Test PTX Company",
- "profileContactAddress": "Host Address 1\nHost Address 2\nHost City\nHost Postcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "TEST COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1700108,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7478444,
- "profileId": 6140,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "1576140041356",
- "accountName": "LISA JALI",
- "accountNumber": "00007338",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2019-12-12T08:40:41.695",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1677470,
- "type": "LOCAL_PRINT",
- "status": "CREATED",
- "mandateId": 7530658,
- "contactId": 6820801,
- "profileId": 6257,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "REF1111",
- "accountName": "MR ONE",
- "accountNumber": "11111111",
- "sortCode": "111111",
- "sun": "440044",
- "title": "MR",
- "firstName": "NOREF firstName",
- "lastName": "NOREF lastName",
- "companyName": "No REF COMPANY",
- "town": "NOREF Town",
- "contactAddressLines": [
- "123 ",
- "Street Name"
], - "code": "AB1 2CD",
- "county": "NOREF County",
- "country": "UK",
- "email": "NOREF@b.com",
- "created": "2019-10-18T10:34:22.302",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Agent Martin",
- "profileContactCompany": "Agent Industries",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "A@B.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "AGENT COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1676024,
- "type": "EMAIL",
- "status": "CREATED",
- "mandateId": 7451379,
- "contactId": 7205588,
- "profileId": 6140,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "1570183864076",
- "accountName": "ASHELY MARMA",
- "accountNumber": "00003036",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Ashely",
- "lastName": "Marma",
- "contactAddressLines": [
- "Abbey Lodge",
- "Wydeville Manor Road"
], - "code": "SE120ES",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2019-10-04T11:11:04.257",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1666543,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7191480,
- "profileId": 6140,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "1569509277330",
- "accountName": "LISA JALI",
- "accountNumber": "00007338",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2019-09-26T15:47:57.494",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 1666230,
- "type": "EMAIL",
- "status": "CREATED",
- "contactId": 7190721,
- "profileId": 6140,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "1569243076108",
- "accountName": "LISA JALI",
- "accountNumber": "00007338",
- "sortCode": "070116",
- "sun": "100265",
- "firstName": "Lisa",
- "lastName": "Jali",
- "town": "Caernarfon",
- "contactAddressLines": [
- "Cae Synamon",
- "Bangor Road"
], - "code": "LL551LN",
- "country": "United Kingdom",
- "email": "alex.martin@bottomline.com",
- "created": "2019-09-23T13:51:16.280",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Alex Martin",
- "profileContactCompany": "Webform Wizards",
- "profileContactAddress": "Webform Wizard Ltd \nAddress 1 \nAddress 2",
- "profileContactPhone": "0123456789",
- "profileContactEmail": "1@2.abc",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "WEBFORMS COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 62
}
}
]
}
]
}
]
}
Executes a query to list all correspondence IDs by profile ID and status.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "Communications",
- "symbol": "com.bottomline.ddm.model.communication",
- "key": "com.bottomline.ddm.model.communication"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "profileId",
- "symbol": "com.bottomline.ddm.model.communication.Communication.profileId",
- "fieldType": "LONG",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "long",
- "$value": 4826
}
}, - {
- "@type": "QueryRelationship",
- "name": "AND",
- "description": "AND relationship.",
- "symbol": "AND"
}, - {
- "@type": "QueryParameter",
- "field": {
- "name": "status",
- "symbol": "com.bottomline.ddm.model.communication.Communication.status",
- "fieldType": "ENUM",
- "key": false
}, - "operator": {
- "symbol": "IN"
}, - "queryValue": [
- {
- "@type": "string",
- "$value": "CREATED"
}
]
}
]
}, - "resultFields": [
- {
- "name": "Communication",
- "symbol": "com.bottomline.ddm.model.communication.Communication",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "Communication",
- "symbol": "com.bottomline.ddm.model.communication.Communication",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 2173475,
- "type": "LOCAL_PRINT",
- "status": "CREATED",
- "contactId": 9278147,
- "profileId": 4826,
- "trigger": "NEW_MANDATE_NO_PLAN",
- "reference": "DOT.REFERENCE",
- "altReference": "TEST ALT REF2",
- "accountName": "DOT.ACCTNAME2",
- "accountNumber": "44444444",
- "sortCode": "555555",
- "sun": "100265",
- "title": "MR",
- "firstName": "New.firstName",
- "lastName": "New.lastName",
- "companyName": "New Co Name",
- "town": "Town Name",
- "contactAddressLines": [
- "123 ",
- "Street Name"
], - "code": "AB1 2CD",
- "county": "County Name",
- "country": "UK",
- "email": "NewfirstlastNames@b.com",
- "created": "2020-11-10T17:42:51.087",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Collection Profile Name",
- "profileContactCompany": "Collection Profile Company Name",
- "profileContactAddress": "Collection Profile Address\nAddress 1\nAddress 2\nCity\nPostcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "EXAMPLE COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "CommunicationDTO",
- "id": 2173474,
- "type": "LOCAL_PRINT",
- "status": "CREATED",
- "contactId": 9278147,
- "profileId": 4826,
- "trigger": "CANCEL_MANDATE",
- "reference": "DOT.REFERENCE2",
- "altReference": "TEST ALT REF2",
- "accountName": "DOT.ACCTNAME2",
- "accountNumber": "44444444",
- "sortCode": "555555",
- "sun": "100265",
- "title": "MR",
- "firstName": "New.firstName",
- "lastName": "New.lastName",
- "companyName": "New Co Name",
- "town": "Town Name",
- "contactAddressLines": [
- "123 ",
- "Street Name"
], - "code": "AB1 2CD",
- "county": "County Name",
- "country": "UK",
- "email": "NewfirstlastNames@b.com",
- "created": "2020-11-10T17:42:44.503",
- "mandateNoticePeriod": 10,
- "oneOffNoticePeriod": 10,
- "profileContactName": "Collection Profile Name",
- "profileContactCompany": "Collection Profile Company Name",
- "profileContactAddress": "Collection Profile Address\nAddress 1\nAddress 2\nCity\nPostcode",
- "profileContactPhone": "000111222333",
- "profileContactEmail": "a@b.com",
- "isAttachmentUsed": true,
- "salutation": "Dear",
- "profileName": "EXAMPLE COLLECTION PROFILE"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 2
}
}
]
}
]
}
]
}
The API allows you to import a DDM file, retrieve the result of manually importing a DDM payer or one off collection file, query the results using for example, status, file type and between two dates or file ID.
Imports a file containing contacts data into PTX DDM and updates associated mandates.
id required | integer <int64> Collection profile identifier. |
file required | string File name to import. |
curl -F 'file=@PAYER_FILE' https://uk.pt-x.com/payments-service/api/ddm/file/upload/4826/PAYER_FILE
{- "@type": "DdmFileUploadResponse",
}
Imports a DDM file for a one off collection.
id required | integer <int64> Collection profile identifier. |
file required | string File to import. |
curl -F 'file=@PAYER_FILE' https://uk.pt-x.com/payments-service/api/ddm/file/upload/4826/ONE_OFF_PAYMENTFILE
{- "@type": "DdmFileUploadResponse",
}
Retrieves the result of importing a DDM payment file.
id required | integer <int64> File identifier as generated by PTX, obtained from the URL when importing via the User Interface. |
curl -H "Content-Type: application/json" -X GET https://uk.pt-x.com/payments-service/api/ddm/file/9511
{- "ModelId": 9511,
- "name": "Test One Off Import Error.txt",
- "paymentProfileId": 4826,
- "paymentProfileName": "EXAMPLE COLLECTION PROFILE",
- "type": "ONE_OFF_PAYMENTFILE",
- "status": "SUCCESS",
- "userId": "JGX3FTUOQF1PPIDQTMLF",
- "created": "2020-05-02T16:26:06.556",
- "lastUpdated": "2020-05-02T16:26:07.804",
- "recordsProcessed": 4,
- "recordsImported": 3,
- "totalAccepted": 151200,
- "totalRejected": 0
}
Executes a query for import result details using file ID.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "FileUploadLogs",
- "symbol": "com.bottomline.ddm.model.fileupload.FileUploadLog",
- "key": "com.bottomline.ddm.model.fileupload.FileUploadLog"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "fileId",
- "symbol": "com.bottomline.ddm.model.fileupload.FileUploadLog.fileId",
- "fieldType": "LONG",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "long",
- "$value": 9511
}
}
]
}, - "resultFields": [
- {
- "name": "FileUploadLog",
- "symbol": "com.bottomline.ddm.model.fileupload.FileUploadLog",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "FileUploadLog",
- "symbol": "com.bottomline.ddm.model.fileupload.FileUploadLog",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "FileUploadLogDTO",
- "created": "2020-05-02T16:26:06.556",
- "modelId": 9511,
- "fileId": 9511,
- "lineNo": 1,
- "mandateReference": "Reference",
- "errorMessage": "Could not parse amount: Amount.",
- "status": "ERROR"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "FileUploadLogDTO",
- "created": "2020-05-02T16:26:07.619",
- "modelId": 4986465,
- "fileId": 9511,
- "lineNo": 2,
- "mandateReference": "TESTDDREF1",
- "errorMessage": "Due date was 2018-05-03, it has been updated to 2018-05-16.",
- "status": "WARNING"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "FileUploadLogDTO",
- "created": "2020-05-02T16:26:07.756",
- "modelId": 4986465,
- "fileId": 9511,
- "lineNo": 3,
- "mandateReference": "TESTDDREF1",
- "errorMessage": "Due date was 2018-05-03, it has been updated to 2018-05-16.",
- "status": "WARNING"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "FileUploadLogDTO",
- "created": "2020-05-02T16:26:07.781",
- "modelId": 4986467,
- "fileId": 9511,
- "lineNo": 4,
- "mandateReference": "TESTDDREF1",
- "errorMessage": "Due date was 2018-05-03, it has been updated to 2018-05-16.",
- "status": "WARNING"
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 4
}
}
]
}
]
}
]
}
Executes a query for import results using status, file type and between two dates, where file type is set to either ONE_OFF_PAYMENTFILE or PAYER_FILE.
The query to be executed.
required | object (QueryEntity) The entity in the query. |
object (QueryCriteria) The criteria of the query to be performed on the database. | |
required | Array of objects (QueryField) The field values to be returned as the query result. |
object (QueryResultsPage) The controller of the page size to be returned within the processed query. It is recommended that no more than 500 results are returned in a search. |
{- "entity": {
- "name": "FileUploads",
- "symbol": "com.bottomline.ddm.model.fileupload.FileUpload",
- "key": "com.bottomline.ddm.model.fileupload.FileUpload"
}, - "criteria": {
- "searchCriteria": [
- {
- "@type": "QueryParameter",
- "field": {
- "name": "type",
- "symbol": "com.bottomline.ddm.model.fileupload.FileUpload.type",
- "fieldType": "ENUM",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValues": [
- {
- "@type": "string",
- "$value": "ONE_OFF_PAYMENTFILE"
}
]
}, - {
- "@type": "QueryRelationship",
- "name": "AND",
- "description": "AND relationship.",
- "symbol": "AND"
}, - {
- "@type": "QueryParameter",
- "field": {
- "name": "status",
- "symbol": "com.bottomline.ddm.model.fileupload.FileUpload.status",
- "fieldType": "ENUM",
- "key": false
}, - "operator": {
- "symbol": "="
}, - "queryValue": {
- "@type": "string",
- "$value": "ERROR"
}
}, - {
- "@type": "QueryRelationship",
- "name": "AND",
- "description": "AND relationship.",
- "symbol": "AND"
}, - {
- "@type": "QueryParameter",
- "field": {
- "name": "created",
- "symbol": "com.bottomline.ddm.model.fileupload.FileUpload.created",
- "fieldType": "TIMESTAMP",
- "key": false
}, - "operator": {
- "symbol": "BETWEEN"
}, - "queryValues": [
- {
- "@type": "dateTime",
- "$value": "2020-05-01T00:00:00.000Z"
}, - {
- "@type": "dateTime",
- "$value": "2020-05-31T23:59:59.100Z"
}
]
}
]
}, - "resultFields": [
- {
- "name": "FileUpload",
- "symbol": "com.bottomline.ddm.model.fileupload.FileUpload",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "resultsPage": {
- "firstResult": 0,
- "maxResults": 50
}
}
{- "fields": [
- {
- "name": "FileUpload",
- "symbol": "com.bottomline.ddm.model.fileupload.FileUpload",
- "fieldType": "OBJECT",
- "key": false
}, - {
- "name": "rowCount",
- "symbol": "com.bottomline.query.count",
- "fieldType": "LONG",
- "key": false
}
], - "rows": [
- {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "FileUpload",
- "modelId": 9511,
- "name": "Test One Off Import Error.txt",
- "paymentProfileId": 4826,
- "paymentProfileName": "EXAMPLE COLLECTION PROFILE",
- "type": "ONE_OFF_PAYMENTFILE",
- "status": "ERROR",
- "userId": "JGX3FTUOQF1PPIDQTMLF",
- "created": "2020-05-02T16:26:06.556",
- "lastUpdated": "2020-05-02T16:26:07.804",
- "recordsProcessed": 4,
- "recordsImported": 3,
- "totalAccepted": 151200,
- "totalRejected": 0
}
}
]
}
]
}, - {
- "values": [
- {
- "resultValues": [
- {
- "value": {
- "@type": "long",
- "$value": 1
}
}
]
}
]
}
]
}
Returns a list of all current users.
realmid required | string Example: TEST Realm ID (obtained from Bottomline support) |
Search criteria
curl -H "Content-Type: application/json" -X POST https://uk.pt-x.com/payments-service/api/principal/user/TEST/search?maint=true
[- {
- "@type": "UserPrincipal",
- "name": "Test Test",
- "comment": "Approved",
- "identifier": {
- "realmKey": "TEST",
- "key": "5DNLJAY7WUDJJNPPUITF"
}, - "expiry": 9223372036854776000,
- "reason": "NONE",
- "attributes": {
- "statusCode": "AP",
- "lastName": "Test",
- "admin": "No",
- "firstName": "Test",
- "administrator": "false",
- "twoStepVerificationToken": "None",
- "status": "Approved",
- "email": "aTest@bottomlinetest.com",
- "role": "",
- "mfaMode": "NONE"
}
}, - {
- "@type": "UserPrincipal",
- "name": "Alex Jones",
- "comment": "Approved",
- "identifier": {
- "realmKey": "TEST",
- "key": "DEX8FTUOQF1JHIDQTMTH"
}, - "expiry": 9223372036854776000,
- "reason": "NONE",
- "attributes": {
- "statusCode": "AP",
- "lastName": "Jones",
- "admin": "Yes",
- "firstName": "Alex",
- "administrator": "true",
- "twoStepVerificationToken": "None",
- "status": "Approved",
- "email": "alex.jones@bottomline.com",
- "role": "Full",
- "mfaMode": "NONE"
}
}, - {
- "@type": "UserPrincipal",
- "name": "Joe_Irving",
- "comment": "Approved",
- "identifier": {
- "realmKey": "TEST",
- "key": "GBFVUHDBXVSJER1JZ4JD"
}, - "expiry": 9223372036854776000,
- "reason": "NONE",
- "attributes": {
- "statusCode": "AP",
- "lastName": "Irving",
- "admin": "Yes",
- "firstName": "Joe",
- "administrator": "true",
- "twoStepVerificationToken": "None",
- "status": "Approved",
- "email": "joe.irving@bottomline.com",
- "role": "Full",
- "mfaMode": "NONE"
}
}
]
Returns a list of all roles.
Identifier
realmKey | string Realm key (obtained from Bottomline support). |
curl -H "Content-Type: application/json" -X POST { "identifier":{ "realmKey":"TEST" } } https://uk.pt-x.com/payments-service/api/roles/providers/com.bottomline.banking.webseries.roles.provider.webseries/com.bottomline.banking.webseries.roles.provider.WebSeriesRolesProvider/getRolesForRealm
[- {
- "@type": "Role",
- "extensions": [
- {
- "@type": "WebSeriesRoleEntitlement",
- "id": "ROLE_ENTITLEMENT",
- "paymentRoleType": "ALL",
- "createPaymentProfileAllowed": false,
- "reportsAllowed": true,
- "viewAllowed": true,
- "createAllowed": true,
- "approveAllowed": true,
- "submitAllowed": true,
- "commitAllowed": true,
- "archiveAllowed": true,
- "approveOwnAllowed": true,
- "commitOwnAllowed": true,
- "submitOwnAllowed": false,
- "ddmAllowed": true,
- "ddmRoleType": "ALL",
- "allowAllProfiles": true,
- "oneOffInstructions": true,
- "oneOffRefund": true,
- "allowAllDdmProfiles": true,
- "viewDdmAllowed": true,
- "manageTemplatesAllowed": false,
- "selectTemplatesAllowed": false,
- "createCompanyAllowed": false,
- "editCompanyAllowed": false,
- "deleteCompanyAllowed": false,
- "disableCompanyAllowed": false,
- "viewCompanyAllowed": false,
- "riskAssessmentAllowed": true,
- "manageBlackListAllowed": true,
- "vSeriesEntitlementsAllowed": false,
- "creditCardsEntitlementsAllowed": false,
- "paymentsAllowed": true,
- "protectAllowed": true
}, - {
- "@type": "WebSeriesRoleChanges",
- "id": "ROLE_PENDINGCHANGES"
}
], - "name": "Full",
- "comment": "Full Permissions",
- "roleIdentifierImpl": {
- "identifierKey": "Full"
}, - "attributes": {
- "statusCode": "AP"
}
}, - {
- "@type": "Role",
- "extensions": [
- {
- "@type": "WebSeriesRoleEntitlement",
- "id": "ROLE_ENTITLEMENT",
- "paymentRoleType": "ALL",
- "createPaymentProfileAllowed": false,
- "reportsAllowed": true,
- "viewAllowed": true,
- "createAllowed": true,
- "approveAllowed": true,
- "submitAllowed": true,
- "commitAllowed": true,
- "archiveAllowed": true,
- "approveOwnAllowed": true,
- "commitOwnAllowed": true,
- "submitOwnAllowed": false,
- "ddmAllowed": false,
- "ddmRoleType": "ALL",
- "allowAllProfiles": true,
- "oneOffInstructions": false,
- "oneOffRefund": false,
- "allowAllDdmProfiles": false,
- "viewDdmAllowed": false,
- "manageTemplatesAllowed": false,
- "selectTemplatesAllowed": false,
- "createCompanyAllowed": false,
- "editCompanyAllowed": false,
- "deleteCompanyAllowed": false,
- "disableCompanyAllowed": false,
- "viewCompanyAllowed": false,
- "riskAssessmentAllowed": false,
- "manageBlackListAllowed": false,
- "vSeriesEntitlementsAllowed": false,
- "creditCardsEntitlementsAllowed": false,
- "paymentsAllowed": true,
- "protectAllowed": false
}, - {
- "@type": "WebSeriesRoleChanges",
- "id": "ROLE_PENDINGCHANGES"
}
], - "name": "PayOnly",
- "comment": "Payments Access Only",
- "roleIdentifierImpl": {
- "identifierKey": "PayOnly"
}, - "attributes": {
- "statusCode": "AP"
}
}
]