Batch Management

Get Batch Instructions ReportDeprecated

Role Requirements

tenant-transaction-read or tenant-admin

Description

Get a report of the instructions in a completed batch.

Securitybearer
Request
path Parameters
batchRef
required
string <= 100 characters ^[a-zA-Z0-9-_\.]+$

A unique batch reference.

header Parameters
x-account-id
required
string <uuid> = 36 characters

The Account Id (lowercase and hyphenated).

Example: 1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id
required
string <uuid> = 36 characters

The Tenant Id (lowercase and hyphenated).

Example: ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id
string

Correlation Id for the request.

Responses
200

Batch Instructions Report

400

Bad Request

get/v2/order-management/instruction-batch/{batchRef}/report
Request samples 
Response samples 
text/csv
A sample batch report in CSV format


orderRef,instructionRef,customerRef,status,failureReason
ORDER001,INST001,CUST001,Created,
ORDER002,INST002,CUST001,Created,
ORDER003,INST003,CUST001,Created,
ORDER004,INST004,CUST001,Failed,Instruction already exists.
ORDER005,INST005,CUST001,Created,

Upload a batch of instructions
Role Requirements


tenant-transaction-write or tenant-admin


Description


Upload a batch of instructions.


Securitybearer 
Request 
path Parameters
batchRef
required
string  <= 100 characters ^[a-zA-Z0-9-_\.]+$
A unique batch reference.


 
header Parameters
x-account-id
required
string <uuid>   = 36 characters 
The Account Id (lowercase and hyphenated).


 
 Example:  1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id
required
string <uuid>   = 36 characters 
The Tenant Id (lowercase and hyphenated).


 
 Example:  ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id
string
Correlation Id for the request.


 
Request Body schema: multipart/form-data
The batch of instructions to upload that are ready for scheduling


file
string <binary> 
The file containing the batch of ready to schedule instructions.


The file should be a CSV of instructions, up to 10,000 instructions, where each instruction is an object with the following properties:


    

  • orderRef (required, string, <= 50 characters, ^[a-zA-Z0-9-_\.]+$): A unique reference for the order
    • 

  • instructionRef (required, string, <= 50 characters, ^[a-zA-Z0-9-_\.]+$): A unique reference for the instruction within the order
    • 

  • customerRef (required, string, <= 50 characters, ^[a-zA-Z0-9-_\.]+$): A reference for the customer
    • 

  • direction (required, string, DEBIT|CREDIT): The direction of the instruction
    • 

  • financialInstrumentId (GUID): The ID of the financial instrument
    • 

  • amount (required, string): The amount of the instruction
    • 

  • currency (required, string, 3 characters): The ISO 4217 currency code of the instruction
    • 

  • country (required, string, 2 characters): The ISO 3166-1 alpha-2 country code of the instruction
    • 

  • settledByDate (required, date): The date by which the instruction should be settled
    • 

  • schemeId (String, 32 characters): The ID of the scheme
    • 

  • metadata.* (string, up to 10 keys): Additional metadata for the instruction. Keys have a max length of 64 characters. Values have a max length of 256 characters.
    • 



NOTE: If you are considering using metadata, please talk to us first to ensure that the metadata you are considering is appropriate and being used efficiently.


File example:


orderRef,instructionRef,customerRef,direction,financialInstrumentId,amount,currency,country,settledByDate,schemeId,metadata.category,metadata.priority
ORDER001,INST001,CUST001,DEBIT,4dc3291b-271d-4610-adb3-29716e2ff00b,100.50,GBP,GB,2025-02-19,4D5768FA897089DC2AAEDC0EBE6F46E2,Utility,Basic
ORDER002,INST002,CUST002,DEBIT,25bf4e87-2a72-4f79-86be-de32f4594a32,200.75,GBP,GB,2025-02-20,4D5768FA897089DC2AAEDC0EBE6F46E2,Personal,Plus
ORDER003,INST003,CUST003,DEBIT,16c064b7-ab4d-4d37-8396-d2fb15d489e7,300.80,GBP,GB,2025-02-21,4D5768FA897089DC2AAEDC0EBE6F46E2,,Basic
ORDER004,INST004,CUST004,DEBIT,8ccfd0c2-3801-4714-a046-ab900c22e01e,400.95,GBP,GB,2025-02-22,4D5768FA897089DC2AAEDC0EBE6F46E2,,
ORDER005,INST005,CUST005,DEBIT,420069eb-4432-4d4c-b4d3-5f0b465672ae,500.10,GBP,GB,2025-02-23,4D5768FA897089DC2AAEDC0EBE6F46E2,Utility,



 
Responses 
201
Batch uploaded


400
Bad Request


post/v2/order-management/instruction-batch/{batchRef}
Request samples 
Response samples 
application/json
{
  • "batchRef": "string",
  • "totalInstructions": 0
}
Get details of a batchDeprecated
Role Requirements


tenant-transaction-read or tenant-admin


Description


Get the details of a given batch.


Deprecated


Please use /v2/batch-management/batch/{batchRef}.


Securitybearer 
Request 
path Parameters
batchRef
required
string  <= 100 characters ^[a-zA-Z0-9-_\.]+$
A unique batch reference.


 
header Parameters
x-account-id
required
string <uuid>   = 36 characters 
The Account Id (lowercase and hyphenated).


 
 Example:  1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id
required
string <uuid>   = 36 characters 
The Tenant Id (lowercase and hyphenated).


 
 Example:  ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id
string
Correlation Id for the request.


 
Responses 
200
OK - Returns batch details


400
Bad Request


get/v2/order-management/instruction-batch/{batchRef}
Request samples 
Response samples 
application/json
Batch has been processed


{
  • "batchRef": "batch123",
  • "uploadedAt": "2025-03-04T15:00:00.000Z",
  • "status": "Processed",
  • "completedAt": "2025-03-04T17:30:00.000Z",
  • "instructionCount": 10000,
  • "instructionsCreated": 9321,
  • "instructionsFailed": 679
}
Upload a batch of reimbursements
Role Requirements


tenant-transaction-write or tenant-admin


Description


Upload a batch of reimbursements.


Securitybearer 
Request 
path Parameters
batchRef
required
string  <= 100 characters ^[a-zA-Z0-9-_\.]+$
A unique batch reference.


 
header Parameters
x-account-id
required
string <uuid>   = 36 characters 
The Account Id (lowercase and hyphenated).


 
 Example:  1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id
required
string <uuid>   = 36 characters 
The Tenant Id (lowercase and hyphenated).


 
 Example:  ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id
string
Correlation Id for the request.


 
Request Body schema: multipart/form-data
The batch of reimbursements to upload


file
string <binary> 
The file containing the batch reimbursements.


The file should be a CSV of reimbursements, up to 10,000 rows, where each reimbursement is a row with the following properties:


    

  • orderRef (required, string, <= 50 characters, ^[a-zA-Z0-9-_\.]+$): A unique reference for the order
    • 

  • instructionRef (required, string, <= 50 characters, ^[a-zA-Z0-9-_\.]+$): A unique reference for the instruction within the order
    • 

  • reimbursementRef (optional, string, <= 50 characters, ^[a-zA-Z0-9-_\.]+$): A unique reference for the reimbursement for an instruction
    • 

  • amount (required, string): The amount of the instruction
    • 

  • reason (optional, string, <= 100 characters): A reason for the reimbursement
    • 



File example:


orderRef,instructionRef,reimbursementRef,amount,reason
ORDER001,INST001,REIMBURSE001,100.50,"Product defect or damage"
ORDER002,INST002,,200.75,
ORDER003,INST003,REIMBURSE003,300.80,"Item not as described"
ORDER004,INST004,REIMBURSE004,400.95,"Expired or perishable item"
ORDER005,INST005,,500.10,"Overcharge or billing error"



 
Responses 
201
Batch uploaded


400
Bad Request


post/v2/order-management/reimbursement-batch/{batchRef}
Request samples 
Response samples 
application/json
{
  • "batchRef": "string",
  • "itemCount": 0
}
Get details of a batch
Role Requirements


tenant-transaction-read or tenant-admin


Description


Get the details of a given batch.


Securitybearer 
Request 
path Parameters
batchRef
required
string  <= 100 characters ^[a-zA-Z0-9-_\.]+$
A unique batch reference.


 
header Parameters
x-account-id
required
string <uuid>   = 36 characters 
The Account Id (lowercase and hyphenated).


 
 Example:  1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id
required
string <uuid>   = 36 characters 
The Tenant Id (lowercase and hyphenated).


 
 Example:  ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id
string
Correlation Id for the request.


 
Responses 
200
OK - Returns batch details


400
Bad Request


get/v2/batch-management/batch/{batchRef}
Request samples 
Response samples 
application/json
Batch has been processed


{
  • "batchRef": "batch123",
  • "batchType": "Instruction",
  • "uploadedAt": "2025-03-04T15:00:00.000Z",
  • "status": "Processed",
  • "completedAt": "2025-03-04T17:30:00.000Z",
  • "itemCount": 10000,
  • "itemsCreated": 9321,
  • "itemsFailed": 679
}
Get Batch Report
Role Requirements


tenant-transaction-read or tenant-admin


Description


Get a report of the import of a batch file


Securitybearer 
Request 
path Parameters
batchRef
required
string  <= 100 characters ^[a-zA-Z0-9-_\.]+$
A unique batch reference.


 
header Parameters
x-account-id
required
string <uuid>   = 36 characters 
The Account Id (lowercase and hyphenated).


 
 Example:  1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id
required
string <uuid>   = 36 characters 
The Tenant Id (lowercase and hyphenated).


 
 Example:  ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id
string
Correlation Id for the request.


 
Responses 
200
Batch Report


400
Bad Request


get/v2/batch-management/report/{batchRef}
Request samples 
Response samples 
text/csv
A sample batch report in CSV format


orderRef,instructionRef,customerRef,status,failureReason
ORDER001,INST001,CUST001,Created,
ORDER002,INST002,CUST001,Created,
ORDER003,INST003,CUST001,Created,
ORDER004,INST004,CUST001,Failed,Instruction already exists.
ORDER005,INST005,CUST001,Created,

Copyright 2025 Duck Creek Technologies. All Rights Reserved.