Przejdź do treści
Oplac

Referencja API

Zwroty

Zwroty całościowe i częściowe.

POST/v1/refundsGET/v1/refunds/{id}POST/v1/refunds/{id}GET/v1/refunds

Klucz testowy w przykładach

Wklej klucz sk_test_ z panelu (zakładka Deweloperzy), a każdy przykład będzie gotowy do uruchomienia. Klucz zostaje w tej karcie przeglądarki, nie wysyłamy go nigdzie.

Przykłady używają Twojego klucza testowego. Produkcyjnego klucza nie przyjmujemy.

Tryb testowy

Obiekt refund#

Zwrot (re_) całości albo części płatności. Zwroty częściowe sumują się do kwoty płatności.

Pola

  • id string wymagane

    Identyfikator zwrotu.

  • object string wymagane

    Nazwa typu obiektu, zawsze "refund".

  • payment string wymagane

    Płatność (pay_) albo pełny obiekt przy expand[]=payment.

  • amount integer wymagane

    Kwota zwrotu w groszach.

  • currency string wymagane
    PLNEURUSD
  • reason string | null
    requested_by_customerduplicatefraudulentother
  • status string wymagane

    W piaskownicy od razu succeeded. W produkcji dostawca może zwrócić pending; wynik przychodzi zdarzeniem refund.succeeded albo refund.failed.

    pendingsucceededfailed
  • metadata object wymagane

    Własne pary klucz: wartość (do 50 kluczy, klucz do 40 znaków, wartość tekstowa do 500 znaków). Wracają w obiekcie i w zdarzeniach webhooka. Przy zmianie nowe klucze dochodzą do zapisanych, pusta wartość usuwa klucz, pusty tekst zamiast obiektu czyści wszystko.

  • livemode boolean wymagane

    true dla obiektów produkcyjnych (klucz sk_live_), false dla piaskownicy (sk_test_).

  • created integer wymagane

    Chwila utworzenia jako znacznik czasu Unix (sekundy, UTC).

JSON 
{
  "id": "re_Ab12Cd34Ef56Gh",
  "object": "refund",
  "payment": "pay_Ab12Cd34Ef56Gh",
  "amount": 2900,
  "currency": "PLN",
  "reason": "requested_by_customer",
  "status": "succeeded",
  "metadata": [],
  "livemode": false,
  "created": 1760000000
}

Utwórz zwrot#

POST /v1/refunds

Zwrot całej pozostałej kwoty (bez amount) albo części. Zwroty częściowe sumują się do kwoty płatności. Przy udanym zwrocie powstaje faktura korygująca, jeśli do płatności była faktura. Zdarzenia: refund.created, potem refund.succeeded albo refund.failed.

Nagłówki opcjonalne: Oplac-Version, Idempotency-Key

Treść żądania JSON

  • payment string wymagane

    Identyfikator płatności pay_ w statusie succeeded.

  • amount integer

    Kwota zwrotu w groszach; domyślnie cała pozostała kwota. Od 1.

  • reason string
    requested_by_customerduplicatefraudulentother
  • metadata object

    Własne pary klucz: wartość (do 50 kluczy, klucz do 40 znaków, wartość tekstowa do 500 znaków). Wracają w obiekcie i w zdarzeniach webhooka. Przy zmianie nowe klucze dochodzą do zapisanych, pusta wartość usuwa klucz, pusty tekst zamiast obiektu czyści wszystko.

Odpowiedź

HTTP 201: obiekt refund.

Błędy tej operacji: parameter_missing, parameter_invalid, metadata_invalid, expand_invalid, api_version_invalid, idempotency_key_reused, idempotency_key_invalid, api_key_invalid, resource_missing, payment_not_refundable, refund_exceeds_amount, rate_limited, api_error, provider_error . Każdy błąd to ten sam obiekt error, opisany w przewodniku Błędy. 

curl https://oplac.pl/api/v1/refunds \
  -H "Authorization: Bearer sk_test_TWOJ_KLUCZ" \
  -H "Idempotency-Key: 5f0c2a4e-7d1b-4e8a-9b2f-1c3d5e7f9a0b" \
  -H "Content-Type: application/json" \
  -d '{
  "payment": "pay_Ab12Cd34Ef56Gh",
  "amount": 2900,
  "reason": "requested_by_customer"
}'
$ch = curl_init('https://oplac.pl/api/v1/refunds');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer sk_test_TWOJ_KLUCZ',
        'Idempotency-Key: 5f0c2a4e-7d1b-4e8a-9b2f-1c3d5e7f9a0b',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'payment' => 'pay_Ab12Cd34Ef56Gh',
        'amount' => 2900,
        'reason' => 'requested_by_customer',
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$refund = json_decode(curl_exec($ch), true);
const res = await fetch('https://oplac.pl/api/v1/refunds', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer sk_test_TWOJ_KLUCZ',
    'Idempotency-Key': '5f0c2a4e-7d1b-4e8a-9b2f-1c3d5e7f9a0b',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    payment: 'pay_Ab12Cd34Ef56Gh',
    amount: 2900,
    reason: 'requested_by_customer',
  }),
});
const refund = await res.json();
import requests

res = requests.post(
    "https://oplac.pl/api/v1/refunds",
    headers={
        "Authorization": "Bearer sk_test_TWOJ_KLUCZ",
        "Idempotency-Key": "5f0c2a4e-7d1b-4e8a-9b2f-1c3d5e7f9a0b",
    },
    json={
        "payment": "pay_Ab12Cd34Ef56Gh",
        "amount": 2900,
        "reason": "requested_by_customer",
    },
)
refund = res.json()
Odpowiedź HTTP 201 
{
  "id": "re_Ab12Cd34Ef56Gh",
  "object": "refund",
  "payment": "pay_Ab12Cd34Ef56Gh",
  "amount": 2900,
  "currency": "PLN",
  "reason": "requested_by_customer",
  "status": "succeeded",
  "metadata": [],
  "livemode": false,
  "created": 1760000000
}

Pobierz zwrot#

GET /v1/refunds/{id}

Zwrot po identyfikatorze; zwrot pending w produkcji jest odświeżany u dostawcy.

Nagłówki opcjonalne: Oplac-Version

Parametry ścieżki

  • id string wymagane

    Identyfikator re_.

Parametry zapytania

  • expand[] array of string

    Pola do rozwinięcia w pełny obiekt (na liście z przedrostkiem data. albo bez). Rozwijalne: payment, payment.customer.

    paymentpayment.customer

Odpowiedź

HTTP 200: obiekt refund.

Błędy tej operacji: parameter_missing, parameter_invalid, metadata_invalid, expand_invalid, api_version_invalid, idempotency_key_reused, idempotency_key_invalid, api_key_invalid, resource_missing, rate_limited, api_error . Każdy błąd to ten sam obiekt error, opisany w przewodniku Błędy. 

curl https://oplac.pl/api/v1/refunds/re_Ab12Cd34Ef56Gh \
  -H "Authorization: Bearer sk_test_TWOJ_KLUCZ"
$ch = curl_init('https://oplac.pl/api/v1/refunds/re_Ab12Cd34Ef56Gh');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ['Authorization: Bearer sk_test_TWOJ_KLUCZ'],
    CURLOPT_RETURNTRANSFER => true,
]);
$refund = json_decode(curl_exec($ch), true);
const res = await fetch('https://oplac.pl/api/v1/refunds/re_Ab12Cd34Ef56Gh', {
  headers: {Authorization: 'Bearer sk_test_TWOJ_KLUCZ' },
});
const refund = await res.json();
import requests

res = requests.get(
    "https://oplac.pl/api/v1/refunds/re_Ab12Cd34Ef56Gh",
    headers={"Authorization": "Bearer sk_test_TWOJ_KLUCZ"},
)
refund = res.json()
Odpowiedź HTTP 200 
{
  "id": "re_Ab12Cd34Ef56Gh",
  "object": "refund",
  "payment": "pay_Ab12Cd34Ef56Gh",
  "amount": 2900,
  "currency": "PLN",
  "reason": "requested_by_customer",
  "status": "succeeded",
  "metadata": [],
  "livemode": false,
  "created": 1760000000
}

Zmień zwrot#

POST /v1/refunds/{id}

Tylko metadata.

Nagłówki opcjonalne: Oplac-Version, Idempotency-Key

Parametry ścieżki

  • id string wymagane

    Identyfikator re_.

Treść żądania JSON, opcjonalna

  • metadata object

    Własne pary klucz: wartość (do 50 kluczy, klucz do 40 znaków, wartość tekstowa do 500 znaków). Wracają w obiekcie i w zdarzeniach webhooka. Przy zmianie nowe klucze dochodzą do zapisanych, pusta wartość usuwa klucz, pusty tekst zamiast obiektu czyści wszystko.

Odpowiedź

HTTP 200: obiekt refund.

Błędy tej operacji: parameter_missing, parameter_invalid, metadata_invalid, expand_invalid, api_version_invalid, idempotency_key_reused, idempotency_key_invalid, api_key_invalid, resource_missing, rate_limited, api_error . Każdy błąd to ten sam obiekt error, opisany w przewodniku Błędy. 

curl https://oplac.pl/api/v1/refunds/re_Ab12Cd34Ef56Gh \
  -H "Authorization: Bearer sk_test_TWOJ_KLUCZ" \
  -H "Content-Type: application/json" \
  -d '{
  "metadata": {
    "order_id": "10482"
  }
}'
$ch = curl_init('https://oplac.pl/api/v1/refunds/re_Ab12Cd34Ef56Gh');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer sk_test_TWOJ_KLUCZ',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'metadata' => [
            'order_id' => '10482',
        ],
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$refund = json_decode(curl_exec($ch), true);
const res = await fetch('https://oplac.pl/api/v1/refunds/re_Ab12Cd34Ef56Gh', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer sk_test_TWOJ_KLUCZ',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    metadata: {
      order_id: '10482',
    },
  }),
});
const refund = await res.json();
import requests

res = requests.post(
    "https://oplac.pl/api/v1/refunds/re_Ab12Cd34Ef56Gh",
    headers={"Authorization": "Bearer sk_test_TWOJ_KLUCZ"},
    json={
        "metadata": {
            "order_id": "10482",
        },
    },
)
refund = res.json()
Odpowiedź HTTP 200 
{
  "id": "re_Ab12Cd34Ef56Gh",
  "object": "refund",
  "payment": "pay_Ab12Cd34Ef56Gh",
  "amount": 2900,
  "currency": "PLN",
  "reason": "requested_by_customer",
  "status": "succeeded",
  "metadata": [],
  "livemode": false,
  "created": 1760000000
}

Lista zwrotów#

GET /v1/refunds

Zwroty konta w trybie klucza.

Nagłówki opcjonalne: Oplac-Version

Parametry zapytania

  • limit integer

    Liczba obiektów na stronie (1 do 100). Domyślnie 10. Od 1 do 100.

  • starting_after string

    Identyfikator obiektu; zwraca starsze od niego (następna strona).

  • ending_before string

    Identyfikator obiektu; zwraca nowsze od niego (poprzednia strona). Nie łączyć ze starting_after.

  • created object

    Filtr po chwili utworzenia (Unix): created[gte]=1760000000.

    • gt integer
    • gte integer
    • lt integer
    • lte integer
  • payment string

    Zwroty jednej płatności pay_.

  • expand[] array of string

    Pola do rozwinięcia w pełny obiekt (na liście z przedrostkiem data. albo bez). Rozwijalne: payment, payment.customer.

    paymentpayment.customer

Odpowiedź

HTTP 200: lista {object: "list", url, has_more, data} z obiektami refund od najnowszego. Stronicowanie kursorem opisuje przewodnik.

Błędy tej operacji: parameter_missing, parameter_invalid, metadata_invalid, expand_invalid, api_version_invalid, idempotency_key_reused, idempotency_key_invalid, api_key_invalid, rate_limited, api_error . Każdy błąd to ten sam obiekt error, opisany w przewodniku Błędy. 

curl "https://oplac.pl/api/v1/refunds?limit=3" \
  -H "Authorization: Bearer sk_test_TWOJ_KLUCZ"
$ch = curl_init('https://oplac.pl/api/v1/refunds?limit=3');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ['Authorization: Bearer sk_test_TWOJ_KLUCZ'],
    CURLOPT_RETURNTRANSFER => true,
]);
$refunds = json_decode(curl_exec($ch), true);
const res = await fetch('https://oplac.pl/api/v1/refunds?limit=3', {
  headers: {Authorization: 'Bearer sk_test_TWOJ_KLUCZ' },
});
const refunds = await res.json();
import requests

res = requests.get(
    "https://oplac.pl/api/v1/refunds?limit=3",
    headers={"Authorization": "Bearer sk_test_TWOJ_KLUCZ"},
)
refunds = res.json()
Odpowiedź HTTP 200 
{
  "object": "list",
  "url": "/v1/refunds",
  "has_more": false,
  "data": [
    {
      "id": "re_Ab12Cd34Ef56Gh",
      "object": "refund",
      "payment": "pay_Ab12Cd34Ef56Gh",
      "amount": 2900,
      "currency": "PLN",
      "reason": "requested_by_customer",
      "status": "succeeded",
      "metadata": [],
      "livemode": false,
      "created": 1760000000
    }
  ]
}

Klucz testowy dostajesz od razu po zapisie

Adres e-mail, kod z maila i piaskownica z kodami BLIK. Produkcję włączasz sam w panelu: plan, dostawca płatności, klucz sk_live_. Wolisz, żeby wdrożenie w sklepie zrobił nasz zespół? To też jest za darmo.

Zamów integrację za darmo

BLIK, karty, subskrypcje i KSeF w jednym panelu.