Paymentic
API docs by Redocly

paymentic.com (1.0.0)

E-mail: [email protected] URL: https://paymentic.com/kontakt License: Apache 2.0

Wprowadzenie

Dokumentacja do API Paymentic

Transakcje

Lista transakcji

Authorizations:
bearerToken
path Parameters
pointId
required
string (pointId) = 8 characters ^[0-9a-f]{8}$

Identyfikator punktu płatności

Responses

Response Schema: application/json
Array of objects
Array
id
required
string (transactionId) = 14 characters ^[A-Z0-9]{4}-[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]...

Identyfikator transakcji

status
required
string (transactionStatus)
Default: "CREATED"
Enum: "CREATED" "PENDING" "PAID" "FAILED" "CANCELLED"

Status transakcji

Status description
CREATED Transakcja utworzona
PENDING Transakcja oczekująca na opłacenie
PAID Transakcja opłacona
FAILED Transakcja odrzucona
CANCELLED Transakcja anulowana
amount
required
number <float>

Kwota transakcji

currency
required
string <ISO 4217>

Waluta transakcji

commission
required
number or null <float>

Prowizja pobrana z transakcji przez Paymentic

title
required
string

Tytuł transakcji nadany przez Partnera

description
required
string or null

Opis transakcji nadany przez Partnera

required
object
name
required
string

Imię i Nazwisko/Nazwa Płatnika

email
required
string <email>

Adres email płatnika

custom
required
string or null

Pole dodatkowe wykorzystane przez Partnera

required
object
success
required
string or null <url>

Adres URL do powrotu po udanej transakcji

failure
required
string or null <url>

Adres URL do powrotu po nieudanej transakcji

channelId
required
string or null

ID kanału płatności

isTest
required
boolean

Informacja czy transakcja utworzona w trybie testowym

whitelabel
required
boolean

Informacja czy transakcja utworzona w trybie whitelabel

paidAt
required
string or null <ISO 8601>

Data opłacenia transakcji

expiresAt
required
string or null <ISO 8601>

Data przeterminowania transakcji

createdAt
required
string <ISO 8601>

Data utworzenia transakcji

Request samples 

curl --location 'https://api.paymentic.com/v1/payment/points/:pointId/transactions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{bearerToken}}'

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": "stringstringst",
      • "status": "CREATED",
      • "amount": 0.1,
      • "currency": "string",
      • "commission": 0.1,
      • "title": "string",
      • "description": "string",
      • "customer": {},
      • "custom": "string",
      • "redirect": {
        • "success": "string",
        • "failure": "string"
        },
      • "channelId": "string",
      • "isTest": true,
      • "whitelabel": true,
      • "paidAt": "string",
      • "expiresAt": "string",
      • "createdAt": "string"
      }
    ]
}

Generowanie transakcji

Authorizations:
bearerToken
path Parameters
pointId
required
string (pointId) = 8 characters ^[0-9a-f]{8}$

Identyfikator punktu płatności

Request Body schema: application/json
amount
required
number <float> >= 1

Kwota netto transakcji

title
required
string [ 5 .. 32 ] characters

Tytuł transakcji wyświetlany na bramce płatniczej i przesyłany do banku

currency
number or null <ISO 4217>
Default: "PLN"

Waluta transakcji

description
string <= 128 characters

Szczegółowy opis transakcji wyświetlany na bramce płatniczej

custom
string <= 128 characters

Pole do wykorzystania przez partnera np. do przesłania ID transakcji sklepu

object or null

Podstawowe dane kupującego

name
string <= 64 characters

Imię i Nazwisko lub Nazwa kupującego

email
string <email> <= 64 characters

Adres email kupującego

ip
string <ip>

Adres IP kupującego

object or null

Adresy URL do przekierowania klienta po transakcji

success
string <url> <= 255 characters

Adres URL do przekierowania klienta po prawidłowej transakcji

failure
string <url> <= 255 characters

Adres URL do przekierowania klienta po błędnej transakcji

channelId
string or null

Id kanału płatności

whitelabel
boolean
Default: false

Transakcja typu whitelabel

expiresAt
string or null <datetime>

Data ważności transakcji

Responses

Response Schema: application/json
object
id
required
string (transactionId) = 14 characters ^[A-Z0-9]{4}-[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]...

Identyfikator transakcji

isTest
required
boolean

Informacja czy transakcja utworzona w trybie testowym

redirectUrl
required
string <url>

Adres URL na jaki należy przekierować klienta

Request samples

Content type
application/json
{
  • "amount": 1,
  • "title": "string",
  • "currency": "PLN",
  • "description": "string",
  • "custom": "string",
  • "customer": {},
  • "redirect": {
    • "success": "string",
    • "failure": "string"
    },
  • "channelId": "string",
  • "whitelabel": false,
  • "expiresAt": "string"
}

Szczegóły transakcji

Authorizations:
bearerToken
path Parameters
pointId
required
string (pointId) = 8 characters ^[0-9a-f]{8}$

Identyfikator punktu płatności

transactionId
required
string (transactionId) = 14 characters ^[A-Z0-9]{4}-[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]...

Identyfikator transakcji

Responses

Response Schema: application/json
object
id
required
string (transactionId) = 14 characters ^[A-Z0-9]{4}-[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]...

Identyfikator transakcji

status
required
string (transactionStatus)
Default: "CREATED"
Enum: "CREATED" "PENDING" "PAID" "FAILED" "CANCELLED"

Status transakcji

Status description
CREATED Transakcja utworzona
PENDING Transakcja oczekująca na opłacenie
PAID Transakcja opłacona
FAILED Transakcja odrzucona
CANCELLED Transakcja anulowana
amount
required
number <float>

Kwota transakcji

currency
required
string

Waluta transakcji

commission
required
number or null <float>

Prowizja pobrana z transakcji przez Paymentic

title
required
string

Tytuł transakcji przesłany przez Partnera

description
required
string or null

Opis transakcji przesłany przez partnera

required
object
name
required
string or null

Nazwa Płatnika

email
required
string or null <email>

Adres email Płatnika

custom
required
string or null

Pole dodatkowe przeznaczone do wykorzystania przez Partnera

required
object
success
required
string or null <url>

Adres URL do przekierowania po prawidłowej transakcji

failure
required
string or null <url>

Adres URL do przekierowania po nieudanej transakcji

channelId
required
string or null

Id kanału z jakiego została dokonana transakcja

isTest
required
boolean

Informacja czy transakcja utworzona w trybie testowym

whitelabel
required
boolean

Informacja czy transakcja utworzona w trybie whitelabel

paidAt
required
string or null <ISO 8601>

Data opłacenia transakcji

expiresAt
required
string or null <ISO 8601>

Data wygaśnięcia transakcji

createdAt
required
string <ISO 8601>

Data utworzenia transakcji

Request samples 

curl --location 'https://api.paymentic.com/v1/payment/points/:pointId/transactions/:transactionId' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{bearerToken}}'

Response samples

Content type
application/json
{
  • "data": {
    • "id": "stringstringst",
    • "status": "CREATED",
    • "amount": 0.1,
    • "currency": "string",
    • "commission": 0.1,
    • "title": "string",
    • "description": "string",
    • "customer": {},
    • "custom": "string",
    • "redirect": {
      • "success": "string",
      • "failure": "string"
      },
    • "channelId": "string",
    • "isTest": true,
    • "whitelabel": true,
    • "paidAt": "string",
    • "expiresAt": "string",
    • "createdAt": "string"
    }
}

Kanały płatności

Pobieranie listy kanałów

Authorizations:
bearerToken
path Parameters
pointId
required
string (pointId) = 8 characters ^[0-9a-f]{8}$

Identyfikator punktu płatności

Responses

Response Schema: application/json
Array of objects
Array
id
required
string

ID kanału

available
required
boolean

Czy kanał płatności jest aktualnie dostępny

status
required
string

Status kanału płatności

category
required
string

Kategoria kanału płatności

name
required
string

Nazwa kanału płatości

img
required
string <url>

Adres URL loga kanału płatności

required
object
minimum
required
number <float>

Minimalna kwota płatności dla kanału

maximum
required
number <float>

Maksymalna kwota płatności dla kanału

required
object
value
required
number or null <float>

Prcentowa prowizja pobierana od płatności danym kanałem

minimum
required
number or null <float>

Prowizja minimalna pobierana od płatności danym kanałem

currencies
required
Array of strings <ISO 4217> [ items <ISO 4217 > ]

Waluty dostępne dla kanłu płatności w formacie ISO 4217

enabledAt
required
string or null <date-time>

Data i godzina kiedy kanał zostanie włączony w przypadku gdy jest wyłączony

disablingAt
required
string or null <date-time>

Data i godzina kiedy kanał zostanie wyłączony w przypadku gdy jest włączony

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": "blik",
      • "available": true,
      • "status": "ACTIVE",
      • "category": "BLIK",
      • "name": "BLIK",
      • "img": "https://static.paymentic.com/payment/channels/blik.png",
      • "amount": {
        • "minimum": 0.1,
        • "maximum": 10000
        },
      • "commission": {
        • "value": 1.4,
        • "minimum": 0.1
        },
      • "currencies": [
        • "PLN"
        ],
      • "enablingAt": null,
      • "disablingAt": "2024-09-24T10:00:00+02:00"
      }
    ]
}

Notyfikacje

Paymentic przesyła notyfikacje o zmianach np. w statusie transakcji. Każda notyfikacja zawiera swój unikalny identyfikator prezentowany w nagłówku X-Paymentic-Notification-Id można uznać go za klucz idempotentności ponieważ notyfikacje ponawiane są zgodnie ze schematem dostępnym poniżej.

Aby poinformować, że Partner prawidłowo odebrał i przetworzył powiadomienie należy zwrócić kod HTTP 200 z Content-Type: plain/text i zawartością body OK lub kod HTTP 202 z pustym body

Struktura

Przykładowy request przesłany do strony partnera

GET /yourpath HTTP/1.1
Host: yourdomain.com
User-Agent: Paymentic/1.0
Content-Type: application/json
Content-Length: 170
X-Paymentic-Event: TRANSACTION_STATUS
X-Paymentic-Notification-Id: 01j96yn02bhbv8j1jjtk36zn2t
X-Paymentic-Time: 2024-09-20T09:48:03+02:00
X-Paymentic-Signature: 5Fil+PMpabLxsKwo3rWj9+o6gAi4ub93fismBewbYz46mHt7pjPHcHELUVw8McZ5nUb3feMVVBl+dPzXq2XgLQ==
{"transactionId":"FJRS-LY7-3W0-30K9","pointId":"000cb241","status":"CREATED","amount":10,"currency":"PLN","commission":null,"custom":null,"channelId":null,"isTest":false}

Ponawianie

Wszystkie notyfikacje są ponawiane zgodnie z implementacją wzorca integracyjnego Retry Pattern

Schemat ponawiania notyfikacji (Retry Policy)

Numer powiadomienia Czas
1 natychmiast
od 2 do 10 co minutę
od 11 do 15 co 15 minut
od 16 do 30 co godzinę

Jeżeli ponawianie notyfikacji nie zakończony się powodzeniem, zostanie przerwane po 30 powiadomieniach (Circuit Breaker)

Sygnatura

Paymentic przy każdej notyfikacji przesyła sygnaturę w nagłówku X-Paymentic-Signature

Sygnatura notyfikacji może zostać obliczona za pomocą HASH HMAC SHA512 (RFC 6234).

Struktura do generowania sygnatury

W strukturze należy złączyć wartości (konkatenacja) z nagłówków i body oddzielając jest | (Unicode U+007C) w kolejności: X-Paymentic-Event, User-Agent(Wersja z user-agenta np. 1.0), Body, X-Paymentic-Notification-Id, X-Paymentic-Time

TRANSACTION_STATUS|1.0|{"transactionId":"FJRS-LY7-3W0-30K9","pointId":"000cb241","status":"CREATED","amount":10,"currency":"PLN","commission":null,"custom":null,"channelId":null,"isTest":false}|01j96yn02bhbv8j1jjtk36zn2t|2024-09-20T09:48:03+02:00

Przykłady jak wygenerować sygnaturę w różnych językach

PHP

<?php
$signatureKey = '99ab572393014a7c2f20fe53253fc37819371a033c4507055e94e816683b9c8d';
echo base64_encode(hash_hmac('sha512', 'TRANSACTION_STATUS|1.0|{"transactionId":"FJRS-LY7-3W0-30K9","pointId":"000cb241","status":"CREATED","amount":10,"currency":"PLN","commission":null,"custom":null,"channelId":null,"isTest":false}|01j96yn02bhbv8j1jjtk36zn2t|2024-09-20T09:48:03+02:00', $signatureKey, true));

Python

import hashlib
import hmac
import base64

signatureKey = '99ab572393014a7c2f20fe53253fc37819371a033c4507055e94e816683b9c8d'
message = 'TRANSACTION_STATUS|1.0|{"transactionId":"FJRS-LY7-3W0-30K9","pointId":"000cb241","status":"CREATED","amount":10,"currency":"PLN","commission":null,"custom":null,"channelId":null,"isTest":false}|01j96yn02bhbv8j1jjtk36zn2t|2024-09-20T09:48:03+02:00'

signature = hmac.new(signatureKey.encode('utf-8'), message.encode('utf-8'), hashlib.sha512).digest()
encoded_signature = base64.b64encode(signature).decode('utf-8')

print(encoded_signature)

Przetestuj generowanie sygnatury

Status transakcji Webhook

header Parameters
User-Agent
required
string
Example: Paymentic/1.0

Wersja notyfikacji

X-Paymentic-Event
required
string
Example: TRANSACTION_STATUS

Typ notyfikacji

X-Paymentic-Notification-Id
required
string <ulid>
Example: 01j9wnm31m43e81p2snqn5cp6y

Identyfikator notyfikacji

X-Paymentic-Time
required
string <timestamp>
Example: 2024-09-20T09:48:03+02:00

Czas wysłania notyfikacji

X-Paymentic-Signature
required
string <base64>
Example: 8XYkwtl7wbjf74DUPFab0GP6/us4u91xHectfnxsqr0GQ9aU8Wj/l/g7BSyuwilQ2oVY1Yppnci5/z4CaRPtWQ==

Sygnatura notyfikacji

Request Body schema: application/json
transactionId
required
string (transactionId) = 14 characters ^[A-Z0-9]{4}-[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]...

Identyfikator transakcji

pointId
required
string (pointId) = 8 characters ^[0-9a-f]{8}$

Identyfikator punktu płatności

status
required
string (transactionStatus)
Default: "CREATED"
Enum: "CREATED" "PENDING" "PAID" "FAILED" "CANCELLED"

Status transakcji

Status description
CREATED Transakcja utworzona
PENDING Transakcja oczekująca na opłacenie
PAID Transakcja opłacona
FAILED Transakcja odrzucona
CANCELLED Transakcja anulowana
amount
required
number <float>

Kwota transakcji

currency
required
string <ISO 4217>

Waluta transakcji

commission
required
number or null <float>

Prowizja pobrana z transakcji przez Paymentic

custom
required
string or null

Pole dodatkowe przeznaczone do wykorzystania przez Partnera

channelId
required
string or null

Id kanału płatności

isTest
required
boolean

Informacja czy to transakcja testowa

Responses

Response Schema: text/plain
string
Default: "OK"

Request samples

Content type
application/json
{
  • "transactionId": "1CR6-75T-KVY-DAV3",
  • "pointId": "e99ed63d",
  • "status": "CREATED",
  • "amount": 14.24,
  • "currency": "PLN",
  • "commission": null,
  • "custom": null,
  • "channelId": null,
  • "isTest": false
}

Response samples

Content type
text/plain
OK

Wprowadzenie

Notyfikacje

Przykładowy request przesłany do strony partnera

GET /yourpath HTTP/1.1
Host: yourdomain.com
User-Agent: Paymentic/1.0
Content-Type: application/json
Content-Length: 201
X-Paymentic-Notification-Id: 01J5SXAG3D5MZXCZQ4P567ECQ8
X-Paymentic-Time: 1724226165
X-Paymentic-Signature: 8XYkwtl7wbjf74DUPFab0GP6/us4u91xHectfnxsqr0GQ9aU8Wj/l/g7BSyuwilQ2oVY1Yppnci5/z4CaRPtWQ==
{"transactionId":"CR6-75T-KVY-DAV4","pointId":"e99ed63d","status":"PENDING","amount":14.24,"currency":"PLN","commission":null,"custom":null,"msisdn":"48987654321","mccmnc":null,"isTest":false}

Ponawianie notyfikacji

Próba

Sygnatura notyfikacji

Sygnatura notyfikacji może zostać obliczona za pomocą HMAC SHA512.

Struktura do generowania sygnatury

1.0|{"transactionId":"CR6-75T-KVY-DAV4"}|01J5SXAG3D5MZXCZQ4P567ECQ8|1724226165

Klucz do sygnatury używany do wygenerowania przykładowej sygnatury d3d2503c-478e-405d-b453-33e63b1ce962

Przykładowa syngatura z danych podanych wyżej

ZKpOXsLkxz95TL5MLK4owl6WZ66489XDR6M9BayCmH2u4zbzeePho/FsHoxlgvwO2rEZ5njJ0puxgLiCQYoi2w==

Przykłady jak wygenerować sygnaturę w różnych językach

PHP

<?php
$signatureKey = 'd3d2503c-478e-405d-b453-33e63b1ce962';
echo base64_encode(hash_hmac('sha512', '1.0|{"transactionId":"CR6-75T-KVY-DAV4"}|01J5SXAG3D5MZXCZQ4P567ECQ8|1724226165', $signatureKey, true));

Przetestuj generowanie sygnatury

Notyfikacja Webhook

header Parameters
User-Agent
required
string
Example: Paymentic/1.0

Wersja notyfikacji

X-Paymentic-Notification-Id
required
string <ulid>
Example: 01j5sxag3d5mzxczq4p567ecq8

Identyfikator notyfikacji

X-Paymentic-Time
required
string <ISO 8601>
Example: 2024-09-20T09:48:03+02:00

Czas wysłania notyfikacji

X-Paymentic-Signature
required
string <base64>
Example: 8XYkwtl7wbjf74DUPFab0GP6/us4u91xHectfnxsqr0GQ9aU8Wj/l/g7BSyuwilQ2oVY1Yppnci5/z4CaRPtWQ==

Sygnatura notyfikacji

Request Body schema: application/json
transactionId
required
string (schemas-transactionId) = 13 characters ^[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]...

Identyfikator transakcji

pointId
required
string (pointId) = 8 characters ^[0-9a-f]{8}$

Identyfikator punktu płatności

status
required
string (transactionStatus)
Default: "CREATED"
Enum: "CREATED" "PENDING" "PAID" "FAILED" "CANCELLED"

Status transakcji

Status description
CREATED Transakcja utworzona
PENDING Transakcja oczekująca na opłacenie
PAID Transakcja opłacona
FAILED Transakcja odrzucona
CANCELLED Transakcja anulowana
amount
required
number <float>

Kwota transakcji

commission
required
number <float>

Prowizja przysługująca z transakcji Partnerowi

custom
required
string or null

Pole dodatkowe przeznaczone do wykorzystania przez Partnera

msisdn
required
string or null^48\d{9}$

Numer telefonu

mccmnc
required
number or null <int>

Kod MCC MNC operatora płatności

isTest
required
boolean

Informacja czy to transakcja testowa

Responses

Response Schema: text/plain
string
Default: "OK"

Request samples

Content type
application/json
{
  • "transactionId": "CR6-75T-KVY-DAV4",
  • "pointId": "e99ed63d",
  • "status": "PENDING",
  • "amount": 14.24,
  • "commission": null,
  • "custom": null,
  • "msisdn": "48987654321",
  • "mccmnc": 26001,
  • "isTest": false
}

Response samples

Content type
text/plain
OK

Transakcje

Generowanie transakcji

Authorizations:
bearerToken
path Parameters
pointId
required
string (pointId) = 8 characters ^[0-9a-f]{8}$

Identyfikator punktu płatności

Request Body schema: application/json
amount
required
number <float> >= 1

Kwota netto transakcji

title
required
string [ 5 .. 32 ] characters

Tytuł transakcji wyświetlany na bramce płatniczej i wiadomości SMS z kodem wysyłanym do klienta

description
string <= 128 characters

Szczegółowy opis transakcji wyświetlany na bramce płatniczej

custom
string <= 64 characters

Pole do wykorzystania przez partnera

msisdn
string (msisdn) ^48\d{9}$

Numer telefonu

object or null

Adresy URL do przekierowania klienta po transakcji

success
string <url> <= 255 characters
failure
string <url> <= 255 characters

Responses

Response Schema: application/json
object
id
required
string (schemas-transactionId) = 13 characters ^[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]...

Identyfikator transakcji

isTest
required
boolean

Informacja czy transakcja utworzona w trybie testowym

redirectUrl
required
string <url>

Adres URL na jaki należy przekierować klienta

Request samples

Content type
application/json
{
  • "amount": 1,
  • "title": "string",
  • "description": "string",
  • "custom": "string",
  • "msisdn": "48987654321",
  • "returns": {
    • "success": "string",
    • "failure": "string"
    }
}

Pobieranie informacji o transakcji

Authorizations:
bearerToken
path Parameters
pointId
required
string (pointId) = 8 characters ^[0-9a-f]{8}$

Identyfikator punktu płatności

transactionId
required
string (schemas-transactionId) = 13 characters ^[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]...

Identyfikator transakcji

Responses

Response Schema: application/json
object
id
required
string (schemas-transactionId) = 13 characters ^[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]...

Identyfikator transakcji

status
required
string (transactionStatus)
Default: "CREATED"
Enum: "CREATED" "PENDING" "PAID" "FAILED" "CANCELLED"

Status transakcji

Status description
CREATED Transakcja utworzona
PENDING Transakcja oczekująca na opłacenie
PAID Transakcja opłacona
FAILED Transakcja odrzucona
CANCELLED Transakcja anulowana
amount
required
number

Kwota transakcji

currency
required
string or null <ISO 4217>

Waluta transakcji

commission
required
number or null <float>

Prowizja przysługująca Partnerowi z transakcji

title
required
string

Tytuł transakcji

description
required
string

Opis transakcji

msisdn
required
string (msisdn) ^48\d{9}$

Numer telefonu

mccmnc
required
number

Kod operatora telefonicznego numeru

custom
required
string

Pole do wykorzystania przez partnera

paidAt
required
string or null <date-time>

Data opłacenia transakcji

createdAt
required
string <date-time>

Data utworzenia transakcji

Request samples 

curl -L -X GET 'https://api.paymentic.com/v1/directbilling/:pointId/transactions/:transactionId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {{bearerToken}}'

Response samples

Content type
application/json
{
  • "data": {
    • "id": "H9P-DC5-954-C5Q0",
    • "status": "PAID",
    • "amount": 10.24,
    • "currency": "PLN",
    • "commission": 4.3,
    • "title": "Doładowanie smoczych monet",
    • "description": "Gracz doładowuje 30 smocznych monet na serwerze gry",
    • "msisdn": "48987654321",
    • "mncmcc": 26001,
    • "custom": "6d492b3a-2d5e-4fd2-a7b2-5087204f6d6d",
    • "paidAt": "2019-08-24T14:15:22+02:00",
    • "createdAt": "2019-08-24T14:15:22+02:00"
    }
}

Zwroty

API DirectBilling pozwala zwracać całość pobranej kwoty za daną transakcję bezpośrednio na konto użytkownika. Zworty realizowane są przez operatorów. Po utworzeniu zwrotu otrzyma on status CREATED następnie musi zostać zaakceptowany przez Paymentic

W przypadku gdy spróbujemy zlecić zwrot dla starszej niż 90 dni, otrzymamy response z kodem 400 i errorCode TRANSACTION_TOO_OLD

Utworzenie zwrotu

Authorizations:
bearerToken
path Parameters
pointId
required
string (pointId) = 8 characters ^[0-9a-f]{8}$

Identyfikator punktu płatności

transactionId
required
string (schemas-transactionId) = 13 characters ^[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]{3}-[A-Z0-9]...

Identyfikator transakcji

Request Body schema: application/json
msisdn
required
string (msisdn) ^48\d{9}$

Numer telefonu

reason
required
string
Enum: "RMA" "OTHER"
description
string or null [ 10 .. 128 ] characters

Opis powodu zwrotu transakcji

Responses

Response Schema: application/json
object
id
required
string <ulid>

ID zgłoszenia zwrotu

Request samples

Content type
application/json
{
  • "msisdn": "48987654321",
  • "reason": "RMA",
  • "description": "stringstri"
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": "01J68MV9ETHAWEZS2JH7F8DQZ3"
    }
}