Get Mandate Order Status

Similar to order status API. This API is used to fetch the status of a mandate.

StatusIDMeaning
NEW10Newly created order.
PENDING_VBV23Authentication is in progress. The customer has to approve the mandate through the PSP App of their choice.
CHARGED21Successful transaction. The subscription cost of the period has been charged.
AUTHENTICATION_FAILED26User did not complete authentication.
AUTHORIZATION_FAILED27User completed authentication, but the bank refused the transaction.
JUSPAY_DECLINED22User input is not accepted by the underlying PG.
AUTHORIZING28Transaction status is pending from bank.

Response Parameters:

Parameter

Type

Description

merchant_id

String

Unique identifier for the merchant.

order_id

String

Unique Identifier for the order.

id

String

Unique ID generated by Juspay for the given order.

customer_id

String

Customer Identifier against which a mandate should be created. This has to be unique for a customer

customer_email

String

Email address of the customer.

customer_phone

String

Mobile number or fixed line number of the customer.

product_id

String

An identifier for the product on the Lender side for which the payment is being done. This field is just echoed back in the response so that Lender can differentiate on their side.

status

String

Status of the order. If you receive “NEW”, then the order is successfully created.

See Appendix for status mapping.

status_id

Status ID is a numeric id corresponding to the status value.

amount

double

This is the amount that a customer will be charged in this transaction.

currency

String

ISO string of the currency.

refunded

Boolean

Boolean value that determines if the amount was refunded or not.

amount_refunded

String

The amount that was refunded

date_created

String

Date-time of mandate order creation

return_url

String

A fully qualified URL such as http://shop.merchant.com/ to which the customer will be redirected after payment completion.

udf1

String

udf2

String

udf3

String

udf4

String

udf5

String

udf6

String

udf7

String

udf8

String

udf9

String

udf10

String

payment_links

Object

Contains 3 strings that link to a Desktop optimized, Mobile optimized as well as iFrame checkout screen for the given order.

txn_id

String

Transaction ID

txn_uuid

String

Transaction UUID

gateway_id

Unique identifier for your preferred gateway.

bank_error_code

String

Bank Error Code

bank_error_message

String

Bank Error Message

payment_method_type

String

Payment method type used at the time of creating a mandate

payment_method

String

Payment method used at the time of creating a mandate

payer_vpa

String

Payer VPA used during setting up mandate

auth_type

String

Type of authentication used

Mandate Block

Field

Type

Description

mandate_id

String

Mandate id sent by Juspay after mandate creation

mandate_token

String

Mandate token sent by Juspay after mandate creation

mandate_status

String

Status of the Mandate. Will be ACTIVE if the mandate is successfully setup

mandate_type

String

Type of Mandate. Example: EMANDATE

start_date

String

Mandate start date. The value that is passed during order creation

end_date

String

Mandate end data.The value that is passed during order creation

revokable_by_customer

Boolean

Mandate revocable by customer

block_fund

String

Mandate block fund

max_amount

Number

Mandate max amount

amount_rule

String

Amount rule

frequency

String

Mandate frequency

rule_type

String

Rule Type

rule_value

String

Rule value

bank_details

Object

This block will be available for only for mandate_type = EMANDATE mandate flows

bank_details block

Filed

Type

Decription

beneficiary_name

String

Account holder name

account_number

String

Bank account number

bank_name

String

Bank name

ifsc

String

IFSC Code of the bank

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!