Pobranie informacji o możliwości dokonania zwrotu Run in API Explorer

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/imoje-api/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
"imoje API MCP server": {
  "url": "https://bump.sh/pgw/doc/imoje-api/mcp"
}
Close
POST /{merchantId}/transaction/{transactionId}/can-refund
Token autoryzacyjny

Zapytanie umożliwia uzyskanie informacji jaka jest dopuszczalna wartość zwrotu całoścowego i częściowego dla danej transakcji.

Path parameters

  • merchantId string Required

    Identyfikator klienta

  • transactionId string(uuid) Required

    Identyfikator transakcji jako UUID v4

    Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.

application/json

Body Required

  • amount integer Required

    Kwota transakcji w najmniejszej jednostce waluty np. grosze.

Responses

  • 200 application/json

    Zapytanie wykonane poprawnie

    Hide response attributes Show response attributes object
    • id string(uuid)

      Identyfikator transakcji jako UUID v4

      Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.

    • refundable boolean

      Informacja czy transakcja może zostać zwrócona.

    • balance boolean

      Informacja czy saldo sklepu jest wystarczające do zrobienia zwrotu.

    • fullRefund integer

      Wartość pełnej kwoty zwrotu.

    • partialRefund object

      Maksymalna i minimalna dozwolona wartość zwrotu częściowego.

      Hide partialRefund attributes Show partialRefund attributes object
      • maxRefundAmount integer

        Maksymalna dozwolona wartość zwrotu częściowego.

      • minRefundAmount integer

        Minimalna dozwolona wartość zwrotu częściowego.

      • * string | integer | number | boolean | object | array Additional properties

        Dodatkowe parametry, które nie są opisane i mogą pojawić się w odpowiedzi w ramach rozwoju API.

        Twój schemat walidacyjny odpowiedzi API powinien zawsze dopuszczać nowe parametry.

    • * string | integer | number | boolean | object | array Additional properties

      Dodatkowe parametry, które nie są opisane i mogą pojawić się w odpowiedzi w ramach rozwoju API.

      Twój schemat walidacyjny odpowiedzi API powinien zawsze dopuszczać nowe parametry.
POST /{merchantId}/transaction/{transactionId}/can-refund 
curl \
 --request POST 'https://api.imoje.pl/v1/merchant/{merchantId}/transaction/{transactionId}/can-refund' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"amount":10000}'
Request example 
{
  "amount": 10000
}
Response examples (200) 
{
  "id": "a8b67878-8236-4051-bc91-56d30073d97a",
  "refundable": true,
  "balance": true,
  "fullRefund": 10000,
  "partialRefund": {
    "maxRefundAmount": 10000,
    "minRefundAmount": 1
  }
}