CreateQuickPaymentsTransaction

POST 
/orgs/:org_guid/terminals/quick-payments/:terminal_guid/transactions

CreateQuickPaymentsTransaction

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: ebbac895-8c76-4042-a17b-c9c48d693d85
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

Body

transaction_id stringrequired

Possible values: non-empty and <= 48 characters

transaction_id

requested_at date-timenullable

requested_at

sources

object

operation QPEOperations (string)required

Possible values: [Payment, Refund]

terminal_id stringrequired

Possible values: non-empty and <= 24 characters

terminal_id

merchant_id stringnullable

Possible values: <= 24 characters

merchant_id

transaction_id stringrequired

Possible values: non-empty and <= 48 characters

transaction_id

registered_at date-timerequired

registered_at

requested_at date-time

requested_at

amount int32required

amount

currency CurrencyCodes (string)required

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

quick_payments_terminal

object

guid uuid

guid

type_of string

type_of

quick_payments_type QPType (string)

Possible values: [Qr, Nfc]

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

application/json

Body

transaction_id stringrequired

Possible values: non-empty and <= 48 characters

transaction_id

requested_at date-timenullable

requested_at

sources

object

operation QPEOperations (string)required

Possible values: [Payment, Refund]

terminal_id stringrequired

Possible values: non-empty and <= 24 characters

terminal_id

merchant_id stringnullable

Possible values: <= 24 characters

merchant_id

transaction_id stringrequired

Possible values: non-empty and <= 48 characters

transaction_id

registered_at date-timerequired

registered_at

requested_at date-time

requested_at

amount int32required

amount

currency CurrencyCodes (string)required

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

quick_payments_terminal

object

guid uuid

guid

type_of string

type_of

quick_payments_type QPType (string)

Possible values: [Qr, Nfc]

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

text/json

Body

transaction_id stringrequired

Possible values: non-empty and <= 48 characters

transaction_id

requested_at date-timenullable

requested_at

sources

object

operation QPEOperations (string)required

Possible values: [Payment, Refund]

terminal_id stringrequired

Possible values: non-empty and <= 24 characters

terminal_id

merchant_id stringnullable

Possible values: <= 24 characters

merchant_id

transaction_id stringrequired

Possible values: non-empty and <= 48 characters

transaction_id

registered_at date-timerequired

registered_at

requested_at date-time

requested_at

amount int32required

amount

currency CurrencyCodes (string)required

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

quick_payments_terminal

object

guid uuid

guid

type_of string

type_of

quick_payments_type QPType (string)

Possible values: [Qr, Nfc]

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

application/*+json

Body

transaction_id stringrequired

Possible values: non-empty and <= 48 characters

transaction_id

requested_at date-timenullable

requested_at

sources

object

operation QPEOperations (string)required

Possible values: [Payment, Refund]

terminal_id stringrequired

Possible values: non-empty and <= 24 characters

terminal_id

merchant_id stringnullable

Possible values: <= 24 characters

merchant_id

transaction_id stringrequired

Possible values: non-empty and <= 48 characters

transaction_id

registered_at date-timerequired

registered_at

requested_at date-time

requested_at

amount int32required

amount

currency CurrencyCodes (string)required

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

quick_payments_terminal

object

guid uuid

guid

type_of string

type_of

quick_payments_type QPType (string)

Possible values: [Qr, Nfc]

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

201

Created

application/json

Schema

Schema

transaction_id stringrequired

Possible values: non-empty and <= 48 characters

transaction_id

requested_at date-timenullable

requested_at

sources

object

operation QPEOperations (string)required

Possible values: [Payment, Refund]

terminal_id stringrequired

Possible values: non-empty and <= 24 characters

terminal_id

merchant_id stringnullable

Possible values: <= 24 characters

merchant_id

transaction_id stringrequired

Possible values: non-empty and <= 48 characters

transaction_id

registered_at date-timerequired

registered_at

requested_at date-time

requested_at

amount int32required

amount

currency CurrencyCodes (string)required

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

quick_payments_terminal

object

guid uuid

guid

type_of string

type_of

quick_payments_type QPType (string)

Possible values: [Qr, Nfc]

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

Example (from schema)

{
  "transaction_id": "string",
  "requested_at": "2024-11-18T08:30:48.592Z",
  "sources": {
    "operation": "Payment",
    "terminal_id": "string",
    "merchant_id": "string",
    "transaction_id": "string",
    "registered_at": "2024-11-18T08:30:48.592Z",
    "requested_at": "2024-11-18T08:30:48.592Z",
    "amount": 0,
    "currency": "RUB"
  },
  "quick_payments_terminal": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "quick_payments_type": "Qr",
  "type_of": "string",
  "amount": {
    "value": 0,
    "currency": "RUB",
    "type_of": "string"
  },
  "registered_at": "2024-11-18T08:30:48.592Z",
  "operation": "Payment",
  "transaction_type": "Offline",
  "status": "Completed",
  "created_at": "2024-11-18T08:30:48.592Z",
  "updated_at": "2024-11-18T08:30:48.592Z",
  "deleted_at": "2024-11-18T08:30:48.592Z",
  "meta": "string",
  "meta_data": {},
  "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

401

Unauthorized

application/json

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

Example (from schema)

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

403

Forbidden

application/json

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

Example (from schema)

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

404

Not Found

application/json

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

Example (from schema)

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

422

Client Error

application/json

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

Example (from schema)

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

429

Too Many Requests

application/json

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

Example (from schema)

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

500

Server Error

application/json

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

Example (from schema)

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

Loading...