Close Batch

post

https://api-test.qualpay.com/pg/batchClose

Immediately closes the open batch of transactions. Use this request to control the timing of the batch close. By default, the once-daily automatic batch close is at 9 p.m. PST (U.S.), and this can be changed in the portal’s administration settings.

Note: This operation is only available to merchant accounts.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Payment Gateway Batch Close Request

merchant_id

int64

required

Format: Variable length, up to 12 N
Description: Unique identifier in our system.

developer_id

string

Format: Variable length, up to 32 AN
Description: Use to indicate which company developed the integration or the name of the payment solution that is connected to us. Suggested usage is softwareABCv1.0 or companyXYZv2.0.

echo_fields

string

Format: Variable length
Description: This field contains a JSON array of field data that will be echoed back in the response message.

loc_id

string

Format: Variable length, up to 4 N
Description: When a merchant has more than one location using the same currency, this value is used to specify the location for this request.

profile_id

string

Format: Fixed length, 20 N
Description: Explicitly identifies which Payment Gateway profile should be used for the request.

report_data

string

Format: Variable length
Description: This field contains a JSON array of field data that will be included with the transaction data reported in Merchant Manager.

session_id

string

INTERNAL USE ONLY.

tran_currency

int32

Format: Fixed length, 3 N
Default: 840
Description: The ISO numeric currency code for the transaction. This must be a currency code associated with one of your payment profiles; contact Qualpay to add currencies. Refer to Currency Codes for a list of currency codes.

user_id

int64

INTERNAL USE ONLY.

vendor_id

int64

Format: Fixed length, 10 N
Description: Identifies the vendor to which this request applies.
Conditional Requirement: This field is required for Qualpay partner accounts.

Responses

200Success

400Bad Request

401Unauthorized

402Declined

500Internal Server Error

509Timeout