Skip to main content
GET
Get Payment Details

Overview

Returns comprehensive details about a payment, including the amount, fees, customer information, payment method, and transaction status. Use this endpoint for reconciliation, to verify payment status on-demand, or to retrieve data you may have missed from a webhook.
All monetary amounts are returned in cents (e.g., 10000 = $100.00).

Authentication

This endpoint requires your Secret API Key (server-side only). See Authentication for details.
Never expose your Secret API Key in client-side code. This endpoint should only be called from your backend server.

Path Parameters

string
required
The session ID returned when you created the payment session.

Response Fields

string
required
Unique identifier for the payment session.
string
Current payment status: succeeded, failed, pending, processing, pending_review, declined, expired, or null if no payment attempt was made.
integer
required
Gross amount in cents (what the customer pays).
integer
Total fees in cents (Payviox + provider + addons). null if the payment has not been completed yet.
integer
Net amount in cents (amount - fees). This is what your business receives. null if the payment has not been completed yet.
string
required
Three-letter ISO currency code (e.g., USD).
string
Your unique order identifier, as provided when creating the session.
string
Customer identifier, as provided when creating the session.
string
Payment description, as provided when creating the session.
array
Array of items from the original session.
object
Custom key-value pairs attached to this session.
string
Payment method identifier (e.g., stripe_credit, paypal, stripe_apple_pay).
string
Payment provider used (e.g., stripe, paypal, payssion).
string
ISO 8601 timestamp of when the session was created.
object
Customer billing information collected during payment. null if the payment has not been completed.
object
Payment method details. null if the payment has not been completed.
string
End-user’s IP address at the time of payment.
string
Two-letter country code detected from the end-user’s IP address (e.g., FR, US).
string
End-user’s browser User-Agent string at the time of payment.

Example Requests

Example Response

Error Responses

Returned when the API key is missing or invalid. This endpoint requires your Secret API Key.How to resolve: Ensure you are sending a valid Secret API key in the Authorization: Bearer header. Public API keys are not accepted for this endpoint.
Returned when the session_id does not exist or does not belong to your business.How to resolve: Verify the session_id is correct. You can only retrieve payments created by your own business.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

session_id
string
required

The session ID returned when you created the payment session

Response

Payment details retrieved successfully

session_id
string

Unique identifier for the payment session

status
string | null

Current payment status

amount
integer

Gross amount in cents (what the customer pays)

fees
integer | null

Total fees in cents (null if payment not completed)

net_amount
integer | null

Net amount in cents (amount - fees, null if payment not completed)

currency
string

Three-letter ISO currency code

order_id
string

Your unique order identifier

customer
string

Customer identifier

description
string | null

Payment description

items
object[]

Array of items from the original session

metadata
object

Custom key-value pairs attached to this session

payment_method
string | null

Payment method identifier (e.g., stripe_credit, paypal)

provider
string | null

Payment provider used (e.g., stripe, paypal)

created_at
string<date-time>

ISO 8601 timestamp of session creation

customer_details
object | null

Customer billing information (null if payment not completed)

payment_details
object | null

Payment method details (null if payment not completed)

ip
string | null

End-user's IP address

country
string | null

Two-letter country code from IP geolocation

user_agent
string | null

End-user's browser User-Agent string