Relay

Relay - Retrieve

Retrieves a relay details.

get/relay/{relay_id}

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or API key in header api-key
TypeScript
https://skmtc.dev/hyperswitch/apis/dynamic-routing-openapi-3-0/docs/relay/:relay_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

relay_idstring required

The unique identifier for the Relay

Headers

X-Profile-Idstring required

Profile ID for authentication

Response

Relay Retrieved

idstring required

The unique identifier for the Relay

status'created' | 'pending' | 'success' | 'failure' required

connector_resource_idstring required

The identifier that is associated to a resource at the connector reference to which the relay request is being made

connector_reference_idstring nullable

The identifier that is associated to a resource at the connector to which the relay request is being made

connector_idstring required

Identifier of the connector ( merchant connector account ) which was chosen to make the payment

profile_idstring required

The business profile that is associated with this relay request.

type'refund' | 'capture' | 'incremental_authorization' | 'void' | 'unreferenced_refund' required

Example response

{
  "id": "relay_mbabizu24mvu3mela5njyhpit4",
  "connector_resource_id": "pi_3MKEivSFNglxLpam0ZaL98q9",
  "connector_reference_id": "re_3QY4TnEOqOywnAIx1Mm1p7GQ",
  "connector_id": "mca_5apGeP94tMts6rg3U3kR",
  "profile_id": "pro_abcdefghijklmnopqrstuvwxyz",
  "data": {
    "refund": {
      "amount": 6540,
      "reason": "Customer returned the product"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.