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

Capture API

This API captures a transaction in the AUTHORIZED state, transferring the authorized amount from the customer’s account to the merchant's account.

Partial capture of the authorized transaction amount is supported, provided the underlying gateway/processor also supports this functionality.
If amount parameter is not specified in the capture API request, the full authorized amount will be processed for Capture API.

Status Understanding:

Scroll inside to view more

Payment Gateway Response	Juspay Transaction Status	Description
Success	CHARGED	The Capture API was initiated, and the capture transaction was successfully completed.
Failed	CAPTURE_FAILED	The Capture API was initiated, but the capture transaction failed.
Accepted and pending by gateway	CAPTURE_INITIATED	The Capture API was initiated from Juspay and request pending at the gateway's end.
Timeout/ No response from gateway	AUTHORIZED	The Capture API request was initiated from Juspay, but the request got timed out, or no response was received from the gateway.

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-merchantid
                      
                      

String

Recommended

Unique identifier for the merchant. This is the Merchant ID provided by Juspay. The value is case sensitive.

Passing this value will help us route efficiently at network level.

Example:- x-merchantid: testaccount

                      txn_uuid
                      
                      

String

Max Length :128

The unique id generated by Juspay for a particular transaction. Can be used as an identifier in case of RTP transaction

                      amount
                      
                      

Double

Conditional

amount parameter is required only incase of partial capture transactions.

Amount that has to be captured from the total authorized amount. Will accept stringified double or integer values with upto two decimal places. For example, "100.15" and "100" are valid input but "100.1532" is not valid.

Response Body

                      udf1 - udf10
                      
                      

String

UDFs passed during order creation will be received

                      txn_uuid
                      
                      

String

The unique id generated by Juspay for a particular transaction. Can be used as an identifier in case of UPI transaction. Its txn_uuid apssed in the capture request.

Example:- Sample Response:euld46jp7R1jE3tB8ss

                      txn_id
                      
                      

String

Transaction ID of specified txn_uuid

Example:- sample response: merchant_id-order_id-1

                      status_id
                      
                      

Number

Status ID of the transaction

Example:- sample response: 21

                      status
                      
                      

String

Status of the capture transaction

Example:- sample response:CHARGED

                      return_url
                      
                      

String

Redirectional URL once the transaction is completed.URL passed in the request will be received

Example:- sample response:https://api.juspay.in

                      refunded
                      
                      

Boolean

Denotes whether transaction is refunded or not

Example:- sample response:false

                      payment_method_type
                      
                      

String

payment method type of transaction

Example:- sample response:CARD

                      payment_method
                      
                      

String

payment method of transaction

Example:- sample response:MASTERCARD

                      payment_gateway_response
                      
                      

JSON

Refers to response received from the gateway

                      txn_id
                      
                      

String

Transaction ID of specified txn_uuid

Example:- sample response:merchant_id-order_id-1

rrn

String

RRN provided by bank for tracking status

                      resp_message
                      
                      

String

Denotes the response received from gateway

Example:- sample response:Capture successful

                      resp_code
                      
                      

String

denotes response code of the transaction

Example:- sample response:SUCCESS

                      epg_txn_id
                      
                      

String

Transaction id created at the capture transaction processed gateway

Example:- sample response:14326152

                      created
                      
                      

String

Denotes the status updation time

Example:- sample response:2019-03-01T08:34:40Z

                      order_id
                      
                      

String

Order ID of the transaction

Example:- 92348923409

                      currency
                      
                      

String

Currency of the processed transaction

Example:- sample response:SGD

                      card
                      
                      

JSON

Card details passed in the transaction request

                      bank_error_message
                      
                      

String

Error message in case of transaction failure

Example:- sample response:PRE_AUTH|Transaction Successful | Approved

                      bank_error_code
                      
                      

String

error code for the transaction failure

Example:- sample response:SUCCESS

                      auth_type
                      
                      

String

Type of transaction.

Example:- sample response:THREE_DS

                      amount
                      
                      

Number

Transaction amount

Example:- sample response:10

Response Body

                      error_message
                      
                      

String

Provides the reason for the error

Example:- sample Response:Cannot Capture AUTHENTICATION_FAILED Transaction

                      status
                      
                      

String

Error status

Example:- Response: Bad Request

                      error_code
                      
                      

String

Specifies the Error code

Example:- Sample Response: Invalid

                      error_info
                      
                      

JSON

Additional information on the error message

                      user_message
                      
                      

String

Error message can be displayed to the user

Example:- sample response: Invalid request params. Please verify your input.

                      developer_message
                      
                      

String

Detailed info on the error

Example:- sample response: Cannot Capture AUTHENTICATION_FAILED Transaction

                      category
                      
                      

String

category of the error

Example:- sample response: USER_ERROR

Response Body

                      status
                      
                      

string

error

                      error_code
                      
                      

string

access_denied

                      error_message
                      
                      

string

Invalid Authentication

Error Codes

Scroll inside to view more

Scenario	Error Codes	Description	Sample Error Message
Performing Capture on AUTHENTICATION_FAILED transaction	400	Bad Request	{"error_message":"Cannot Capture AUTHENTICATION_FAILED Transaction","status":"Bad Request","error_code":"Invalid","error_info":{"user_message":"Invalid request params. Please verify your input.","developer_message":"Cannot Capture AUTHENTICATION_FAILED Transaction","code":"INVALID_INPUT","category":"USER_ERROR"}}
Performing Capture on Voided transaction	400	Bad Request	{"error_message":"Cannot Capture VOIDED Transaction","status":"Bad Request","error_code":"Invalid","error_info":{"user_message":"Invalid request params. Please verify your input.","developer_message":"Cannot Capture VOIDED Transaction","code":"INVALID_INPUT","category":"USER_ERROR"}}
Performing Capture on Charged transaction	400	Bad Request	{"error_message":"Cannot Capture CHARGED Transaction","status":"Bad Request","error_code":"Invalid","error_info":{"user_message":"Invalid request params. Please verify your input.","developer_message":"Cannot Capture CHARGED Transaction","code":"INVALID_INPUT","category":"USER_ERROR"}}
Passing Invalid txn_uuid in capture API request	400	Bad Request	{"status":"NOT_FOUND","error_info":{"user_message":"Cannot process your request as txn not found.","developer_message":"Txn not found.","code":"RESOURCE_NOT_FOUND","category":"USER_ERROR"},"status_id":40}
Passing orders in place of txns in capture curl	404	Not Found
Performing Capture on transaction which is in 'PENDING' status	400	Bad Request	{"error_message":"Cannot Capture PENDING_VBV Transaction","status":"Bad Request","error_code":"Invalid","error_info":{"user_message":"Invalid request params. Please verify your input.","developer_message":"Cannot Capture PENDING_VBV Transaction","code":"INVALID_INPUT","category":"USER_ERROR"}}

Have questions?
Need help? Contact support
LLM? Read llms.txt