JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Capture API

This will capture the transaction which is in the AUTHORIZED state.
We support both full-capture and partial-capture (up to the amount pre-authorized).

Partial Capture flow is currently supported only via CYBERSOURCE Gateway

On successful full capture, the transaction is marked CHARGED and the order status is also CHARGED.
On successful partial capture, the API accepts an additional amount and idempotence_key parameters. While the transactions remain CHARGED, the order status updates to PARTIAL_CHARGED.

Status Understanding:

Scroll inside to view more

Payment Gateway Response	Juspay Transaction Status
Success	CHARGED
Failed	CAPTURE_FAILED
Accepted and pending by gateway	CAPTURE_INITIATED
Timeout/ No response from gateway	AUTHORIZED

Request

Response

API Endpoints

Sandbox Link

POST

https://sandbox.juspay.in/v2/txns/{txn_uuid}/capture

Production Link

POST

https://api.juspay.in/v2/txns/{txn_uuid}/capture

                      Basic Auth
                      *
                      

Base64 Encoded Username:Password

Mandatory

Consists of two parts.

Username: API Key obtained from Juspay dashboard
Password: Empty string

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      x-routing-id
                      *
                      

String

Required

We recommend passing the customer_id as the x-routing-id. If the customer is checking out as a guest, you can pass an alternative ID that helps track the payment session lifecycle. For example, this could be an Order ID or Cart ID.

This ID is associated with the customer. It plays a key role in ensuring consistency and maintaining connections across different systems. If you fail to pass the same x-routing-id for the same customer in all related API calls, it could lead to issues with API functionality. Therefore, it’s crucial that you use the same x-routing-id for all requests tied to the same customer.

Example:- customer_1122

                      txn_uuid
                      *
                      

UUID

Mandatory

Transaction UUID

Example:- d64d1eff-551a-4e03-9858-b00b7cc36dae

                      amount
                      
                      

double

Amount to be captured

Body

                      amount
                      
                      

String

conditional

To be passed for Partial Capture Only.

                      idempotence_key
                      
                      

String

Conditional

To be passed for Partial Capture Only.

Special Characters Allowed -
Hyphen or Minus, Underscore, Left Parenthesis, Right Curly Brace, Plus Sign, Tilde, Left Curly Brace, Period, Dot, Right Parenthesis

Example:- A123_456

Response Body

                      json
                      
                      

Object

Response Body

                      status
                      
                      

string

Bad Request

                      error_message
                      
                      

string

Cannot capture charged transaction

                      error_code
                      
                      

string

Invalid

Response Body

                      status
                      
                      

string

error

                      error_code
                      
                      

string

access_denied

                      error_message
                      
                      

string

Invalid Authentication