CreateBankTransaction

POST /orgs/:org_guid/terminals/bank/:terminal_guid/transactions

Request

Path Parameters

org_guid uuidrequired

terminal_guid uuidrequired

Query Parameters

presentation PresentationModes

Possible values: [compact, full]

Header Parameters

X-LP-Client-Identifier stringrequired

ClientIdentifier

Example: 68e57468-bbde-4789-90e0-7e02d4e291aa

X-LP-Client-Type stringrequired

Possible values: [Unknown, App, WebApp, Service]

ClientType

Example: App

X-LP-Client-Name string

ClientName

Example: Swagger

X-LP-Client-OS-Name string

ClientOSName

Example: SwaggerDoc

X-LP-Client-OS-Version string

ClientOSVersion

Example: 1.0

X-LP-Client-Screen-Resolution string

ClientScreenResolution

Example: 1280x0900

X-LP-Client-Model string

ClientModel

Example: Chrome 75

X-LP-Organization-Alias string

OrganizationAlias

X-LP-Client-Extensions csv

ClientExtensions

Accept-Language stringrequired

Language

Example: en-US

application/json-patch+json
application/json
text/json
application/*+json

Body

authorization_code stringnullable

Possible values: <= 16 characters

authorization_code

reference_retrieval_number stringnullable

Possible values: <= 24 characters

reference_retrieval_number

emv_application_label stringnullable

Possible values: <= 48 characters

emv_application_label

card_number stringnullable

Possible values: <= 19 characters

card_number

cardholder_name stringnullable

Possible values: <= 32 characters

cardholder_name

sources

object

operation PTEOperations (string)required

Possible values: [Payment, Cancellation, Refund, Rollback]

merchant_id stringnullable

Possible values: <= 24 characters

merchant_id

terminal_id stringnullable

Possible values: <= 24 characters

terminal_id

number int32

number

amount int32

amount

currency_code CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

registered_at date-time

registered_at

authorization_code stringnullable

Possible values: <= 16 characters

authorization_code

reference_retrieval_number stringnullable

Possible values: <= 24 characters

reference_retrieval_number

emv_application_identifier stringnullable

Possible values: <= 24 characters

emv_application_identifier

emv_application_label stringnullable

Possible values: <= 48 characters

emv_application_label

card_number stringnullable

Possible values: <= 19 characters

card_number

cardholder_name stringnullable

Possible values: <= 32 characters

cardholder_name

card_expires_at date-timenullable

card_expires_at

card_hash stringnullable

Possible values: <= 256 characters

card_hash

host_response_code stringnullable

Possible values: <= 8 characters

host_response_code

host_response_message stringnullable

Possible values: <= 128 characters

host_response_message

print_view stringnullable

print_view

additional_attributes

object[]

nullable

additional_attributes

Array [

name stringnullable

Possible values: <= 128 characters

name

value stringnullable

Possible values: <= 1024 characters

value

type_of stringnullable

type_of

]

type_of stringnullable

type_of

bank_terminal

object

guid uuid

guid

type_of string

type_of

payment_type PTPaymentType (string)

Possible values: [Card, YaPay, MirPay, SberPay]

amount

object

required

value int64

value

currency CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

type_of string

type_of

registered_at date-timerequired

registered_at

operation TransactionOperationTypes (string)required

Possible values: [Payment, Cancellation, Refund]

transaction_type PTTransactionType (string)

Possible values: [Offline, Online]

status PTTransactionStatus (string)

Possible values: [Completed, Hold, Rejected]

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string

guid uuid

guid

Body

authorization_code stringnullable

Possible values: <= 16 characters

authorization_code

reference_retrieval_number stringnullable

Possible values: <= 24 characters

reference_retrieval_number

emv_application_label stringnullable

Possible values: <= 48 characters

emv_application_label

card_number stringnullable

Possible values: <= 19 characters

card_number

cardholder_name stringnullable

Possible values: <= 32 characters

cardholder_name

sources

object

operation PTEOperations (string)required

Possible values: [Payment, Cancellation, Refund, Rollback]

merchant_id stringnullable

Possible values: <= 24 characters

merchant_id

terminal_id stringnullable

Possible values: <= 24 characters

terminal_id

number int32

number

amount int32

amount

currency_code CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

registered_at date-time

registered_at

authorization_code stringnullable

Possible values: <= 16 characters

authorization_code

reference_retrieval_number stringnullable

Possible values: <= 24 characters

reference_retrieval_number

emv_application_identifier stringnullable

Possible values: <= 24 characters

emv_application_identifier

emv_application_label stringnullable

Possible values: <= 48 characters

emv_application_label

card_number stringnullable

Possible values: <= 19 characters

card_number

cardholder_name stringnullable

Possible values: <= 32 characters

cardholder_name

card_expires_at date-timenullable

card_expires_at

card_hash stringnullable

Possible values: <= 256 characters

card_hash

host_response_code stringnullable

Possible values: <= 8 characters

host_response_code

host_response_message stringnullable

Possible values: <= 128 characters

host_response_message

print_view stringnullable

print_view

additional_attributes

object[]

nullable

additional_attributes

Array [

name stringnullable

Possible values: <= 128 characters

name

value stringnullable

Possible values: <= 1024 characters

value

type_of stringnullable

type_of

]

type_of stringnullable

type_of

bank_terminal

object

guid uuid

guid

type_of string

type_of

payment_type PTPaymentType (string)

Possible values: [Card, YaPay, MirPay, SberPay]

amount

object

required

value int64

value

currency CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

type_of string

type_of

registered_at date-timerequired

registered_at

operation TransactionOperationTypes (string)required

Possible values: [Payment, Cancellation, Refund]

transaction_type PTTransactionType (string)

Possible values: [Offline, Online]

status PTTransactionStatus (string)

Possible values: [Completed, Hold, Rejected]

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string

guid uuid

guid

Body

authorization_code stringnullable

Possible values: <= 16 characters

authorization_code

reference_retrieval_number stringnullable

Possible values: <= 24 characters

reference_retrieval_number

emv_application_label stringnullable

Possible values: <= 48 characters

emv_application_label

card_number stringnullable

Possible values: <= 19 characters

card_number

cardholder_name stringnullable

Possible values: <= 32 characters

cardholder_name

sources

object

operation PTEOperations (string)required

Possible values: [Payment, Cancellation, Refund, Rollback]

merchant_id stringnullable

Possible values: <= 24 characters

merchant_id

terminal_id stringnullable

Possible values: <= 24 characters

terminal_id

number int32

number

amount int32

amount

currency_code CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

registered_at date-time

registered_at

authorization_code stringnullable

Possible values: <= 16 characters

authorization_code

reference_retrieval_number stringnullable

Possible values: <= 24 characters

reference_retrieval_number

emv_application_identifier stringnullable

Possible values: <= 24 characters

emv_application_identifier

emv_application_label stringnullable

Possible values: <= 48 characters

emv_application_label

card_number stringnullable

Possible values: <= 19 characters

card_number

cardholder_name stringnullable

Possible values: <= 32 characters

cardholder_name

card_expires_at date-timenullable

card_expires_at

card_hash stringnullable

Possible values: <= 256 characters

card_hash

host_response_code stringnullable

Possible values: <= 8 characters

host_response_code

host_response_message stringnullable

Possible values: <= 128 characters

host_response_message

print_view stringnullable

print_view

additional_attributes

object[]

nullable

additional_attributes

Array [

name stringnullable

Possible values: <= 128 characters

name

value stringnullable

Possible values: <= 1024 characters

value

type_of stringnullable

type_of

]

type_of stringnullable

type_of

bank_terminal

object

guid uuid

guid

type_of string

type_of

payment_type PTPaymentType (string)

Possible values: [Card, YaPay, MirPay, SberPay]

amount

object

required

value int64

value

currency CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

type_of string

type_of

registered_at date-timerequired

registered_at

operation TransactionOperationTypes (string)required

Possible values: [Payment, Cancellation, Refund]

transaction_type PTTransactionType (string)

Possible values: [Offline, Online]

status PTTransactionStatus (string)

Possible values: [Completed, Hold, Rejected]

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string

guid uuid

guid

Body

authorization_code stringnullable

Possible values: <= 16 characters

authorization_code

reference_retrieval_number stringnullable

Possible values: <= 24 characters

reference_retrieval_number

emv_application_label stringnullable

Possible values: <= 48 characters

emv_application_label

card_number stringnullable

Possible values: <= 19 characters

card_number

cardholder_name stringnullable

Possible values: <= 32 characters

cardholder_name

sources

object

operation PTEOperations (string)required

Possible values: [Payment, Cancellation, Refund, Rollback]

merchant_id stringnullable

Possible values: <= 24 characters

merchant_id

terminal_id stringnullable

Possible values: <= 24 characters

terminal_id

number int32

number

amount int32

amount

currency_code CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

registered_at date-time

registered_at

authorization_code stringnullable

Possible values: <= 16 characters

authorization_code

reference_retrieval_number stringnullable

Possible values: <= 24 characters

reference_retrieval_number

emv_application_identifier stringnullable

Possible values: <= 24 characters

emv_application_identifier

emv_application_label stringnullable

Possible values: <= 48 characters

emv_application_label

card_number stringnullable

Possible values: <= 19 characters

card_number

cardholder_name stringnullable

Possible values: <= 32 characters

cardholder_name

card_expires_at date-timenullable

card_expires_at

card_hash stringnullable

Possible values: <= 256 characters

card_hash

host_response_code stringnullable

Possible values: <= 8 characters

host_response_code

host_response_message stringnullable

Possible values: <= 128 characters

host_response_message

print_view stringnullable

print_view

additional_attributes

object[]

nullable

additional_attributes

Array [

name stringnullable

Possible values: <= 128 characters

name

value stringnullable

Possible values: <= 1024 characters

value

type_of stringnullable

type_of

]

type_of stringnullable

type_of

bank_terminal

object

guid uuid

guid

type_of string

type_of

payment_type PTPaymentType (string)

Possible values: [Card, YaPay, MirPay, SberPay]

amount

object

required

value int64

value

currency CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

type_of string

type_of

registered_at date-timerequired

registered_at

operation TransactionOperationTypes (string)required

Possible values: [Payment, Cancellation, Refund]

transaction_type PTTransactionType (string)

Possible values: [Offline, Online]

status PTTransactionStatus (string)

Possible values: [Completed, Hold, Rejected]

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string

guid uuid

guid

Responses

Created

application/json

Schema
Example (from schema)

Schema

authorization_code stringnullable

Possible values: <= 16 characters

authorization_code

reference_retrieval_number stringnullable

Possible values: <= 24 characters

reference_retrieval_number

emv_application_label stringnullable

Possible values: <= 48 characters

emv_application_label

card_number stringnullable

Possible values: <= 19 characters

card_number

cardholder_name stringnullable

Possible values: <= 32 characters

cardholder_name

sources

object

operation PTEOperations (string)required

Possible values: [Payment, Cancellation, Refund, Rollback]

merchant_id stringnullable

Possible values: <= 24 characters

merchant_id

terminal_id stringnullable

Possible values: <= 24 characters

terminal_id

number int32

number

amount int32

amount

currency_code CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

registered_at date-time

registered_at

authorization_code stringnullable

Possible values: <= 16 characters

authorization_code

reference_retrieval_number stringnullable

Possible values: <= 24 characters

reference_retrieval_number

emv_application_identifier stringnullable

Possible values: <= 24 characters

emv_application_identifier

emv_application_label stringnullable

Possible values: <= 48 characters

emv_application_label

card_number stringnullable

Possible values: <= 19 characters

card_number

cardholder_name stringnullable

Possible values: <= 32 characters

cardholder_name

card_expires_at date-timenullable

card_expires_at

card_hash stringnullable

Possible values: <= 256 characters

card_hash

host_response_code stringnullable

Possible values: <= 8 characters

host_response_code

host_response_message stringnullable

Possible values: <= 128 characters

host_response_message

print_view stringnullable

print_view

additional_attributes

object[]

nullable

additional_attributes

Array [

name stringnullable

Possible values: <= 128 characters

name

value stringnullable

Possible values: <= 1024 characters

value

type_of stringnullable

type_of

]

type_of stringnullable

type_of

bank_terminal

object

guid uuid

guid

type_of string

type_of

payment_type PTPaymentType (string)

Possible values: [Card, YaPay, MirPay, SberPay]

type_of stringnullable

type_of

amount

object

required

value int64

value

currency CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

type_of string

type_of

registered_at date-timerequired

registered_at

operation TransactionOperationTypes (string)required

Possible values: [Payment, Cancellation, Refund]

transaction_type PTTransactionType (string)

Possible values: [Offline, Online]

status PTTransactionStatus (string)

Possible values: [Completed, Hold, Rejected]

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string

guid uuid

guid

{
  "authorization_code": "string",
  "reference_retrieval_number": "string",
  "emv_application_label": "string",
  "card_number": "string",
  "cardholder_name": "string",
  "sources": {
    "operation": "Payment",
    "merchant_id": "string",
    "terminal_id": "string",
    "number": 0,
    "amount": 0,
    "currency_code": "RUB",
    "registered_at": "2024-11-18T08:30:48.555Z",
    "authorization_code": "string",
    "reference_retrieval_number": "string",
    "emv_application_identifier": "string",
    "emv_application_label": "string",
    "card_number": "string",
    "cardholder_name": "string",
    "card_expires_at": "2024-11-18T08:30:48.555Z",
    "card_hash": "string",
    "host_response_code": "string",
    "host_response_message": "string",
    "print_view": "string",
    "additional_attributes": [
      {
        "name": "string",
        "value": "string",
        "type_of": "string"
      }
    ],
    "type_of": "string"
  },
  "bank_terminal": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "payment_type": "Card",
  "type_of": "string",
  "amount": {
    "value": 0,
    "currency": "RUB",
    "type_of": "string"
  },
  "registered_at": "2024-11-18T08:30:48.556Z",
  "operation": "Payment",
  "transaction_type": "Offline",
  "status": "Completed",
  "created_at": "2024-11-18T08:30:48.556Z",
  "updated_at": "2024-11-18T08:30:48.556Z",
  "deleted_at": "2024-11-18T08:30:48.556Z",
  "meta": "string",
  "meta_data": {},
  "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Unauthorized

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

message stringnullable

message

info stringnullable

info

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Forbidden

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Not Found

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Client Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Too Many Requests

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Server Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

CreateBankTransaction

/orgs/:org_guid/terminals/bank/:terminal_guid/transactions

Request​

Path Parameters

Query Parameters

Header Parameters

Body

Body

Body

Body

Responses​

Request

Responses