Relay - Retrieve

Retrieve a Relay by its ID.

Request

cURL

curl --request GET \
  --url https://sandbox.hyperswitch.io/relay/{relay_id} \
  --header 'X-Profile-Id: <x-profile-id>' \
  --header 'api-key: <api-key>'

Endpoint

GET /relay/{relay_id}

Headers

• X-Profile-Id (string, required) — Profile ID for authentication

• api-key (string, required, header) — Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Keep your API key secret. Do not expose it in client-side code or public repositories.

Path Parameters

• relay_id (string, required) — The unique identifier for the Relay

Example Response (200)

application/json

{
  "id": "relay_mbabizu24mvu3mela5njyhpit4",
  "status": "created",
  "connector_resource_id": "pi_3MKEivSFNglxLpam0ZaL98q9",
  "connector_id": "mca_5apGeP94tMts6rg3U3kR",
  "profile_id": "pro_abcdefghijklmnopqrstuvwxyz",
  "type": "refund",
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "connector_reference_id": "re_3QY4TnEOqOywnAIx1Mm1p7GQ",
  "data": {
    "refund": {
      "amount": 6540,
      "currency": "AED",
      "reason": "Customer returned the product"
    }
  }
}

Response Schema (200 — Relay Retrieved)

• id (string, required) The unique identifier for the Relay. Example: "relay_mbabizu24mvu3mela5njyhpit4"

• status (enum, required) Available options: created, pending, success, failure

• connector_resource_id (string, required) The identifier associated to a resource at the connector reference to which the relay request is being made. Example: "pi_3MKEivSFNglxLpam0ZaL98q9"

• connector_id (string, required) Identifier of the connector (merchant connector account) which was chosen to make the payment. Example: "mca_5apGeP94tMts6rg3U3kR"

• profile_id (string, required) The business profile associated with this relay request. Example: "pro_abcdefghijklmnopqrstuvwxyz"

• type (enum, required) Available options: refund

• error (object) Object containing error details (if any). Child attributes:

  • code (string)

  • message (string)

• connector_reference_id (string | null) The identifier associated to a resource at the connector to which the relay request is being made. Example: "re_3QY4TnEOqOywnAIx1Mm1p7GQ"

• data (object) Object containing payload data related to the relay. Example includes a refund object:

  • data.refund.amount (number)

  • data.refund.currency (string)

  • data.refund.reason (string)

Links

• Documentation: https://api-reference.hyperswitch.io/introduction

• Edit this page: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/relay/relay--retrieve.mdx

• Raise an issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/relay/relay--retrieve

• Related: Relay - Create — https://api-reference.hyperswitch.io/v1/relay/relay

• Related schema: Outgoing webhook — https://api-reference.hyperswitch.io/v1/schemas/outgoing--webhook