Batch Payment Details

Get the details of a batch payment job.

GET https://<Platform-host>/api/payment/batch/sale/:id

Response

Response will return the list of transactions generated along with the status.

200

Field Definitions

Field Name	Type	Description	Required?
job_id	uuid	A unique job ID	Required
status	string	"completed", "in_progress" or "failed"	Required
completed	integer	Number of successful transactions in the batch	Required
errors	integer	Number of unsuccessful transactions in the batch	Required
batch_sale_result	array	Array of transactions. Refer our sale API response documentation for details on the sale response object	Required

Sample Response

Sample Request

curl '<API_HOST>/api/payment/batch/sale/123'
-H 'Authorization: Basic <API_KEY>'

Sample Response

Example Response

{
    "job_id": "7be612f5-dcdc-4958-8577-c0f8c4e1891a",
    "status": "completed",
    "completed": 2,
    "errors": 0,
    "batch_sale_result": [
        {
            "id": "8612f3dc-de3c-4809-ad2d-f1ceade63624",
            "transaction_id": "6ef14e05-bc1d-4a47-80c1-f1a9b3ab6648",
            "merchant_id": "05119016-4967-4ac2-9d27-dc74e5dfce62",
            "three_ds_action_required": false,
            "internal_transaction_id": "001",
            "sale_response": {
                "status": "PASS",
                "response_code": "A0000",
                "response_message": "Success",
                "auth_code": "602944",
                "host_response_code": "00",
                "host_reference_number": "274992681842",
                "task_id": "57662577",
                "transaction_id": "79766557",
                "transaction_timestamp": "2025-02-24T21:55:44",
                "transaction_amount": "100.00",
                "processed_amount": "100.00",
                "total_amount": "100.00",
                "address_verification_code": "X",
                "card_holder_verification_code": "N",
                "card_type": "visa",
                "masked_card_number": "4242",
                "customer_receipt": "PRINTABLE RECEIPT",
                "merchant_receipt": "PRINTABLE RECEIPT",
                "partial_payment": false
            },
            "description": "Description of transaction",
            "metadata": {
                "payer_id": "payer345",
                "payer_email": "[email protected]"
            }
        },
        {
            "id": "312f3ac1-c16d-4417-9643-d60e062c049b",
            "transaction_id": "fbb8c1bc-5e6a-4335-81bc-1f163bafa3aa",
            "merchant_id": "05119016-4967-4ac2-9d27-dc74e5dfce62",
            "three_ds_action_required": false,
            "internal_transaction_id": "002",
            "sale_response": {
                "status": "PASS",
                "response_code": "A0000",
                "response_message": "Success",
                "auth_code": "585338",
                "host_response_code": "00",
                "host_reference_number": "651920993620",
                "task_id": "55825579",
                "transaction_id": "23282816",
                "transaction_timestamp": "2025-02-24T21:55:44",
                "transaction_amount": "100.00",
                "processed_amount": "100.00",
                "total_amount": "100.00",
                "address_verification_code": "X",
                "card_holder_verification_code": "N",
                "card_type": "visa",
                "masked_card_number": "4242",
                "customer_receipt": "PRINTABLE RECEIPT",
                "merchant_receipt": "PRINTABLE RECEIPT",
                "partial_payment": false
            },
            "description": ""
        }
    ]
}