3.2 Get PayIn Status

GET /api/v1/payins/{external_id}

Request

Headers

Parameter	Type	Required	Description
X-API-Key	string	Yes	API key.
X-Timestamp	string	Yes	Request time.
X-Signature	string	Yes	HMAC-SHA256(secret, timestamp + body). For GET requests body is empty.

Path

Parameter	Type	Required	Description
external_id	string	Yes	PayIn identifier provided at creation.

Query

Parameter	Type	Required	Description
shop_code	string	No	Shop code. If omitted, lookup uses the merchant's default active shop.

Example request

GET /api/v1/payins/PIN-BDT-001?shop_code=your_bdt_shop

Response

Response fields

Fields with null values and empty paymentData are omitted from the response.

Parameter	Type	Description
id	number	Payfield operation ID.
external_id	string	PayIn identifier provided at creation.
shop_code	string	Shop code used for routing.
status	string	Current merchant-facing payin status.
amount	string	PayIn amount.
currency	string	PayIn currency.
updated_at	string	Last update timestamp.
paymentData	object	Shop-schema output, when configured and non-empty.
payment_page_url	string	Payment page URL at the root of the response, when available.
payment_page_expires_at	string	Payment page expiration timestamp, when available.

Example response

Success

{
  "id": 12345,
  "external_id": "PIN-BDT-001",
  "shop_code": "your_bdt_shop",
  "status": "pending",
  "amount": "500.00",
  "currency": "BDT",
  "payment_page_url": "https://pay.example.com/bdt/PIN-BDT-001",
  "updated_at": "2026-09-08T10:00:05+00:00"
}

Error

{
  "message": "PayIn not found",
  "code": "not_found",
  "error": {
    "code": "not_found",
    "message": "PayIn not found"
  }
}