Refund a session in full

POST

/api/sessions/{sessionId}/refund

curl -s -X POST "https://services.sandbox.payplug-elements.msem.tech/api/sessions/0193f6c1-7a2e-7b4d-9f01-2c3d4e5f6a7b/refund" \
  -H "authorization: Bearer $ACCESS_TOKEN"

const response = await fetch("https://services.sandbox.payplug-elements.msem.tech/api/sessions/0193f6c1-7a2e-7b4d-9f01-2c3d4e5f6a7b/refund", {
  method: "POST",
  headers: { authorization: `Bearer ${accessToken}` },
});

var response = client.send(
    HttpRequest.newBuilder(URI.create("https://services.sandbox.payplug-elements.msem.tech/api/sessions/0193f6c1-7a2e-7b4d-9f01-2c3d4e5f6a7b/refund"))
        .header("authorization", "Bearer " + accessToken)
        .POST(HttpRequest.BodyPublishers.noBody())
        .build(),
    HttpResponse.BodyHandlers.ofString());

var request = new HttpRequestMessage(HttpMethod.Post, "https://services.sandbox.payplug-elements.msem.tech/api/sessions/0193f6c1-7a2e-7b4d-9f01-2c3d4e5f6a7b/refund");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);
var response = await http.SendAsync(request);

$request = curl_init("https://services.sandbox.payplug-elements.msem.tech/api/sessions/0193f6c1-7a2e-7b4d-9f01-2c3d4e5f6a7b/refund");
curl_setopt_array($request, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        "authorization: Bearer $accessToken",
    ],
]);
$response = curl_exec($request);

uri = URI("https://services.sandbox.payplug-elements.msem.tech/api/sessions/0193f6c1-7a2e-7b4d-9f01-2c3d4e5f6a7b/refund")
request = Net::HTTP::Post.new(uri)
request["authorization"] = "Bearer #{access_token}"
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) }

req, err := http.NewRequest("POST", "https://services.sandbox.payplug-elements.msem.tech/api/sessions/0193f6c1-7a2e-7b4d-9f01-2c3d4e5f6a7b/refund", nil)
if err != nil {
  return err
}
req.Header.Set("authorization", "Bearer "+accessToken)
resp, err := http.DefaultClient.Do(req)
if err != nil {
  return err
}
defer resp.Body.Close()

const response = await fetch("https://services.payplug-elements.msem.tech/api/sessions/0193f6c1-7a2e-7b4d-9f01-2c3d4e5f6a7b/refund", {
  method: "POST",
  headers: { authorization: `Bearer ${accessToken}` },
});

var response = client.send(
    HttpRequest.newBuilder(URI.create("https://services.payplug-elements.msem.tech/api/sessions/0193f6c1-7a2e-7b4d-9f01-2c3d4e5f6a7b/refund"))
        .header("authorization", "Bearer " + accessToken)
        .POST(HttpRequest.BodyPublishers.noBody())
        .build(),
    HttpResponse.BodyHandlers.ofString());

var request = new HttpRequestMessage(HttpMethod.Post, "https://services.payplug-elements.msem.tech/api/sessions/0193f6c1-7a2e-7b4d-9f01-2c3d4e5f6a7b/refund");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);
var response = await http.SendAsync(request);

$request = curl_init("https://services.payplug-elements.msem.tech/api/sessions/0193f6c1-7a2e-7b4d-9f01-2c3d4e5f6a7b/refund");
curl_setopt_array($request, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        "authorization: Bearer $accessToken",
    ],
]);
$response = curl_exec($request);

uri = URI("https://services.payplug-elements.msem.tech/api/sessions/0193f6c1-7a2e-7b4d-9f01-2c3d4e5f6a7b/refund")
request = Net::HTTP::Post.new(uri)
request["authorization"] = "Bearer #{access_token}"
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) }

req, err := http.NewRequest("POST", "https://services.payplug-elements.msem.tech/api/sessions/0193f6c1-7a2e-7b4d-9f01-2c3d4e5f6a7b/refund", nil)
if err != nil {
  return err
}
req.Header.Set("authorization", "Bearer "+accessToken)
resp, err := http.DefaultClient.Do(req)
if err != nil {
  return err
}
defer resp.Body.Close()

The by-order gesture, one lookup away: GET /api/sessions?orderId=… finds the session, this refunds it, in full.

Authorizations

apiToken

Parameters

Path Parameters

sessionId

required

string format: uuid

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

The session, as a search returned it. A lowercase UUID — the ones we mint are v7.

Example

0193f6c1-7a2e-7b4d-9f01-2c3d4e5f6a7b

Responses

202

The refund operations this gesture produced — read each status: succeeded or failed when the PSP decided on the spot, pending while it has not. Every verdict also reaches you in the refund webhook.

application/json

object

refunds

required

The refund operations this call started, with the attempt and session each belongs to.

Array<object>

>= 1 items

The transaction, with the home that gives it meaning — session, order, attempt.

object

sessionId

required

The session this belongs to.

string format: uuid

merchantId

required

The merchant it belongs to.

string

orderId

required

Their own order reference.

string

attemptId

required

The attempt it belongs to.

string format: uuid

method

required

What the attempt behind this operation was paid with — card, paypal, wero… An operation alone does not say it, and reading a list of PSP operations without it means opening each one.

string

cardScheme

The card network that attempt ran on, when the PSP named one we could place — see the same field on an attempt.

string

cardCode

The card as the PSP masked it — see the same field on an attempt.

string

cardCountry

The country of the card’s issuer — see the same field on an attempt.

string

provider

required

The PSP adapter that served the attempt (D-051) — whose dashboard the references live in.

string

transaction

required

The operation itself.

object

transactionId

required

Our handle for this PSP operation — what a refund door addresses.

string format: uuid

createdAt

required

When the operation was opened — epoch milliseconds (Q13).

integer

updatedAt

required

The last event that touched it — for a terminal transaction, its verdict’s instant.

integer

type

required

What this operation asked the PSP: hold the money, take it in one go, capture a hold, release a hold, send money back, or debit the registered card later.

string

Allowed values: authorization payment capture void refund debit

amount

required

What this operation moved, in minor units.

object

amount

required

Amount in the MINOR unit of the currency — 1000_00 is one thousand euros, never 1000.

integer

currency

required

ISO 4217 code, uppercase. One currency per session.

string

/^[A-Z]{3}$/

providerRef

The PSP’s reference — what their dashboard greps (D-047).

string

status

required

The VERDICT facet: what the PSP finally decided about this operation — as opposed to the ack facet below, which is what the driving call answered on the spot.

object

kind

required

Where the operation stands. pending means the verdict is still due — it always arrives out-of-band.

string

Allowed values: pending succeeded failed cancelled

statusCode

The PSP’s own code, split at the source — successes carry theirs too.

string

statusMessage

The PSP’s own sentence, as they said it — never glued to the code.

string

category

What a refusal means, when the PSP’s answer could be read.

string

Allowed values: bank-refusal insufficient-funds invalid-card-data authentication-failed expired method-unavailable

ackCode

What the driving call answered (the ack facet).

string

ackMessage

What the driving call said — a transport failure’s raw cause included.

string

ackHttpStatus

Absent beside a present ackMessage = no HTTP response ever came.

integer

ackTraceId

The PSP’s own reference for the driving call’s exchange, when it named one — what its support asks for.

string

extraData

The caller’s reconciliation tag, on refunds only (lot 5) — echoed verbatim.

string

replayOf

The refused operation this one replays — asked again by an administrator.

string

refundOf

On a refund: the later debit it gives back — absent, the attempt’s own taking.

string

Example

{
  "refunds": [
    {
      "method": "card",
      "cardScheme": "visa",
      "cardCode": "497010XXXXXX0007",
      "cardCountry": "FR",
      "provider": "dalenys",
      "transaction": {
        "type": "authorization",
        "status": {
          "kind": "pending",
          "category": "bank-refusal"
        }
      }
    }
  ]
}

400

InvalidRequest — the request could not be read: a missing or malformed field, a bad pattern, or a property this door does not declare (the message names it). Every door with a schema can answer this, before any business rule is consulted. Most often here: InvalidRequestedAmount — the DOMAIN’s own refusal of a refund amount that is not a positive number of minor units (REFUND_STATUS), raised after validation has passed. Unreachable through this door as it stands: the schema bounds amount, and an omitted one resolves to what remains refundable. Declared because the code can answer it — a contract that hides a possible answer is the one that surprises.

application/json

object

code

required

Stable machine-readable code — the one thing to branch on. Never parse the message.

string

message

required

English sentence for logs and operators. Wording may change; the code will not.

string

Example

{
  "code": "InvalidRequestedAmount",
  "message": "the refund amount cannot be used"
}

401

Unauthorized — the only code this response carries: no usable access token (absent, malformed, expired). One answer for every failure shape, so nothing can be learned by watching which one comes back.

application/json

object

code

required

Stable machine-readable code — the one thing to branch on. Never parse the message.

string

message

required

English sentence for logs and operators. Wording may change; the code will not.

string

Example

{
  "code": "Unauthorized",
  "message": "a valid access token is required"
}

404

NotFound — the only code this response carries: unknown, or belonging to another merchant. The two are deliberately indistinguishable.

application/json

object

code

required

Stable machine-readable code — the one thing to branch on. Never parse the message.

string

message

required

English sentence for logs and operators. Wording may change; the code will not.

string

Example

{
  "code": "NotFound",
  "message": "no such resource"
}

409

Nothing to refund NOW: the session has not ended (SessionNotEnded), a refund is already in flight (RefundInFlight), or no attempt has anything left (NothingToRefund).

application/json

object

code

required

Stable machine-readable code — the one thing to branch on. Never parse the message.

string

message

required

English sentence for logs and operators. Wording may change; the code will not.

string

Example

{
  "code": "SessionNotEnded",
  "message": "a refund is a post-terminal gesture — this session has not ended"
}

422

An attempt that took money cannot be refunded at its PSP (RefundNotSupported) — the session-level gesture refuses rather than refunding partially.

application/json

object

code

required

Stable machine-readable code — the one thing to branch on. Never parse the message.

string

message

required

English sentence for logs and operators. Wording may change; the code will not.

string

Example

{
  "code": "RefundNotSupported",
  "message": "this method cannot refund at its PSP"
}