Prepaid top-up - GlobKurier

Request

Header Params

Accept-Language

string

optional

Example:

pl

X-Auth-Token

string

required

Body Params application/json

onlinePaymentMethodId

integer

optional

Payment method identifier taken from the /onlinePayments/methods resource. If the parameter is not provided, the API will return a payment link where the user will be able to choose their preferred payment method.

Example:

2

amount

number

required

Amount

Example:

100

returnLink

string

required

The default URL to which the user will be redirected after completing the payment process, regardless of its outcome (success or failure), in case the returnSuccessLink or returnFailureLink parameters are not provided.

Example:

https://test-url.com

returnSuccessLink

string

optional

URL to which the user will be redirected after a successful payment on an external transaction page. If not provided, the user will be automatically redirected to the address specified in the returnLink parameter.

Example:

https://test-url.com/success

returnFailureLink

string

optional

URL to which the user will be redirected in case of an unsuccessful payment on an external transaction page. If the parameter is not provided, the user will be automatically redirected to the address specified in the returnLink parameter.

Example:

https://test-url.com/failure

Example

{
    "onlinePaymentMethodId": 2,
    "amount": 100,
    "returnLink": "https://test-url.com",
    "returnSuccessLink": "https://test-url.com/success",
    "returnFailureLink": "https://test-url.com/failure"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://test.api.globkurier.pl/v1/onlinePayment/generateForm/prepaidRecharge' \
--header 'Accept-Language: pl' \
--header 'X-Auth-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "onlinePaymentMethodId": 2,
    "amount": 100,
    "returnLink": "https://test-url.com",
    "returnSuccessLink": "https://test-url.com/success",
    "returnFailureLink": "https://test-url.com/failure"
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}