Get payment

Returns payment details and current transaction state for a checkout session.

Request

method
GET
/pay/api/payment/{checkoutSessionId}
Authentication: Authorization: Bearer {token} — role VpayTerminal

Path parameters

ParameterTypeDescription
checkoutSessionIdstringSession ID from start-payment or generate-payment-link

Response 200

FieldTypeDescription
totalTransactionAmountstringTransaction amount
currencyCodestringCurrency code
transactionReferenceNumberstringMerchant reference
authorizationCodestringAuthorization code when approved
stateintegerTransaction state
{
  "totalTransactionAmount": "1500.00",
  "currencyCode": "CRC",
  "transactionReferenceNumber": "ORDER-2026-001",
  "authorizationCode": "ABC123",
  "state": 1
}

Errors

StatusTypeDescription
401Unauthorized
404VPAY_007Payment not found
422VPAY_002Session does not exist
500Internal error

Example

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