Skip to main content
GET
/
payment
/
{session_id}
Get Payment Details
curl --request GET \
  --url https://api.payviox.com/payment/{session_id} \
  --header 'Authorization: Bearer <token>'
{
  "session_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "status": "succeeded",
  "amount": 10250,
  "fees": 250,
  "net_amount": 10000,
  "currency": "USD",
  "order_id": "order_12345",
  "customer": "customer_abc123",
  "description": "Premium subscription",
  "items": [
    {
      "name": "Premium Plan",
      "quantity": 1,
      "price": 10000
    }
  ],
  "metadata": {
    "user_id": "usr_123",
    "plan": "premium"
  },
  "payment_method": "stripe_credit",
  "provider": "stripe",
  "created_at": "2026-05-04T10:30:00.000000Z",
  "customer_details": {
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+33612345678",
    "address": {
      "line1": "123 Main St",
      "city": "Paris",
      "postal_code": "75001",
      "country": "FR"
    }
  },
  "payment_details": {
    "type": "card",
    "card": {
      "brand": "visa",
      "last4": "4242",
      "exp_month": "12",
      "exp_year": "2028",
      "country": "FR"
    }
  },
  "ip": "203.0.113.42",
  "country": "FR",
  "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"
}

​
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. 
Authorization: Bearer sk_live_xxxxxxxxxxxx
Never expose your Secret API Key in client-side code. This endpoint should only be called from your backend server.

​
Path Parameters

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

​
Response Fields

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

​
Example Requests

curl https://api.payviox.com/payment/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxx"

​
Example Response

{
  "session_id": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "status": "succeeded",
  "amount": 10250,
  "fees": 250,
  "net_amount": 10000,
  "currency": "USD",
  "order_id": "order_12345",
  "customer": "customer_abc123",
  "description": "Premium subscription",
  "items": [
    {
      "name": "Premium Plan",
      "quantity": 1,
      "price": 10000
    }
  ],
  "metadata": {
    "user_id": "usr_123",
    "plan": "premium"
  },
  "payment_method": "stripe_credit",
  "provider": "stripe",
  "created_at": "2026-05-04T10:30:00.000000Z",
  "customer_details": {
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+33612345678",
    "address": {
      "line1": "123 Main St",
      "city": "Paris",
      "postal_code": "75001",
      "country": "FR"
    }
  },
  "payment_details": {
    "type": "card",
    "card": {
      "brand": "visa",
      "last4": "4242",
      "exp_month": "12",
      "exp_year": "2028",
      "country": "FR"
    }
  },
  "ip": "203.0.113.42",
  "country": "FR",
  "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36"
}

​
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.
{
  "error": "Unauthorized"
}
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.
{
  "error": "Payment not found"
}

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

Customer billing information (null if payment not completed)

​
payment_details
object

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