Skip to main content
GET
/
api
/
v1
/
transactions
/
{winam_tx_id}
Get transaction state
curl --request GET \
  --url https://payments.winam.cm/api/v1/transactions/{winam_tx_id} \
  --header 'X-API-Key: <api-key>'
{
  "winam_tx_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idempotency_key": "<string>",
  "direction": "<string>",
  "operator": "<string>",
  "provider": "<string>",
  "msisdn": "<string>",
  "amount_minor": 123,
  "state": "<string>",
  "state_updated_at": "2023-11-07T05:31:56Z",
  "requires_human_approval": true,
  "provider_tx_id": "MTN2025010112345",
  "expires_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "state_reason": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.winampay.de/llms.txt

Use this file to discover all available pages before exploring further.

amount_minor is expressed in XAF. XAF has no sub-unit — amount_minor: 5000 means exactly 5 000 XAF.
Use this endpoint to poll transaction state when you don’t have a callback_url set, or to debug a specific transaction. For normal operations, prefer webhooks — they push results to you the moment the payment settles. See State Machine for the full list of possible state values and valid transitions.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
winam_tx_id
string<uuid>
required

Response

Successful Response

​
winam_tx_id
string<uuid>
required

Winam internal transaction UUID

​
idempotency_key
string
required

Your original reference value

​
direction
string
required

"deposit" or "withdrawal"

​
operator
string
required

"mtn" or "orange"

​
provider
string
required

Internal provider used for this transaction

Example:

"sim_gateway_mtn"

​
msisdn
string
required

Player Mobile Money number in E.164 format

​
amount_minor
integer
required

Amount in XAF. Equal to amount_xaf from the request — XAF has no sub-unit (1 XAF = 1 unit).

Example:

5000

​
state
string
required

Current transaction state. See the state machine for the full transition diagram.

Example:

"succeeded"

​
state_updated_at
string<date-time> | null
required

Timestamp of the last state change

​
requires_human_approval
boolean
required

True for withdrawals awaiting operator approval

​
provider_tx_id
string | null
required

Provider-side reference (e.g. MTN transaction ID). Available once acknowledged.

Example:

"MTN2025010112345"

​
expires_at
string<date-time> | null
required

Confirmation deadline for deposits. Null once the transaction is in a terminal state.

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
state_reason
string | null

Human-readable reason for the last state transition