Check Payment Status

Payment status is crucial for merchants to track payments being processed, completed, or cancelled. You can retrieve the status of a payment using the Check Payment Status API.

Prerequisites

API Credentials

API-KEY, API-SECRET, and MERCHANT-ID

Payment ID

paymentId returned from the Initiate Payment API

Check Status

Include the paymentId in your request to the Check Payment Status API:

$ curl -X GET \
>   -H 'Content-Type: application/json' \
>   -H 'API-KEY: your-api-key' \
>   -H 'API-SECRET: your-api-secret' \
>   -H 'MERCHANT-ID: your-merchant-id' \
>   'https://api.sagapay.no/payments/{paymentId}/status'

Payment Status Values

Status	Description
`PAYMENT_INITIATED`	Payment has been initiated (waiting for user action)
`PAYMENT_PROCESSING`	Payment is being authorized
`PAYMENT_PROCESSED`	Payment has been successfully authorized
`PAYMENT_COMPLETED`	Payment is successfully completed (`transactionId` returned)
`PAYMENT_FAILED`	Payment failed (`failureReason` returned)
`PAYMENT_CANCELLED`	Payment cancelled by user or via terminal

You can also get payment status by integrating webhooks for real-time updates, eliminating the need for frequent polling.

On successful completion of a payment, an associated transaction record is created. The transaction details can be fetched using the Transaction APIs.

Fetch Payment Information by ID

Fetching payment information allows you to retrieve specific transaction details using the unique payment identifier. This helps resolve issues and verify payment records. You can also generate and display a receipt directly from the API response.

Prerequisites

API Credentials

API-KEY, API-SECRET, and MERCHANT-ID

Payment ID

paymentId from the Initiate Payment API

Fetch Payment Details

$ curl -X GET \
>   -H 'Content-Type: application/json' \
>   -H 'API-KEY: your-api-key' \
>   -H 'API-SECRET: your-api-secret' \
>   -H 'MERCHANT-ID: your-merchant-id' \
>   'https://api.sagapay.no/payments/{paymentId}'

Response Attributes

Attribute	Description
`paymentStatus`	Status of the payment
`transactionId`	Available for completed or failed payments
`merchantId`	Merchant who performed the payment
`terminalId`	Terminal from which payment was made
`orderId`	Order ID for the payment
`paymentId`	Unique ID of the payment
`storeId`	Store where payment was made
`currency`	Currency of the payment
`amount`	Amount in minor currency units (e.g., 1000 = 10.00)
`method`	Payment method used
`type`	Payment type (`purchase` or `return`)
`timestamp`	Timestamp in ISO 8601 format
`truncatedPan`	Last 4 digits of card PAN
`cardLabel`	Card brand (AID Label)
`posEntryMode`	Entry mode: `01` (Manual), `02` (Magnetic stripe), `07` (Chip with PIN)
`terminalVerificationResult`	EMV terminal verification results
`userMessage`	Message from terminal
`aid`	Application Identifier of the card
`customerResponseCode`	`00` for approved, `05` for declined
`cvmMethod`	Cardholder Verification Method used
`rrn`	Retrieval Reference Number (ISO 8583)
`authenticationMode`	`ISSUER` or `CARD`
`arc`	Authorization Response Code (if applicable)
`tsi`	Transaction Status Information (if applicable)
`voided`	Whether payment has been voided

CVM Method Values

Code	Description
`1`	Offline plaintext PIN
`2`	Online PIN
`3`	Offline plaintext PIN/Signature
`4`	Offline PIN
`5`	Offline PIN/Signature
`E`	Signature
`F`	No CVM

Manage Transactions

Fetch Transactions by ID

Use the Fetch Transactions by ID API to retrieve all transactions associated with an order ID, transaction ID, or payment ID. This is useful when a single order was paid through multiple partial payments.

Prerequisites

API credentials
paymentId, transactionId, or orderId of the transaction

Example Request

$ curl -X GET \
>   -H 'Content-Type: application/json' \
>   -H 'API-KEY: your-api-key' \
>   -H 'API-SECRET: your-api-secret' \
>   -H 'MERCHANT-ID: your-merchant-id' \
>   'https://api.sagapay.no/transactions/{id}/list'

Response Attributes

Attribute	Description
`transactionId`	Unique identifier for the transaction
`merchantId`	Merchant who performed the transaction
`storeId`	Store where transaction occurred
`terminalId`	Terminal used for transaction
`orderId`	Order ID for the transaction
`paymentId`	Unique payment identifier
`referenceId`	External reference ID
`rrn`	Retrieval Reference Number (ISO 8583)
`amount`	Transaction amount in minor currency units
`currency`	Currency code (`SEK`, `EUR`, `DKK`, `NOK`)
`method`	Payment method (default: `CARD`)
`type`	Transaction type (`purchase` or `return`)
`orderSummary`	Short summary with line items
`timestamp`	ISO 8601 timestamp
`voided`	Whether transaction has been voided
`issuerCountry`	Country of card issuer
`interchangeDomain`	Interchange domain for processing
`cardCategory`	`Consumer` or `Commercial`
`cardUsage`	`Debit`, `Credit`, or `Prepaid`
`fee`	Transaction fees based on billing plan
`settlementStatus`	`PROCESSED`, `SETTLED`, `NOT_SETTLED`, `ERROR`
`payout`	Final amount transferred to merchant
`settlementRef`	Settlement reference ID
`settlementDate`	Settlement date (ISO format)
`truncatedPan`	Last 4 digits of card PAN
`cardLabel`	Card brand (AID Label)
`posEntryMode`	POS entry mode code
`issuerApplication`	Payment application for the card
`terminalVerificationResult`	EMV verification results
`aid`	Application Identifier
`customerResponseCode`	`00` (approved) or `05` (declined)
`cvmMethod`	Cardholder Verification Method
`authMode`	Authentication mode (`ISSUER` or `CARD`)
`cardBrand`	Card brand (`VISA`, `MASTERCARD`, `AMEX`)

Fetch All Transactions

Retrieve a complete list of transactions processed by a specific merchant.

Example Request

$ curl -X GET \
>   -H 'Content-Type: application/json' \
>   -H 'API-KEY: your-api-key' \
>   -H 'API-SECRET: your-api-secret' \
>   -H 'MERCHANT-ID: your-merchant-id' \
>   'https://api.sagapay.no/transactions'

Query Parameters

Parameter	Description
`startDate`	Filter by start date
`endDate`	Filter by end date

If no query parameters are specified, transactions will be returned from latest to oldest.

Search Transactions

Use the Transaction Search API to perform a free text search on transaction data.

Example Request

$ curl -X GET \
>   -H 'Content-Type: application/json' \
>   -H 'API-KEY: your-api-key' \
>   -H 'API-SECRET: your-api-secret' \
>   -H 'MERCHANT-ID: your-merchant-id' \
>   'https://api.sagapay.no/transactions/search?query=822faedca'

You can search by any field including orderId, transactionId, amount, or any other transaction detail.

Fetch Settlement Reports

Retrieve a detailed summary of completed transactions for a specific merchant. Reports can be generated for specific periods (daily or monthly).

Prerequisites

API credentials
merchantId from the Create Merchant API

Example Request

$ curl -X GET \
>   -H 'Content-Type: application/json' \
>   -H 'API-KEY: your-api-key' \
>   -H 'API-SECRET: your-api-secret' \
>   -H 'MERCHANT-ID: your-merchant-id' \
>   'https://api.sagapay.no/merchants/{merchantId}/reports'

Response Attributes

Attribute	Description
`payoutId`	ID for the specific payout
`merchantId`	Merchant whose report is generated
`transactionStartDate`	Start date of first transaction (YYYY-MM-DD)
`transactionEndDate`	End date of last transaction (YYYY-MM-DD)
`settlementDate`	Date of completed payment (YYYY-MM-DD)
`reportType`	`MONTHLY` or `DAILY`
`url`	URL to detailed settlement report
`totalSale`	Total sales value for the period
`totalRefund`	Total refunded value for the period
`fee`	Total fees collected from transactions
`payout`	Final amount paid to merchant after deductions

Create Orders

Create orders for payment processing

Refunds

Process refunds and returns

Check Payment Status

Prerequisites

Check Status

Payment Status Values

Fetch Payment Information by ID

Prerequisites

Fetch Payment Details

Response Attributes

CVM Method Values

Manage Transactions

Fetch Transactions by ID

Prerequisites

Example Request

Response Attributes

Fetch All Transactions

Example Request

Query Parameters

Search Transactions

Example Request

Fetch Settlement Reports

Prerequisites

Example Request

Response Attributes

Related