8.2. Obciążenie istniejącego profilu

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://bump.sh/pgw/doc/axepta-api/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
"axepta API MCP server": {
  "url": "https://bump.sh/pgw/doc/axepta-api/mcp"
}
Close

Po prawidłowej rejestracji profilu zwrotnie zostanie przesłany parametr 'paymentProfileId', który jest wymagany aby móc obciążyć dany profil. Aby obciążyć istniejący profil w systemie należy wysyłać żądanie POST na adres:

https://api.axepta.pl/v1/merchant/{merchantId}/transaction/profile

gdzie:

  • merchantId - identyfikator klienta.

Przykładowy adres na który należy wysłać żądanie POST

https://api.axepta.pl/v1/merchant/6yt3gjtm9p7b8h9xsdqz/transaction/profile

Payload zapytania

{
    "serviceId": "63f574ed-d4ad-407e-9981-39ed7584a7b7",
    "paymentProfileId": "39ac1087-e632-41ff-acb8-8d661068a9d5",
    "amount": 100,
    "currency": "PLN",
    "orderId": "123456",
}

gdzie:

Parametr Typ Wymagany Opis
serviceId string(36) ✔️ identyfikator sklepu jako UUID v4.
paymentProfileId string(36) ✔️ identyfikator profilu który ma zostać obciążony.
amount integer(1-999999999) ✔️ Kwota transakcji w najmniejszej jednostce waluty np. grosze.
currency string(3) ✔️ Waluta transakcji w standardzie ISO 4217.
orderID string(100) ✔️ Numer zamówienia akceptanta - dopuszczalne znaki: A-Za-z0-9#_-.\/ oraz znak spacji(0x20) i znaki z zakresu UNICODE 00C0 - 02C0 (m.in. polskie znaki diakrytyczne)
title string(255) - Tytuł transakcji - dopuszczalne znaki: A-Za-z0-9#&_-"',.\/ oraz znak spacji(0x20) i znaki z zakresu UNICODE 00C0 - 02C0 (m.in. polskie znaki diakrytyczne)

Możliwe statusy

Próba obciążenia profilu może przyjąć dwa statusy:

Status Typ Opis
Success string Powodzenie - obciążono profil
Fail string Błąd - profil nie został obciążony

Odpowiedź serwera

W przypadku próby obciążenia nieaktywnego profilu odpowiedź będzie wyglądać:

{
    "status": "FAIL",
    "message": "Payment profile inactive.",
    "data": {
        "errorCode": "PAYMENT_PROFILE_INACTIVE",
        "errorId": 120301,
        "bqh": "6jO"
    }
}

gdzie:

Parametr Typ Opis
code string Kod błędu walidacji treści żądania
message string Opis błędu
serviceId string(36) identyfikator sklepu jako UUID v4.
paymentProfileId string(36) identyfikator profilu który ma zostać obciążony.
amount integer(1-999999999) Kwota transakcji w najmniejszej jednostce waluty np. grosze.
currency string(3) Waluta transakcji w standardzie ISO 4217.
orderID string(100) Numer zamówienia akceptanta - dopuszczalne znaki: A-Za-z0-9#_-.\/ oraz znak spacji(0x20) i znaki z zakresu UNICODE 00C0 - 02C0 (m.in. polskie znaki diakrytyczne)

Opisy ErrorCode

W przypadku otrzymania statusu "FAIL" w odpowiedzi serwera mogą wystąpić nastepujące błędy ("errorCode"):

errorCode Typ Opis
PAYMENT_PROFILE_INACTIVE string Profil płatności dezaktywowany
PAYMENT_PROFILE_NOT_FOUND string Profil płatności nie odnaleziony
SCHEMA_VALIDATION string Błąd walidacji znaków. Payload zapytania jest nie właściwy, lub nie spełnia wymagań znakowych