session.succeeded

POST

The payment succeeded. The session is SUCCEEDED (final): fulfil the order.

Request Body^required

Media typeapplication/json

The session.succeeded event.

object

id

required

Event id (evt_…), stable across retries; also the X-Paymee-Webhook-Id header.

string

event

required

• session.succeeded - session.succeeded

string

Allowed values: session.succeeded

created_at

required

string format: date-time

livemode

required

False for events from test mode (sk_test_ keys).

boolean

data

required

The payment session, as every session.* and checkout.session.expired event carries it.

object

id

required

Payment session id (ps_…).

string

order_number

required

Paymee’s order number (PM-…).

string

merchant_reference

required

string

order_id

required

Empty when not given.

string

amount

required

Charged amount, decimal string (TND, 3 decimals).

string

currency

required

string

original

required

What you requested, and the exchange rate applied.

object

amount

required

Requested amount, as a decimal string at the requested currency’s precision.

string

currency

required

Requested ISO 4217 currency code.

string

rate

required

Exchange rate applied (1 original.currency = rate currency), six decimals. “1.000000” when no conversion.

string

description

required

string

status

required

• CREATED - CREATED
• PENDING - PENDING
• PROCESSING - PROCESSING
• SUCCEEDED - SUCCEEDED
• FAILED - FAILED
• EXPIRED - EXPIRED
• CANCELED - CANCELED

string

Allowed values: CREATED PENDING PROCESSING SUCCEEDED FAILED EXPIRED CANCELED

buyer

required

object

first_name

required

string

last_name

required

string

email

required

string

phone

required

Empty when not given.

string

items

required

The line items you sent, as sent.

Array<object>

object

key

additional properties

metadata

required

Your metadata, values as strings.

object

key

additional properties

string

completed_at

required

When the session reached a final status; null while it is open.

string | null format: date-time

payment

required

object

method

required

CARD.

string

card_brand

required

string

card_last_four

required

string

card_country

required

The issuing bank’s country name.

string

fee_amount

required

string

net_amount

required

string

Responses

200

Any 2xx within 10 seconds acknowledges the event; anything else is retried.