eSIM de Viagem — API
Referência da APIPedidos

Criar pedido

Cria o pedido (status pending_activation), congela o preço e dispara o link de ativação. Não emite o eSIM.

POST
/v1/agencies/{agencyId}/orders
AuthorizationBearer <token>

Chave de API no formato ong_sk_...

In: header

Path Parameters

agencyId*unknown

Agência dentro do escopo da chave

Formatuuid

Header Parameters

Idempotency-Key?string

Torna o retry seguro (mesma chave → mesmo pedido).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/agencies/{agencyId}/orders" \  -H "Content-Type: application/json" \  -d '{    "planId": "b3f60ba2-c1fd-4b3a-a23d-8e876e0ef75d",    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",    "travelDate": "2026-08-01",    "usageProfile": "moderate"  }'
{  "id": "9b2e6c1a-4f83-4d2b-8a71-2c9e5f0a1b34",  "code": "PED-ALFA-260712-9F3A",  "status": "pending_activation",  "price": "149.90",  "currency": "BRL",  "travelDate": "2019-08-24",  "travelReturnDate": "2019-08-24",  "usageProfile": "moderate",  "activationUrl": "string",  "plan": {    "id": "9b2e6c1a-4f83-4d2b-8a71-2c9e5f0a1b34",    "name": "string",    "coverages": [      "string"    ],    "dataGb": "10.00",    "validityDays": 0  },  "customer": {    "id": "9b2e6c1a-4f83-4d2b-8a71-2c9e5f0a1b34",    "fullName": "string"  },  "esim": {    "iccid": "8944500012345678901",    "lpaString": "LPA:1$rsp.truphone.com$QRF-SPEEDY-12345",    "qrCodeUrl": "https://cdn.esimdeviagem.com.br/qrcodes/8944500012345678901.png",    "iosInstallLink": "string",    "androidInstallLink": "string",    "msisdn": "string",    "apn": "string"  },  "activatedAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z"}