Maksu Logo

MaksuPay VPOS Direct API (JSON)

API docs by Redocly

MaksuPay VPOS Direct API (JSON) (5.0)

Download OpenAPI specification:

MaksuPay Support: support@maksupay.com URL: https://maksupay.com

MaksuPay VPOS API endpoint for processing sale, prreuth, refund, cancel and other operations. This API allows merchants to send JSON-formatted messages and receive corresponding response messages.

Supported request messages

Payment operations

  • SaleRequest
  • AuthorisationRequest
  • CaptureRequest
  • PayLinkRequest
  • OriginalCreditRequest
  • RefundRequest
  • CancelRequest (void)
  • RecurringOperationRequest (Cancel to cancel|Recurring run follow-up)
  • StatusRequest

Maksu Buttons SDK start payment session

  • PaySessionRequest
  • PaySessionResponse

Tokenization operations

  • TokenizationRequest
  • DeTokenizationRequest

3DS Authentication operations

  • ThreeDSMethodRequest
  • AuthenticationRequest
  • AuthenticationResultsRequest

Send request

Sends a saleReq or other message to initiate a payment authorization and capture or other operation of transaction. Returns a saleRes or other response object. Either with three X- headers or AUthorization header used by Maksu Buttons SDK

header Parameters
X-Payload-Signature
required
string
Example: SHA256;ITdgCSe2n+ssLzbEAkGUn9lAKUZ7ToP3xikYrT1xUj5i6l6LXsT98gZTakayKU+rE7xFv0LuBCJVnjuI9WReTmYkzgrEgxrSXLhmo3PTdDmAiadS1VOg+pO8mxEae//2oBmkZVBS2NUTK6kOr5mNPifv3EqZMERh+AN7r/WJxy7NipVkot+CakO81wWp/YtsygJutdRb7G8k364j2K1F3bWJuqhbi55KLCRpIVzyfW5kznUpcqVDeeQcEl+vMlFqVV7p6DevWRap4ooOzxQCKwR4yTovQUiLLVcBmnBKJT0Igbpls+rCWa1SGWY4jSH7MWMhoFgqtUVAZF+aFHNz7YhGDSwT5V6cAFJh5bvN5BN1KH+QWQ8yNDaEMsHx2amn61mXUwBKTMmNF0yFHqTes6mBfZ/no8GM

RSA with-SHA256 signature of request body

X-Sender-ID
required
string
Example: 200002

Sender id (typically merchant id eg 200002)

X-Public-Key-Hash
required
string
Example: BecEjchDmUWaq9EPUiP+b7kVFbjQWT9ksMJrRgVbChE=

Sender public key hash

Authorization
required
string
Example: ITdgCSe2n+ssLzbEAkGUn9lAKUZ7ToP3xikYrT1xUj5i6l6LXsT98gZTakayKU+rE7xFv0LuBCJVnjuI9WReTmYkzgrEgxrSXLhmo3PTdDmAiadS1VOg+pO8mxEae//2oBmkZVBS2NUTK6kOr5mNPifv3EqZMERh+AN7r/WJxy7NipVkot+CakO81wWp/YtsygJutdRb7G8k364j2K1F3bWJuqhbi55KLCRpIVzyfW5kznUpcqVDeeQcEl+vMlFqVV7p6DevWRap4ooOzxQCKwR4yTovQUiLLVcBmnBKJT0Igbpls+rCWa1SGWY4jSH7MWMhoFgqtUVAZF+aFHNz7YhGDSwT5V6cAFJh5bvN5BN1KH+QWQ8yNDaEMsHx2amn61mXUwBKTMmNF0yFHqTes6mBfZ/no8GM

or Bearer one time token from PaymentSession response (authenticates requests with orderId = orderId specified in PaymentSessionRequest)

Request Body schema: application/json
required
required
saleReq (object) or authorisationReq (object) or captureReq (object) or originalCreditReq (object) or refundReq (object) or cancelReq (object) or paySessReq (object) or recurringOperationReq (object) or statusReq (object) or tokenizationReq (object) or deTokenizationReq (object) or payLinkReq (object) or tdsmethodReq (object) or authReq (object) or authResultsReq (object) or walletDataReq (object)

Responses

Request samples

Content type
application/json
Example
{
  • "message": {
    }
}

Response samples

Content type
application/json
Example
{
  • "message": {
    }
}