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

Get Boleto (Order Status API)

This is a Server-to-Server API that takes the Order Id as a path parameter and returns the order status along with other details. It retrieves the Boleto details, including the URL to download the Boleto PDF. The merchant can access and download the Boleto PDF using the links.status_link.url field in the API response.

Request

Response

API Endpoints

Sandbox Link

GET

https://api.sandbox.juspay.io/orders/{order_id}

Production Link

GET

https://api.juspay.io/orders/{order_id}

                      Basic Auth
                      *
                      

Base64 Encoded Username:Password

Required

Consists of two parts.

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

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      Content-Type
                      
                      

String

application/x-www-form-urlencoded

                      order_id
                      *
                      

String

Mandatory

Order Id of the order for which you want to check the status

                      options.add_full_gateway_response
                      
                      

Boolean

Optional

It accepts a Boolean value.
- Set it to true to receive the complete response from the gateway.

Response Body

                      customer_email
                      *
                      

String

Required

Example:- test_user_1073113977@testuser.com

                      customer_phone
                      *
                      

String

Required

Example:- 9999999999

                      customer_id
                      *
                      

String

Required

Example:- cth_7k9nF3UgPECQxcvb

                      status_id
                      *
                      

String

Required

Example:- 28

                      status
                      *
                      

String

Required

Example:- AUTHORIZING

id

String

Example:- ordeh_19445ea0a69c4b44ab82025568d72667

                      merchant_id
                      
                      

String

Example:- latamsbx

                      amount
                      
                      

String

Example:- 4

                      currency
                      
                      

String

Example:- BRL

                      order_id
                      
                      

String

Example:- ord1762763513

                      date_created
                      
                      

String

Example:- 2025-11-12T09:47:24Z

                      last_updated
                      
                      

String

Example:- 2025-11-12T09:47:27Z

                      return_url
                      
                      

String

                      product_id
                      
                      

String

                      payment_links
                      
                      

Object

                      mobile
                      
                      

String

Example:- https://payments.sandbox.juspay.io/payment-page/order/ordeh_19445ea0a69c4b44ab82025568d72667

web

String

Example:- https://payments.sandbox.juspay.io/payment-page/order/ordeh_19445ea0a69c4b44ab82025568d72667

                      iframe
                      
                      

String

Example:- https://payments.sandbox.juspay.io/payment-page/order/ordeh_19445ea0a69c4b44ab82025568d72667

                      udf1
                      
                      

String

                      udf2
                      
                      

String

                      udf3
                      
                      

String

                      udf4
                      
                      

String

                      udf5
                      
                      

String

                      udf6
                      
                      

String

                      udf7
                      
                      

String

                      udf8
                      
                      

String

                      udf9
                      
                      

String

                      udf10
                      
                      

String

                      txn_id
                      
                      

String

Example:- latamsbx-ord1762763513-1

                      payment_method_type
                      
                      

String

Example:- OTC

                      auth_type
                      
                      

String

                      payment_method
                      
                      

String

Example:- BOLETO

                      refunded
                      
                      

Boolean

Example:- false

                      amount_refunded
                      
                      

String

Example:- 0

                      effective_amount
                      
                      

String

Example:- 4

                      resp_code
                      
                      

                      resp_message
                      
                      

                      bank_error_code
                      
                      

String

                      bank_error_message
                      
                      

String

                      txn_uuid
                      
                      

String

Example:- moz2UWuHAFdpAmpDDVj

                      txn_detail
                      
                      

Object

                      txn_id
                      
                      

String

Example:- latamsbx-ord1762763513-1

                      order_id
                      
                      

String

Example:- ord1762763513

                      status
                      
                      

String

Example:- AUTHORIZING

                      error_code
                      
                      

                      net_amount
                      
                      

String

Example:- 4

                      surcharge_amount
                      
                      

                      tax_amount
                      
                      

                      txn_amount
                      
                      

String

Example:- 4

                      offer_deduction_amount
                      
                      

                      gateway_id
                      
                      

String

Example:- 1145

                      currency
                      
                      

String

Example:- BRL

                      express_checkout
                      
                      

Boolean

Example:- false

                      redirect
                      
                      

Boolean

Example:- false

                      txn_uuid
                      
                      

String

Example:- moz2UWuHAFdpAmpDDVj

                      gateway
                      
                      

String

Example:- MERCADOPAGO

                      error_message
                      
                      

String

                      created
                      
                      

String

Example:- 2025-11-12T09:47:24Z

                      last_updated
                      
                      

String

Example:- 2025-11-12T09:55:07Z

                      txn_amount_breakup
                      
                      

Array

                      payment_gateway_response
                      
                      

Object

                      resp_code
                      
                      

String

Example:- pending

rrn

                      created
                      
                      

String

Example:- 2025-11-12T09:47:25Z

                      epg_txn_id
                      
                      

String

Example:- 132908958257

                      resp_message
                      
                      

String

Example:- pending_waiting_payment

                      auth_id_code
                      
                      

                      txn_id
                      
                      

String

Example:- latamsbx-ord1762763513-1

                      network_error_message
                      
                      

                      network_error_code
                      
                      

arn

                      gateway_merchant_id
                      
                      

eci

                      auth_ref_num
                      
                      

                      umrn
                      
                      

                      current_blocked_amount
                      
                      

                      payer_ifsc
                      
                      

xid

                      cvv_check
                      
                      

                      gateway_id
                      
                      

String

Example:- 1145

                      emi_details
                      
                      

Object

                      bank
                      
                      

                      monthly_payment
                      
                      

                      interest
                      
                      

                      subvention_amount
                      
                      

                      conversion_details
                      
                      

                      principal_amount
                      
                      

                      additional_processing_fee_info
                      
                      

                      tenure
                      
                      

                      subvention_info
                      
                      

Array

                      emi_type
                      
                      

                      processed_by
                      
                      

                      links
                      
                      

Object

                      retarget_payment_links
                      
                      

Object

                      retarget_link
                      
                      

String

Example:- https://api.juspay.io/v2/pay/confirmation/:txnUuid/retarget

                      retarget_link_expiry
                      
                      

String

Example:- 2023-10-10T10:10:10Z

                      status_link
                      
                      

Object

url

String

Example:- https://api.juspay.io/v2/pay/confirmation/:txnUuid/status

                      method
                      
                      

String

Example:- GET

                      metadata
                      
                      

Object

                      JUSPAY:gateway_reference_id
                      
                      

String

Example:- mercadopago_pix_boleto_no3DS

                      payment_page_client_id
                      
                      

String

Example:- latamsbx

                      payment_links
                      
                      

Object

                      mobile
                      
                      

String

Example:- https://payments.sandbox.juspay.io/payment-page/order/ordeh_19445ea0a69c4b44ab82025568d72667

web

String

Example:- https://payments.sandbox.juspay.io/payment-page/order/ordeh_19445ea0a69c4b44ab82025568d72667

                      iframe
                      
                      

String

Example:- https://payments.sandbox.juspay.io/payment-page/order/ordeh_19445ea0a69c4b44ab82025568d72667

                      gateway_reference_id
                      
                      

String

Example:- mercadopago_pix_boleto_no3DS

                      offers
                      
                      

Array

                      additional_info
                      
                      

Object

                      resp_category
                      
                      

Response Body

                      status
                      
                      

String

error

                      error_message
                      *
                      

String

Mandatory

invalid_card_number

                      error_code
                      *
                      

String

Mandatory

invalid_request