Teleport Routes by Entity

GET

/api/v1/transformer/teleport/entity/{entityId}

Lists all teleport routes configured for a specific entity.
Returns all automated payment routes including their status, source, and destination information.

Request

Authorization

API Key

Add parameter in header

X-API-Token

Example:

X-API-Token: ********************

Path Params

Responses

🟢200OK

application/json

Teleport routes retrieved successfully

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/v1/transformer/teleport/entity/' \
--header 'X-API-Token: <api-key>'

Response Example

{
    "success": true,
    "data": {
        "message": "Teleport routes fetched successfully",
        "data": {
            "entityId": "entity_41db27c3_6994_4be4_b7bc_d38c04af8e5d",
            "totalRoutes": 1,
            "routes": [
                {
                    "routeId": "teleport_8b118472_1a0b_40b5_aa1b_0792f4df69b4",
                    "fundingAccountId": "fa_56b56fa7_5b96_4aff_97f1_cfd2a776d576",
                    "externalAccountId": "acc_f7ad60cb_3d8a_499d_b1fe_0a3c759fe22e",
                    "sourceJurisdiction": {
                        "id": "jurisdiction_8eeecfd0_2944_46f4_b7f3_ae4cd7b41f41",
                        "name": "United States",
                        "currency": "USD",
                        "type": "country"
                    },
                    "destinationJurisdiction": {
                        "id": "jurisdiction_39fcac47_15b5_4fd0_af4d_3ea46b41fbf7",
                        "name": "Brazil",
                        "currency": "BRL",
                        "type": "country"
                    },
                    "routeStatus": "inactive"
                }
            ]
        }
    }
}

Modified at 2025-11-15 17:07:56

Teleport Details