3.2 Get PayIn Status
GET /api/v1/payins/{external_id}
- Path
- Query
| Parameter | Type | Required | Description |
|---|---|---|---|
| external_id | string | Yes | PayIn identifier provided at creation. |
| Parameter | Type | Required | Description |
|---|---|---|---|
| shop_code | string | No | Shop code. If omitted, lookup uses the default active shop. |
Example request
GET /api/v1/payins/PIN-VND-EPT-001?shop_code=your_ept_vnd_shop
Response
Fields with null values and empty paymentData are omitted from the response. When configured and available, payment_page_url and payment_page_expires_at are root fields.
{
"id": 12345,
"external_id": "PIN-VND-EPT-001",
"shop_code": "your_ept_vnd_shop",
"status": "pending",
"amount": "250000",
"currency": "VND",
"payment_page_url": "https://pay.example.com/vnd/PIN-VND-EPT-001",
"updated_at": "2026-09-21T10:00:00+00:00"
}