Paths
auth
POST /card/{siteId}/operations/auth
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
siteId |
siteId |
string |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
ok |
|
400 |
client error |
|
500 |
technical error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
card-controller
payout
POST /card/{siteId}/operations/payout
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
siteId |
siteId |
string |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
ok |
|
400 |
client error |
|
500 |
technical error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
card-controller
purchase
POST /card/{siteId}/operations/purchase
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
siteId |
siteId |
string |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
ok |
|
400 |
client error |
|
500 |
technical error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
card-controller
recurring
POST /card/{siteId}/operations/recurring
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
siteId |
siteId |
string |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
ok |
|
400 |
client error |
|
500 |
technical error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
card-controller
statusByExternalId
GET /card/{siteId}/operations/status
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
siteId |
siteId |
string |
Query |
externalId |
externalId |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
ok |
|
400 |
client error |
|
500 |
technical error |
Produces
-
application/json
Tags
-
card-controller
status
GET /card/{siteId}/operations/{operationId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
operationId |
operationId |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
ok |
|
400 |
client error |
|
500 |
technical error |
Produces
-
application/json
Tags
-
card-controller
capture
POST /card/{siteId}/operations/{operationId}/capture
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
operationId |
operationId |
string |
Path |
siteId |
siteId |
string |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
ok |
|
400 |
client error |
|
500 |
technical error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
card-controller
complete3ds
POST /card/{siteId}/operations/{operationId}/complete3ds
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
operationId |
operationId |
string |
Path |
siteId |
siteId |
string |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
ok |
|
400 |
client error |
|
500 |
technical error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
card-controller
decline
POST /card/{siteId}/operations/{operationId}/decline
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
operationId |
operationId |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
ok |
|
400 |
client error |
|
500 |
technical error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
card-controller
refund
POST /card/{siteId}/operations/{operationId}/refund
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
operationId |
operationId |
string |
Path |
siteId |
siteId |
string |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
ok |
|
400 |
client error |
|
500 |
technical error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
card-controller
reversal
POST /card/{siteId}/operations/{operationId}/reversal
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
operationId |
operationId |
string |
Path |
siteId |
siteId |
string |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
ok |
|
400 |
client error |
|
500 |
technical error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
card-controller
createPaymentLink
POST /paymentpageapi/{siteId}/create_payment_link
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
siteId |
siteId |
string |
Body |
request |
request |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
ok |
|
400 |
client error |
|
500 |
technical error |
Consumes
-
application/json
Produces
-
application/json
Tags
-
payment-page-api-controller
merchant callback
POST /test/emptycallback
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
notification |
notification |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
Consumes
-
application/json
Produces
-
application/json
Tags
-
test-endpoints-controller
Definitions
Action
Name | Description | Schema |
---|---|---|
type |
Example : |
string |
Actions
Name | Schema |
---|---|
required |
< Action > array |
CaptureRequest
Name | Description | Schema |
---|---|---|
amount |
||
externalId |
Pattern : |
string |
merchantParameters |
||
notification |
Card
Card with cvv
Polymorphism : Composition
Name | Description | Schema |
---|---|---|
cvv |
Pattern : |
string |
expMonth |
Minimum value : |
integer (int32) |
expYear |
Minimum value : |
integer (int32) |
pan |
Length : |
string |
Complete3dsRequest
Name | Schema |
---|---|
paRes |
string |
DeclineResponse
Name | Schema |
---|---|
errors |
< Error > array |
Error
Name | Description | Schema |
---|---|---|
code |
Example : |
integer (int32) |
description |
Example : |
string |
details |
< string, string > map |
GenericResponse
Name | Description | Schema |
---|---|---|
actions |
||
externalId |
Example : |
string |
operationId |
Example : |
string |
params |
< string, string > map |
|
status |
Example : |
enum (CREATED, EXPIRED, IN_PROGRESS, WAITING_FOR_CONFIRMATION, SUCCEEDED, DECLINED, DECLINED_WITH_ATTEMPTS_LEFT) |
type |
Example : |
enum (PURCHASE, REFUND, AUTH, CAPTURE, REVERSAL, RECURRING, PAYOUT) |
LinkResponse
Name | Description | Schema |
---|---|---|
operationId |
Example : |
string |
url |
Example : |
string |
MerchantNotificationDtoV1
Name | Description | Schema |
---|---|---|
amount |
||
baseAmount |
||
externalId |
Example : |
string |
id |
Example : |
string |
merchantParameters |
||
payer |
||
registeredMethods |
< PaymentMethodDTO > array |
|
status |
Example : |
enum (CREATED, EXPIRED, IN_PROGRESS, WAITING_FOR_CONFIRMATION, SUCCEEDED, DECLINED, DECLINED_WITH_ATTEMPTS_LEFT) |
successful |
boolean |
|
transactions |
< NotificationTransactionDTO > array |
|
type |
Example : |
string |
MerchantParameters
Name | Description | Schema |
---|---|---|
param1 |
Length : |
string |
param2 |
Length : |
string |
param3 |
Length : |
string |
customerId |
Length : |
string |
customerEmail |
Length : |
string |
customerName |
Length : |
string |
customerIp |
Length : |
string |
MonetaryAmount
Name | Description | Schema |
---|---|---|
amount |
Minimum value (exclusive) : |
number |
currency |
Pattern : |
string |
Mono«ResponseEntity«SerializableApiResponse»»
Type : object
Mono«ResponseEntity«object»»
Type : object
Notification
Name | Description | Schema |
---|---|---|
url |
Example : |
string |
version |
NotificationTransactionDTO
Name | Schema |
---|---|
description |
string |
status |
enum (CREATED, SUCCEEDED, DECLINED, PRECONDITION_FAILED, WAITING_FOR_CONFIRMATION) |
type |
enum (PURCHASE, REFUND, AUTH, CAPTURE, REVERSAL, RECURRING, COMPLETE3DS, PAYOUT) |
Optional«int»
Name | Schema |
---|---|
empty |
boolean |
present |
boolean |
PageParameters
Name | Description | Schema |
---|---|---|
description |
Length : |
string |
urlOnDecline |
Example : |
string |
urlOnSuccess |
Example : |
string |
Payer
Name | Schema |
---|---|
info |
< string, string > map |
paymentMethod |
PaymentLinkCreationRequest
Name | Description | Schema |
---|---|---|
action |
Example : |
enum (auth, purchase) |
amount |
||
externalId |
Pattern : |
string |
merchantParameters |
||
notification |
||
pageParameters |
||
registerRecurring |
boolean |
PaymentMethodDTO
Name | Schema |
---|---|
entity |
PaymentMethodDTOEntity
Look at concrete implementation: Card, NoCvvCard, RecurringTokenDTO
Type : object
PayoutRequest
Name | Description | Schema |
---|---|---|
amount |
||
externalId |
Pattern : |
string |
merchantParameters |
||
notification |
||
receiver |
PurchaseRequest
Name | Description | Schema |
---|---|---|
amount |
||
externalId |
Pattern : |
string |
merchantParameters |
||
notification |
||
payer |
||
registerRecurring |
boolean |
Receiver
Name | Description | Schema |
---|---|---|
info |
< string, string > map |
|
name |
Length : |
string |
paymentMethod |
||
surname |
Length : |
string |
RecurringRequest
Name | Description | Schema |
---|---|---|
amount |
||
externalId |
Pattern : |
string |
merchantParameters |
||
notification |
||
payer |
RecurringTokenDTO
Recurring token
Polymorphism : Composition
Name | Description | Schema |
---|---|---|
id |
Pattern : |
string |
RefundRequest
Name | Description | Schema |
---|---|---|
amount |
||
externalId |
Pattern : |
string |
merchantParameters |
||
notification |
SerializableApiResponse
Type : object
SimpleRequest
Name | Description | Schema |
---|---|---|
externalId |
Pattern : |
string |
merchantParameters |
||
notification |