3.2 Get PayIn Status
GET /api/v2/transactions/{transaction_id}
Request
- Headers
- Path
- Query
| Parameter | Type | Required | Description |
|---|---|---|---|
| X-Api-Key | string | Yes | Your enabled merchant API key. |
| X-Signature | string | Yes | Lowercase hexadecimal HMAC-SHA256 of an empty string, using the API signing secret. |
v2 does not require X-Timestamp or X-Request-Id. See authentication.
| Parameter | Type | Required | Description |
|---|---|---|---|
| transaction_id | string of digits | Yes | ID returned by the v2 create request, not your order_id. |
Use the transaction_id from Create PayIn. Sign an empty body; the URL is not included in the v2 signature. There are no required query parameters.
There are no required query parameters. Do not copy the v1 shop_code lookup parameter; the transaction ID and authenticated merchant identify the operation.
Example request
GET /api/v2/transactions/12346
Response
Response fields
HTTP 200.
| Parameter | Type | Meaning |
|---|---|---|
order_id | string | Your identifier from the create request. |
transaction_id | string | Payfield transaction ID. |
status | string | PENDING, SUCCESS, or FAILED. |
amount | JSON number | Transaction amount. |
currency | string | Uppercase currency code. |
method | string | The method shop code supplied at creation. If omitted, the selected shop's payment-method code when available; otherwise unknown. |
account_number | string, optional | Withdrawal recipient account, or deposit payer account when available to the status API. Optional; PAN-shaped values are masked with the first 6 and last 4 digits visible. |
Example response
- Success
- Error
{
"order_id": "DEP-BDT-1001",
"transaction_id": "12346",
"status": "PENDING",
"amount": 500,
"currency": "BDT",
"method": "your_bdt_shop"
}
HTTP 404:
{
"error": {
"code": 404,
"message": "Not found"
}
}
status is PENDING, SUCCESS, or FAILED. The response amount is a JSON number. An optional account_number may contain an available payer account; card-shaped values are masked. Do not require this field for every deposit: see the current account-data limitations. This endpoint returns 404 for an unknown ID, another merchant's transaction, or a transaction created through v1. See the shared status guide.