API Reference
Login to SandboxCreate Account

Capture an Authorized Transaction

post
https://api-test.qualpay.com/pg/capture/

Captures an authorized transaction for any amount up to the amount originally authorized. An authorized transaction can only be captured once.

Note: Vendor accounts need special permissions to use this operation; contact Qualpay Support to enable it.

Path Params
string
required

Original transaction ID for the original authorization transaction, found as pg_id in the Authorize Transaction request response.

Body Params

Payment Gateway Capture Request

int64
required

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

double
required

Format: Variable length, up to 12,2 N
Description: Total amount to capture. The amount must be less than or equal to the authorized amount.

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.

string

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

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.

string

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

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.

string

INTERNAL USE ONLY.

int64

INTERNAL USE ONLY.

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

Updated 6 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago