Payment status

Query the final or in-progress state of a payment with:

GET /pay/api/payment/{checkoutSessionId}

Requires Bearer authentication with role VpayTerminal.

Response fields

Field	Type	Description
`totalTransactionAmount`	string	Charged amount
`currencyCode`	string	ISO currency code
`transactionReferenceNumber`	string	Your merchant reference
`authorizationCode`	string	Processor authorization code (when approved)
`state`	integer	Transaction state enum value

Transaction states (`state`)

Value	Name	Meaning
`0`	`None`	No meaningful state yet
`1`	`Successful`	Payment completed successfully
`2`	`Failed`	Payment failed or was declined
`4`	`ReviewedPaymentSession`	Session reviewed
`8`	`InProcess`	Processing in progress
`16`	`ApprovedTransaction`	Transaction approved
`32`	`ThreeDsFingerprintRequired`	3DS fingerprint step (in hosted UI)
`64`	`ThreeDsChallengeRequired`	3DS challenge step (in hosted UI)
`128`	`OnvoAuthenticationRequired`	ONVO authentication redirect (in hosted UI)

Interpreting results

For order fulfillment, treat these as success:

state: 1 (Successful)
state: 16 (ApprovedTransaction)

Treat as failure:

state: 2 (Failed)

While state is 8 (InProcess) or a 3DS-related value (32, 64, 128), the payer may still be on the hosted checkout. Retry the GET after a short delay or after your callback fires.

Example

curl -X GET "{sandboxBaseUrl}/pay/api/payment/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "totalTransactionAmount": "1500.00",
  "currencyCode": "CRC",
  "transactionReferenceNumber": "ORDER-2026-001",
  "authorizationCode": "ABC123",
  "state": 1
}

Errors

HTTP	Code	When
`404`	`VPAY_007`	Unknown `checkoutSessionId`
`401`	—	Invalid or missing token
`422`	`VPAY_002`	Session does not exist in current context

​Payment status

​Response fields

​Transaction states (state)

​Interpreting results

​Example

​Errors

​Related

Get payment API