Paths

auth

POST /card/{siteId}/operations/auth

Parameters

Type Name Description Schema

Path

siteId
required

siteId

string

Body

request
required

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
required

siteId

string

Body

request
required

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
required

siteId

string

Body

request
required

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
required

siteId

string

Body

request
required

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
required

siteId

string

Query

externalId
required

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
required

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
required

operationId

string

Path

siteId
required

siteId

string

Body

request
required

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
required

operationId

string

Path

siteId
required

siteId

string

Body

request
required

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
required

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
required

operationId

string

Path

siteId
required

siteId

string

Body

request
required

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
required

operationId

string

Path

siteId
required

siteId

string

Body

request
required

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
required

siteId

string

Body

request
required

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
required

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
required

Example : "status"

string

Actions

Name Schema

required
required

< Action > array

CaptureRequest

Name Description Schema

amount
required

externalId
required

Pattern : "^[a-zA-Z0-9\\-_.#()]{1,100}$"

string

merchantParameters
required

notification
required

Card

Card with cvv

Polymorphism : Composition

Name Description Schema

cvv
required

Pattern : "[0-9]{3}"
Example : "123"

string

expMonth
optional

Minimum value : 1
Maximum value : 12
Example : 12

integer (int32)

expYear
required

Minimum value : 2018
Maximum value : 2050
Example : 2020

integer (int32)

pan
required

Length : 12 - 19
Example : "4111111111111111"

string

Complete3dsRequest

Name Schema

paRes
required

string

DeclineResponse

Name Schema

errors
required

< Error > array

Error

Name Description Schema

code
required

Example : 12

integer (int32)

description
required

Example : "invalid value"

string

details
required

< string, string > map

GenericResponse

Name Description Schema

actions
optional

externalId
required

Example : "ext#2"

string

operationId
required

Example : "1-1-a-123"

string

params
optional

< string, string > map

status
required

Example : "SUCCEEDED"

enum (CREATED, EXPIRED, IN_PROGRESS, WAITING_FOR_CONFIRMATION, SUCCEEDED, DECLINED, DECLINED_WITH_ATTEMPTS_LEFT)

type
required

Example : "PURCHASE"

enum (PURCHASE, REFUND, AUTH, CAPTURE, REVERSAL, RECURRING, PAYOUT)

LinkResponse

Name Description Schema

operationId
required

Example : "1-1-a-123"

string

url
required

Example : "https://payment.flexo.systems/paymentpage/abc"

string

MerchantNotificationDtoV1

Name Description Schema

amount
required

baseAmount
required

externalId
required

Example : "ext#2"

string

id
required

Example : "1-1-a-1"

string

merchantParameters
required

payer
required

registeredMethods
required

< PaymentMethodDTO > array

status
required

Example : "SUCCEEDED"

enum (CREATED, EXPIRED, IN_PROGRESS, WAITING_FOR_CONFIRMATION, SUCCEEDED, DECLINED, DECLINED_WITH_ATTEMPTS_LEFT)

successful
required

boolean

transactions
optional

type
required

Example : "PURCHASE"

string

MerchantParameters

Name Description Schema

param1
optional

Length : 0 - 250
Example : "1"

string

param2
optional

Length : 0 - 250
Example : "2"

string

param3
optional

Length : 0 - 250
Example : "3"

string

customerId
optional

Length : 0 - 250
Example : "id-123123"

string

customerEmail
optional

Length : 0 - 250
Example : "customer@gmail.com"

string

customerName
optional

Length : 0 - 250
Example : "Petrov Ivan"

string

customerIp
optional

Length : 0 - 250
Example : "192.168.0.1"

string

MonetaryAmount

Name Description Schema

amount
required

Minimum value (exclusive) : 0
Maximum value : 9999999.99
Example : 10.0

number

currency
required

Pattern : "^[A-Z]{3}$"
Example : "RUB"

string

Mono«ResponseEntity«SerializableApiResponse»»

Type : object

Mono«ResponseEntity«object»»

Type : object

Notification

Name Description Schema

url
required

Example : "https://example.com/callback"

string

version
optional

NotificationTransactionDTO

Name Schema

description
optional

string

status
optional

enum (CREATED, SUCCEEDED, DECLINED, PRECONDITION_FAILED, WAITING_FOR_CONFIRMATION)

type
optional

enum (PURCHASE, REFUND, AUTH, CAPTURE, REVERSAL, RECURRING, COMPLETE3DS, PAYOUT)

Optional«int»

Name Schema

empty
optional

boolean

present
optional

boolean

PageParameters

Name Description Schema

description
required

Length : 1 - 250
Example : "my order"

string

urlOnDecline
required

Example : "https://example.com/decline"

string

urlOnSuccess
required

Example : "https://example.com/success"

string

Payer

Name Schema

info
optional

< string, string > map

paymentMethod
required

PaymentLinkCreationRequest

Name Description Schema

action
required

Example : "auth"

enum (auth, purchase)

amount
required

externalId
required

Pattern : "^[a-zA-Z0-9\\-_.#()]{1,100}$"

string

merchantParameters
required

notification
required

pageParameters
required

registerRecurring
optional

boolean

PaymentMethodDTO

Name Schema

entity
required

PaymentMethodDTOEntity

Look at concrete implementation: Card, NoCvvCard, RecurringTokenDTO

Type : object

PayoutRequest

Name Description Schema

amount
required

externalId
required

Pattern : "^[a-zA-Z0-9\\-_.#()]{1,100}$"

string

merchantParameters
required

notification
required

receiver
required

PurchaseRequest

Name Description Schema

amount
required

externalId
required

Pattern : "^[a-zA-Z0-9\\-_.#()]{1,100}$"

string

merchantParameters
required

notification
required

payer
required

registerRecurring
optional

boolean

Receiver

Name Description Schema

info
optional

< string, string > map

name
required

Length : 1 - 24
Pattern : "^[a-zA-Z0-9\\\\.\\\\\"\\\\*\\\\,\\\\/\\\\:\\\\;\\\\=\\\\_\\s-]+$"
Example : "IVAN"

string

paymentMethod
required

surname
required

Length : 1 - 24
Pattern : "^[a-zA-Z0-9\\\\.\\\\\"\\\\*\\\\,\\\\/\\\\:\\\\;\\\\=\\\\_\\s-]+$"
Example : "IVANOV"

string

RecurringRequest

Name Description Schema

amount
required

externalId
required

Pattern : "^[a-zA-Z0-9\\-_.#()]{1,100}$"

string

merchantParameters
required

notification
required

payer
required

RecurringTokenDTO

Recurring token

Polymorphism : Composition

Name Description Schema

id
required

Pattern : "^\\d+-\\d+$"
Example : "1-22"

string

RefundRequest

Name Description Schema

amount
required

externalId
required

Pattern : "^[a-zA-Z0-9\\-_.#()]{1,100}$"

string

merchantParameters
required

notification
required

SerializableApiResponse

Type : object

SimpleRequest

Name Description Schema

externalId
required

Pattern : "^[a-zA-Z0-9\\-_.#()]{1,100}$"

string

merchantParameters
required

notification
required