A session ended
Sent to your notification URL once per session ending: how it ended, what was taken, and every tranche with the PSP reference of each operation, the card network, and the card alias when the order asked to register the means of payment. Declare that URL on your account, or pass notificationUrl when creating the session.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”The end of a session: how it ended, what was taken, and every tranche with its PSP operations.
object
Stable across retries: deduplicate on it.
Your own order reference, as you created the session with it.
Your own extraData, as you created the session with it — absent if you gave none.
How the session ended. PAID: the order is paid. ABORTED: your customer gave up. EXPIRED: the session reached its time limit. AWAITED_REFUSED: a lender refused the financing — nothing was charged.
The order total.
object
Amount in the MINOR unit of the currency — 1000_00 is one thousand euros, never 1000.
ISO 4217 code, uppercase. One currency per session.
What was actually taken — zero on an abandoned or expired session.
object
Amount in the MINOR unit of the currency — 1000_00 is one thousand euros, never 1000.
ISO 4217 code, uppercase. One currency per session.
The terms the session declared, when it declared some.
object
Your wording, shown as-is — never translated, like statementDescriptor.
Where the full document lives — required: your customer must be able to read what they accept.
When your customer accepted them — epoch milliseconds. Absent if the page never asked.
Every tranche of the order, oldest first.
object
Our identifier for this tranche.
The payment method archetype.
The method instance you declared when creating the session (card, card-amex…).
The card network this tranche ran on — on a co-badged card, the one the cardholder chose. Card tranches only; an absence means the PSP named none we could place, never that there was none.
The card as the PSP masked it: its first six and last four digits, the rest X. Card tranches only, and only when the PSP gave it — never a full number.
The country of the card’s issuer, ISO 3166 alpha-2 — when the PSP gave it.
The ANCV shop this tranche was billed under — the one the session named, or your account’s default. ANCV tranches only.
The financing plan your customer chose: how many installments, with or without fees. Financed tranches only.
object
How many instalments the payer picked — 3 for a 3× plan.
Whether that plan carries fees. The pair (installments, withFees) names a plan uniquely.
Which PSP served this tranche, and so which back-office its providerRefs live in.
Where this attempt stands. AUTHORIZING: dispatched, verdict still due (always out-of-band). AUTHORIZED: the money is held. DECLINED: refused, nothing taken. CANCELLED: the payer backed out at the PSP. CAPTURED: taken. VOIDED: the hold was released.
What the tranche asked for.
object
Amount in the MINOR unit of the currency — 1000_00 is one thousand euros, never 1000.
ISO 4217 code, uppercase. One currency per session.
What the PSP actually granted — below requested on a partial authorization.
object
Amount in the MINOR unit of the currency — 1000_00 is one thousand euros, never 1000.
ISO 4217 code, uppercase. One currency per session.
The card registration this tranche produced, when the session asked to register the means.
Every PSP operation of this tranche, oldest first. How many, and of which type, depends on the method and the PSP: a card is an authorization then a capture, a Wero payment a single payment.
object
What this operation asked the PSP: hold the money (authorization), take it in one go (payment), take a hold (capture), release it (void), send money back (refund), or debit the registered card later (debit).
Where the operation stands. pending means the verdict is still due — it always arrives out-of-band.
What this operation moved.
object
Amount in the MINOR unit of the currency — 1000_00 is one thousand euros, never 1000.
ISO 4217 code, uppercase. One currency per session.
The PSP’s own reference for this operation — what to search for in its back-office.
The PSP’s own code for its verdict, successes included.
The PSP’s own sentence for its verdict, as it said it.
Example
{ "event": "session-ended", "notificationId": "019f18f1-cbf4-762f-bd94-776f523c9ffb:PAID", "orderId": "EP-123456", "status": "PAID", "total": { "amount": 100000, "currency": "EUR" }, "captured": { "amount": 100000, "currency": "EUR" }, "attempts": [ { "attemptId": "019f18f2-6ceb-729c-98b4-d60271a718e0", "method": "card", "methodId": "card", "cardScheme": "visa", "cardCode": "497010XXXXXX0007", "cardCountry": "FR", "provider": "dalenys", "status": "CAPTURED", "requested": { "amount": 60000, "currency": "EUR" }, "granted": { "amount": 60000, "currency": "EUR" }, "operations": [ { "type": "authorization", "status": "succeeded", "amount": { "amount": 60000, "currency": "EUR" }, "providerRef": "A180635471", "statusCode": "0000", "statusMessage": "Successful Operation" }, { "type": "capture", "status": "succeeded", "amount": { "amount": 60000, "currency": "EUR" }, "providerRef": "A180635474", "statusCode": "0000", "statusMessage": "Successful Operation" } ] }, { "attemptId": "019f18f3-418c-729c-98b4-e2d7be7c6163", "method": "wero", "methodId": "wero", "provider": "payplug-retail", "status": "CAPTURED", "requested": { "amount": 40000, "currency": "EUR" }, "granted": { "amount": 40000, "currency": "EUR" }, "operations": [ { "type": "payment", "status": "succeeded", "amount": { "amount": 40000, "currency": "EUR" }, "providerRef": "pay_6GEUtvaN0NH68vioAWb9LF" } ] } ]}Responses
Section titled “ Responses ”Received. Answer 200 with the body OK in text/plain: any other answer — another status, another content type, another body — is retried at t+1 second, t+1 minute, then t+5 minutes.