Introduction

Base URL: http://girocheckout-api

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

This API is not authenticated.

Endpoints

GET api/user

Example request:

curl --request GET \
    --get "http://girocheckout-api/api/user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://girocheckout-api/api/user"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *


{
    "message": "Unauthenticated."
}

Received response:

Request failed with error:

GET api/heartbeat

Example request:

curl --request GET \
    --get "http://girocheckout-api/api/heartbeat" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://girocheckout-api/api/heartbeat"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 58
access-control-allow-origin: *


{
    "ping": "pong"
}

Received response:

Request failed with error:

POST api/transaction/start

Example request:

curl --request POST \
    "http://girocheckout-api/api/transaction/start" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"merchantId\": 4,
    \"projectId\": 16,
    \"merchantTxId\": \"iste\",
    \"amount\": 20,
    \"currency\": \"dolor\",
    \"purpose\": \"corporis\",
    \"type\": \"qui\",
    \"urlRedirect\": \"repudiandae\",
    \"urlNotify\": \"voluptatem\"
}"

const url = new URL(
    "http://girocheckout-api/api/transaction/start"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "merchantId": 4,
    "projectId": 16,
    "merchantTxId": "iste",
    "amount": 20,
    "currency": "dolor",
    "purpose": "corporis",
    "type": "qui",
    "urlRedirect": "repudiandae",
    "urlNotify": "voluptatem"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:

Request

POST api/transaction/start

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

merchantId integer optional

Example: 4

projectId integer

Example: 16

merchantTxId string

Example: iste

amount integer

Example: 20

currency string

Example: dolor

purpose string

Example: corporis

type string

Example: qui

urlRedirect string

Example: repudiandae

urlNotify string

Example: voluptatem

kassenzeichen string optional

pptoken string optional

hash string optional

POST api/transaction/refund

Example request:

curl --request POST \
    "http://girocheckout-api/api/transaction/refund" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"merchantId\": 13,
    \"projectId\": 17,
    \"merchantTxId\": \"rerum\",
    \"amount\": 2,
    \"currency\": \"quidem\",
    \"reference\": \"0e96ee88-4169-3021-90b6-c33d2620f472\"
}"

const url = new URL(
    "http://girocheckout-api/api/transaction/refund"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "merchantId": 13,
    "projectId": 17,
    "merchantTxId": "rerum",
    "amount": 2,
    "currency": "quidem",
    "reference": "0e96ee88-4169-3021-90b6-c33d2620f472"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:

Request

POST api/transaction/refund

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

merchantId integer optional

Example: 13

projectId integer

Example: 17

merchantTxId string

Example: rerum

amount integer

Example: 2

currency string

Example: quidem

purpose string optional

reference string optional

Must be a valid UUID. Example: 0e96ee88-4169-3021-90b6-c33d2620f472

kassenzeichen string optional

hash string optional

POST api/transaction/capture

Example request:

curl --request POST \
    "http://girocheckout-api/api/transaction/capture" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"merchantId\": 2,
    \"projectId\": 6,
    \"merchantTxId\": \"ut\",
    \"amount\": 7,
    \"currency\": \"hic\",
    \"reference\": \"fd041af4-d06a-3892-b2bd-8d967e1fa260\"
}"

const url = new URL(
    "http://girocheckout-api/api/transaction/capture"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "merchantId": 2,
    "projectId": 6,
    "merchantTxId": "ut",
    "amount": 7,
    "currency": "hic",
    "reference": "fd041af4-d06a-3892-b2bd-8d967e1fa260"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:

Request

POST api/transaction/capture

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

merchantId integer optional

Example: 2

projectId integer

Example: 6

merchantTxId string

Example: ut

amount integer

Example: 7

currency string

Example: hic

purpose string optional

reference string optional

Must be a valid UUID. Example: fd041af4-d06a-3892-b2bd-8d967e1fa260

hash string optional

POST api/transaction/void

Example request:

curl --request POST \
    "http://girocheckout-api/api/transaction/void" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"merchantId\": 12,
    \"projectId\": 11,
    \"merchantTxId\": \"voluptas\",
    \"reference\": \"43df63e4-1a0f-32b2-8d33-14298e9a5f71\"
}"

const url = new URL(
    "http://girocheckout-api/api/transaction/void"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "merchantId": 12,
    "projectId": 11,
    "merchantTxId": "voluptas",
    "reference": "43df63e4-1a0f-32b2-8d33-14298e9a5f71"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:

Request

POST api/transaction/void

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

merchantId integer optional

Example: 12

projectId integer

Example: 11

merchantTxId string

Example: voluptas

reference string optional

Must be a valid UUID. Example: 43df63e4-1a0f-32b2-8d33-14298e9a5f71

hash string optional

GET api/transaction/finish/{pid}/{mode}/{uuid}

Example request:

curl --request GET \
    --get "http://girocheckout-api/api/transaction/finish/fugit/minima/16d775f0-beb4-3a37-a484-cea5c99e7bea" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"mode\": \"fail\",
    \"Len\": 10,
    \"Data\": \"quisquam\"
}"

const url = new URL(
    "http://girocheckout-api/api/transaction/finish/fugit/minima/16d775f0-beb4-3a37-a484-cea5c99e7bea"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "mode": "fail",
    "Len": 10,
    "Data": "quisquam"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (500):

Show headers

cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 57
access-control-allow-origin: *


{
    "message": "Typed property App\\Rules\\TransactionExists::$projectId must not be accessed before initialization",
    "exception": "Error",
    "file": "C:\\xampp\\htdocs\\girocheckout-api\\app\\Rules\\TransactionExists.php",
    "line": 16,
    "trace": [
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\app\\Rules\\TransactionExists.php",
            "line": 28,
            "function": "getProjectId",
            "class": "App\\Rules\\TransactionExists",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Validation\\InvokableValidationRule.php",
            "line": 103,
            "function": "validate",
            "class": "App\\Rules\\TransactionExists",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Validation\\Validator.php",
            "line": 819,
            "function": "passes",
            "class": "Illuminate\\Validation\\InvokableValidationRule",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Validation\\Validator.php",
            "line": 610,
            "function": "validateUsingCustomRule",
            "class": "Illuminate\\Validation\\Validator",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Validation\\Validator.php",
            "line": 422,
            "function": "validateAttribute",
            "class": "Illuminate\\Validation\\Validator",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Validation\\Validator.php",
            "line": 453,
            "function": "passes",
            "class": "Illuminate\\Validation\\Validator",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Validation\\ValidatesWhenResolvedTrait.php",
            "line": 31,
            "function": "fails",
            "class": "Illuminate\\Validation\\Validator",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Providers\\FormRequestServiceProvider.php",
            "line": 30,
            "function": "validateResolved",
            "class": "Illuminate\\Foundation\\Http\\FormRequest",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Container.php",
            "line": 1304,
            "function": "Illuminate\\Foundation\\Providers\\{closure}",
            "class": "Illuminate\\Foundation\\Providers\\FormRequestServiceProvider",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Container.php",
            "line": 1269,
            "function": "fireCallbackArray",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Container.php",
            "line": 1254,
            "function": "fireAfterResolvingCallbacks",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Container.php",
            "line": 815,
            "function": "fireResolvingCallbacks",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Application.php",
            "line": 933,
            "function": "resolve",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Container.php",
            "line": 731,
            "function": "resolve",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Application.php",
            "line": 918,
            "function": "make",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\ResolvesRouteDependencies.php",
            "line": 85,
            "function": "make",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\ResolvesRouteDependencies.php",
            "line": 50,
            "function": "transformDependency",
            "class": "Illuminate\\Routing\\ControllerDispatcher",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\ResolvesRouteDependencies.php",
            "line": 30,
            "function": "resolveMethodDependencies",
            "class": "Illuminate\\Routing\\ControllerDispatcher",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\ControllerDispatcher.php",
            "line": 60,
            "function": "resolveClassMethodDependencies",
            "class": "Illuminate\\Routing\\ControllerDispatcher",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\ControllerDispatcher.php",
            "line": 40,
            "function": "resolveParameters",
            "class": "Illuminate\\Routing\\ControllerDispatcher",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Route.php",
            "line": 260,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\ControllerDispatcher",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Route.php",
            "line": 205,
            "function": "runController",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 798,
            "function": "run",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 141,
            "function": "Illuminate\\Routing\\{closure}",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Middleware\\SubstituteBindings.php",
            "line": 50,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\SubstituteBindings",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Middleware\\ThrottleRequests.php",
            "line": 126,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Middleware\\ThrottleRequests.php",
            "line": 102,
            "function": "handleRequest",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Middleware\\ThrottleRequests.php",
            "line": 54,
            "function": "handleRequestUsingNamedLimiter",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\ThrottleRequests",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 116,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 799,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 776,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 740,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Routing\\Router.php",
            "line": 729,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 200,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 141,
            "function": "Illuminate\\Foundation\\Http\\{closure}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\TrimStrings.php",
            "line": 40,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize.php",
            "line": 27,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance.php",
            "line": 86,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Http\\Middleware\\HandleCors.php",
            "line": 62,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\HandleCors",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Http\\Middleware\\TrustProxies.php",
            "line": 39,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 180,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\TrustProxies",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Pipeline\\Pipeline.php",
            "line": 116,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 175,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Http\\Kernel.php",
            "line": 144,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 299,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 287,
            "function": "callLaravelOrLumenRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 92,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 45,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Strategies\\Responses\\ResponseCalls.php",
            "line": 35,
            "function": "makeResponseCallIfConditionsPass",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 209,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 166,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\knuckleswtf\\scribe\\src\\Extracting\\Extractor.php",
            "line": 95,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 124,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 71,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\knuckleswtf\\scribe\\src\\GroupedEndpoints\\GroupedEndpointsFromApp.php",
            "line": 49,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\knuckleswtf\\scribe\\src\\Commands\\GenerateDocumentation.php",
            "line": 51,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Util.php",
            "line": 41,
            "function": "Illuminate\\Container\\{closure}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 93,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\BoundMethod.php",
            "line": 37,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Container\\Container.php",
            "line": 662,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Console\\Command.php",
            "line": 194,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\symfony\\console\\Command\\Command.php",
            "line": 312,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Console\\Command.php",
            "line": 164,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\symfony\\console\\Application.php",
            "line": 1040,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\symfony\\console\\Application.php",
            "line": 314,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\symfony\\console\\Application.php",
            "line": 168,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\vendor\\laravel\\framework\\src\\Illuminate\\Foundation\\Console\\Kernel.php",
            "line": 200,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "C:\\xampp\\htdocs\\girocheckout-api\\artisan",
            "line": 37,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        }
    ]
}

Received response:

Request failed with error:

Request

GET api/transaction/finish/{pid}/{mode}/{uuid}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

URL Parameters

pid string

Example: fugit

mode string

Example: minima

uuid string

Example: 16d775f0-beb4-3a37-a484-cea5c99e7bea

Body Parameters

pid string optional

mode string optional

Must be one of success, notify, or fail. Example: fail

uuid string optional

Len integer optional

Example: 10

Data string

Example: quisquam

Introduction

Authenticating requests

Endpoints

GET api/user

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

GET api/heartbeat

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

POST api/transaction/start

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/transaction/refund

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/transaction/capture

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

POST api/transaction/void

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

GET api/transaction/finish/{pid}/{mode}/{uuid}

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Body Parameters

Request

Request

Request

Request

Request

Request

Request