Webhooks
Retrieve a webhook event
GET
/
v1
/
webhooks
/
events
/
{id}
Node.js SDK
import { Useroutr } from "@useroutr/sdk";
const useroutr = new Useroutr({ apiKey: process.env.USEROUTR_API_KEY });
const event = await useroutr.webhooks.events.retrieve("evt_0d5e8c26");curl -X GET "https://api.sandbox.useroutr.com/v1/webhooks/events/evt_0d5e8c26" \
-H "Authorization: Bearer $USEROUTR_API_KEY"{
"id": "<string>",
"object": "event",
"api_version": "1",
"application_id": "<string>",
"funding_intent_id": "<string>",
"created_at": "<string>",
"type": "funding.created",
"data": {
"object": {
"id": "<string>",
"object": "funding_intent",
"application_id": "<string>",
"requirement": {
"amount": "<string>",
"asset": "<string>"
},
"destination": {
"network": "<string>",
"asset": "<string>",
"address": "<string>"
},
"source": {
"network": "<string>",
"asset": "<string>",
"amount": "<string>"
},
"quote": {
"id": "<string>",
"object": "quote",
"funding_intent_id": "<string>",
"application_id": "<string>",
"type": "EXACT_INPUT",
"status": "ACTIVE",
"stellar_network": "testnet",
"source": {
"network": "<string>",
"asset": "<string>",
"amount": "<string>",
"expected_amount": "<string>"
},
"destination": {
"network": "<string>",
"asset": "<string>",
"address": "<string>",
"amount": "<string>",
"minimum_amount": "<string>"
},
"route": {
"type": "DIRECT_STELLAR",
"provider": "<string>",
"steps": [
{
"type": "<string>",
"provider": "<string>",
"source_asset": "<string>",
"destination_asset": "<string>"
}
],
"estimated_duration_seconds": 0,
"confidence": 0,
"price_impact_bps": 0,
"score": "<string>"
},
"fees": {
"items": [
{
"type": "NETWORK",
"asset": "<string>",
"amount": "<string>"
}
],
"total": "<string>"
},
"exchange_rate": "<string>",
"slippage_bps": 0,
"execution": {
"id": "<string>",
"object": "route_execution",
"quote_id": "<string>",
"funding_intent_id": "<string>",
"provider": "<string>",
"route_type": "DIRECT_STELLAR",
"status": "PENDING",
"phase": "CREATED",
"provider_execution_id": "<string>",
"transaction_hashes": [
"<string>"
],
"failure": {
"code": "<string>",
"message": "<string>"
},
"started_at": "<string>",
"completed_at": "<string>"
},
"failure": {
"code": "<string>",
"message": "<string>"
},
"expires_at": "<string>",
"lock_expires_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
},
"route": {
"type": "DIRECT_STELLAR",
"provider": "<string>"
},
"status": "CREATED",
"received_amount": "<string>",
"deposit_account": {
"id": "<string>",
"object": "deposit_account",
"network": "stellar",
"address": "<string>",
"asset": "<string>",
"status": "PROVISIONING",
"created_at": "<string>",
"activated_at": "<string>",
"retired_at": "<string>"
},
"reference": "<string>",
"metadata": {},
"protocol": {
"intent_id": "<string>",
"contract_id": "<string>",
"status": "PENDING",
"transaction_hash": "<string>"
},
"funding_instructions": {
"network": "stellar",
"stellar_network": "testnet",
"deposit": {
"address": "<string>",
"type": "account"
},
"asset": {
"id": "<string>",
"symbol": "<string>",
"stellar_asset": "<string>",
"code": "<string>",
"issuer": "<string>",
"contract": "<string>",
"decimals": 0
},
"amount": "<string>",
"required_amount": "<string>",
"received_amount": "<string>",
"expires_at": "<string>"
},
"payment": {
"id": "<string>",
"object": "payment",
"funding_intent_id": "<string>",
"network": "<string>",
"stellar_network": "testnet",
"asset": "<string>",
"stellar_asset": "<string>",
"amount": "<string>",
"payer_address": "<string>",
"destination_address": "<string>",
"transaction_hash": "<string>",
"operation_id": "<string>",
"ledger": 0,
"memo": {
"type": "text",
"value": "<string>"
},
"status": "DETECTED",
"failure": {
"code": "<string>",
"message": "<string>"
},
"detected_at": "<string>",
"confirmed_at": "<string>"
},
"settlement": {
"id": "<string>",
"object": "settlement",
"funding_intent_id": "<string>",
"application_id": "<string>",
"payment_id": "<string>",
"network": "stellar",
"stellar_network": "testnet",
"route": "direct",
"source": {
"asset": "<string>",
"amount": "<string>"
},
"destination": {
"network": "<string>",
"asset": "<string>",
"address": "<string>",
"amount": "<string>"
},
"transaction_hash": "<string>",
"transfer_transaction_hash": "<string>",
"protocol": {
"settlement_id": "<string>",
"contract_id": "<string>",
"create_transaction_hash": "<string>",
"confirm_transaction_hash": "<string>"
},
"status": "PENDING",
"reconciliation_status": "UNRECONCILED",
"failure": {
"code": "<string>",
"message": "<string>"
},
"submitted_at": "<string>",
"confirmed_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
},
"failure": {
"code": "<string>",
"message": "<string>"
},
"hosted_funding_url": "<string>",
"expires_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}Authorizations
Application API authentication for developer backends: Authorization: Bearer ur_test_... or ur_live_.... Resolves the application, its environment and the key's status. Never a dashboard login.
Path Parameters
Required string length:
1 - 64Response
Default Response
- Option 1
- Option 2
- Option 3
Available options:
event Available options:
1 Available options:
funding.created, funding.partially_funded, funding.payment_confirmed, funding.settling, funding.settled, funding.credited, funding.failed, funding.expired Show child attributes
Show child attributes
⌘I
Node.js SDK
import { Useroutr } from "@useroutr/sdk";
const useroutr = new Useroutr({ apiKey: process.env.USEROUTR_API_KEY });
const event = await useroutr.webhooks.events.retrieve("evt_0d5e8c26");curl -X GET "https://api.sandbox.useroutr.com/v1/webhooks/events/evt_0d5e8c26" \
-H "Authorization: Bearer $USEROUTR_API_KEY"{
"id": "<string>",
"object": "event",
"api_version": "1",
"application_id": "<string>",
"funding_intent_id": "<string>",
"created_at": "<string>",
"type": "funding.created",
"data": {
"object": {
"id": "<string>",
"object": "funding_intent",
"application_id": "<string>",
"requirement": {
"amount": "<string>",
"asset": "<string>"
},
"destination": {
"network": "<string>",
"asset": "<string>",
"address": "<string>"
},
"source": {
"network": "<string>",
"asset": "<string>",
"amount": "<string>"
},
"quote": {
"id": "<string>",
"object": "quote",
"funding_intent_id": "<string>",
"application_id": "<string>",
"type": "EXACT_INPUT",
"status": "ACTIVE",
"stellar_network": "testnet",
"source": {
"network": "<string>",
"asset": "<string>",
"amount": "<string>",
"expected_amount": "<string>"
},
"destination": {
"network": "<string>",
"asset": "<string>",
"address": "<string>",
"amount": "<string>",
"minimum_amount": "<string>"
},
"route": {
"type": "DIRECT_STELLAR",
"provider": "<string>",
"steps": [
{
"type": "<string>",
"provider": "<string>",
"source_asset": "<string>",
"destination_asset": "<string>"
}
],
"estimated_duration_seconds": 0,
"confidence": 0,
"price_impact_bps": 0,
"score": "<string>"
},
"fees": {
"items": [
{
"type": "NETWORK",
"asset": "<string>",
"amount": "<string>"
}
],
"total": "<string>"
},
"exchange_rate": "<string>",
"slippage_bps": 0,
"execution": {
"id": "<string>",
"object": "route_execution",
"quote_id": "<string>",
"funding_intent_id": "<string>",
"provider": "<string>",
"route_type": "DIRECT_STELLAR",
"status": "PENDING",
"phase": "CREATED",
"provider_execution_id": "<string>",
"transaction_hashes": [
"<string>"
],
"failure": {
"code": "<string>",
"message": "<string>"
},
"started_at": "<string>",
"completed_at": "<string>"
},
"failure": {
"code": "<string>",
"message": "<string>"
},
"expires_at": "<string>",
"lock_expires_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
},
"route": {
"type": "DIRECT_STELLAR",
"provider": "<string>"
},
"status": "CREATED",
"received_amount": "<string>",
"deposit_account": {
"id": "<string>",
"object": "deposit_account",
"network": "stellar",
"address": "<string>",
"asset": "<string>",
"status": "PROVISIONING",
"created_at": "<string>",
"activated_at": "<string>",
"retired_at": "<string>"
},
"reference": "<string>",
"metadata": {},
"protocol": {
"intent_id": "<string>",
"contract_id": "<string>",
"status": "PENDING",
"transaction_hash": "<string>"
},
"funding_instructions": {
"network": "stellar",
"stellar_network": "testnet",
"deposit": {
"address": "<string>",
"type": "account"
},
"asset": {
"id": "<string>",
"symbol": "<string>",
"stellar_asset": "<string>",
"code": "<string>",
"issuer": "<string>",
"contract": "<string>",
"decimals": 0
},
"amount": "<string>",
"required_amount": "<string>",
"received_amount": "<string>",
"expires_at": "<string>"
},
"payment": {
"id": "<string>",
"object": "payment",
"funding_intent_id": "<string>",
"network": "<string>",
"stellar_network": "testnet",
"asset": "<string>",
"stellar_asset": "<string>",
"amount": "<string>",
"payer_address": "<string>",
"destination_address": "<string>",
"transaction_hash": "<string>",
"operation_id": "<string>",
"ledger": 0,
"memo": {
"type": "text",
"value": "<string>"
},
"status": "DETECTED",
"failure": {
"code": "<string>",
"message": "<string>"
},
"detected_at": "<string>",
"confirmed_at": "<string>"
},
"settlement": {
"id": "<string>",
"object": "settlement",
"funding_intent_id": "<string>",
"application_id": "<string>",
"payment_id": "<string>",
"network": "stellar",
"stellar_network": "testnet",
"route": "direct",
"source": {
"asset": "<string>",
"amount": "<string>"
},
"destination": {
"network": "<string>",
"asset": "<string>",
"address": "<string>",
"amount": "<string>"
},
"transaction_hash": "<string>",
"transfer_transaction_hash": "<string>",
"protocol": {
"settlement_id": "<string>",
"contract_id": "<string>",
"create_transaction_hash": "<string>",
"confirm_transaction_hash": "<string>"
},
"status": "PENDING",
"reconciliation_status": "UNRECONCILED",
"failure": {
"code": "<string>",
"message": "<string>"
},
"submitted_at": "<string>",
"confirmed_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
},
"failure": {
"code": "<string>",
"message": "<string>"
},
"hosted_funding_url": "<string>",
"expires_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "BAD_REQUEST",
"message": "<string>",
"requestId": "<string>",
"retryable": true,
"details": [
{
"path": "<string>",
"message": "<string>"
}
]
}
}