BatchProcessingApi.md

Citypay Api Client.BatchProcessingApi

All URIs are relative to https://api.citypay.com

Method	HTTP request	Description
batchProcessRequest	POST /v6/batch/process	Batch Process Request
batchRetrieveRequest	POST /v6/batch/retrieve	Batch Retrieve Request
checkBatchStatusRequest	POST /v6/batch/status	Check Batch Status

batchProcessRequest

ProcessBatchResponse batchProcessRequest(process_batch_request)

Batch Process Request

A batch process request is used to start the batch process workflow by uploading batch data and initialising a new batch for processing. Once validated the batch will be queued for processing and further updates can be received by a subsequent call to retrieve the batch status.

Example

import CityPay from 'citypay-api';
let client = new CityPay.ApiClient({
    "sandbox": true,
    "client_id": process.env.CP_CLIENT_ID,
    "licence_key": process.env.CP_LICENCE_KEY
})

let apiInstance = new CityPay.BatchProcessingApi();
let process_batch_request = new CityPay.ProcessBatchRequest(); // ProcessBatchRequest | 
apiInstance.batchProcessRequest(process_batch_request).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
process_batch_request	ProcessBatchRequest

Return type

ProcessBatchResponse

Authorization

cp-api-key

HTTP request headers

• Content-Type: application/json, text/xml
• Accept: application/json, text/xml

batchRetrieveRequest

BatchReportResponseModel batchRetrieveRequest(batch_report_request)

Batch Retrieve Request

Obtains a batch and installment (BIS) report for a given batch id.

Example

import CityPay from 'citypay-api';
let client = new CityPay.ApiClient({
    "sandbox": true,
    "client_id": process.env.CP_CLIENT_ID,
    "licence_key": process.env.CP_LICENCE_KEY
})

let apiInstance = new CityPay.BatchProcessingApi();
let batch_report_request = new CityPay.BatchReportRequest(); // BatchReportRequest | 
apiInstance.batchRetrieveRequest(batch_report_request).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
batch_report_request	BatchReportRequest

Return type

BatchReportResponseModel

Authorization

cp-api-key

HTTP request headers

• Content-Type: application/json, text/xml
• Accept: application/json, text/xml

checkBatchStatusRequest

CheckBatchStatusResponse checkBatchStatusRequest(check_batch_status)

Check Batch Status

The operation is used to retrieve the status of a batch process.

Example

import CityPay from 'citypay-api';
let client = new CityPay.ApiClient({
    "sandbox": true,
    "client_id": process.env.CP_CLIENT_ID,
    "licence_key": process.env.CP_LICENCE_KEY
})

let apiInstance = new CityPay.BatchProcessingApi();
let check_batch_status = new CityPay.CheckBatchStatus(); // CheckBatchStatus | 
apiInstance.checkBatchStatusRequest(check_batch_status).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
check_batch_status	CheckBatchStatus

Return type

CheckBatchStatusResponse

Authorization

cp-api-key

HTTP request headers

• Content-Type: application/json, text/xml
• Accept: application/json, text/xml