<!-- ZenPays documentation · https://docs.zenpayz.com/docs/rest-api/endpoints/payout-intents/get-payout-intent -->

# Get Payout Intent

Retrieve the current status and details of a payout intent.

<EndpointHeader verb="GET" path="/payment/api/v1/payout-intents/{intentId}" />

## Request

### Path Parameters

<ParamTable
  rows={[
    { name: "intentId", type: "string", required: true, desc: "Payout intent ID" },
  ]}
/>

### Headers

<ParamTable
  label="Header"
  rows={[
    { name: "Authorization", required: true, desc: "`Bearer {api_key}`" },
    { name: "X-Signature", required: true, desc: "HMAC-SHA256 signature" },
    { name: "X-Timestamp", required: true, desc: "ISO 8601 timestamp" },
    { name: "X-Secret-Salt", required: true, desc: "Secret salt for HMAC validation" },
  ]}
/>

## Response

### Success (200 OK)

```json
{
  "success": true,
  "data": {
    "intentId": "poi_xxxxx",
    "status": "succeeded",
    "amount": 10000,
    "currency": "INR",
    "beneficiaryName": "John Doe",
    "payoutId": "payout_xxxxx",
    "processingFee": 25,
    "totalDebitedAmount": 10025,
    "expiresAt": "2024-01-15T11:00:00.000Z",
    "confirmedAt": "2024-01-15T10:35:00.000Z",
    "completedAt": "2024-01-15T10:36:00.000Z",
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}
```

<CodeRail>

## Examples

<Tabs groupId="language">
  <TabItem value="curl" label="cURL" default>

```bash
curl "https://api.zenpayz.com/payment/api/v1/payout-intents/poi_xxxxx" \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-01-15T10:30:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt"
```

  </TabItem>
  <TabItem value="sdk" label="SDK">

```javascript
const intent = await zenpays.payouts.getPayoutIntent('poi_xxxxx')
console.log(intent.status) // 'succeeded'
```

  </TabItem>
</Tabs>

</CodeRail>

## Intent Statuses

| Status | Description |
|--------|-------------|
| `requires_confirmation` | Waiting for required fields to be submitted |
| `processing` | Payout is being processed |
| `succeeded` | Payout completed successfully |
| `failed` | Payout failed (see `failureReason`) |
| `cancelled` | Cancelled before confirmation |
| `expired` | Not confirmed within 30 minutes |

## Related Endpoints

- [Create Payout Intent](/docs/rest-api/endpoints/payout-intents/create-payout-intent)
- [List Payout Intents](/docs/rest-api/endpoints/payout-intents/list-payout-intents)
