Payment frontend

Initializing a payment

post

Initializes a payment by accepting a request sent from the frontend. No scope is required.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Body

application/json

paymentModeIdstringOptional

Identifier of a payment mode configured in the payment-gateway service for a given tenant.

creditCardTokenstringOptional

Indicates a payment method token, usually generated on a frontend site, when an user provides a credit card information.

Responses

200

Payment initialized

application/json

successfulbooleanOptional

Indicates if the authorization process finished with success.

paymentTransactionIdstringOptional

Unique payment transaction identifier.

authorizationTokenstringOptional

Authorization token

externalPaymentRedirectURLstringOptional

Indicates a URL address where a user should be redirected in order to finish the authorization process.

externalPaymentHttpMethodstringOptional

Indicates a HTTP Method which should be used in order to finish the authorization process.

400

Bad request. The syntax of the request is incorrect.

application/json

401

Unauthorized

application/json

422

Unprocessable Entity. The payment action is not supported.

application/json

500

Internal Server Error.

application/json

post

/payment-gateway/{tenant}/payment/frontend/initialize

HTTPcURLJavaScriptPython

POST /payment-gateway/{tenant}/payment/frontend/initialize HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "order": {
    "id": "text"
  },
  "paymentModeId": "text",
  "creditCardToken": "text"
}

{
  "successful": true,
  "paymentTransactionId": "FTrjO4SrNF0Had7yBCeVU5ziqwL",
  "externalPaymentRedirectURL": "https://www.sandbox.paypal.com/checkoutnow?token=0SC35196GX656501J",
  "externalPaymentParameters": {}
}

Authorizing a payment

post

Authorize a payment by accepting a request sent from the frontend. No scope is required.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

Body

application/json

paymentModeIdstringOptional

Identifier of a payment mode configured in the payment-gateway service for a given tenant.

creditCardTokenstringOptional

Indicates a payment method token, usually generated on a frontend site, when an user provides a credit card information.

threeDSTokenstringOptional

Contains a token generated during the 3DS authentication process.

browserInfostringOptional

Holds information related to the user's web browser.

clientIPstringOptional

Stores the IP address of the client or user making the request.

Responses

200

Payment authorized

application/json

successfulbooleanOptional

Indicates if the authorization process finished with success.

paymentTransactionIdstringOptional

Unique payment transaction identifier.

authorizationTokenstringOptional

Authorization token

externalPaymentRedirectURLstringOptional

Indicates a URL address where a user should be redirected in order to finish the authorization process.

externalPaymentHttpMethodstringOptional

Indicates a HTTP Method which should be used in order to finish the authorization process.

requiresExternalPaymentbooleanOptional

Indicates if a redirect to an external site is required in order to finish the authorization flow.

400

Bad request. The syntax of the request is incorrect.

application/json

401

Unauthorized

application/json

422

Unprocessable Entity. The payment action is not supported.

application/json

500

Internal Server Error.

application/json

post

/payment-gateway/{tenant}/payment/frontend/authorize

HTTPcURLJavaScriptPython

POST /payment-gateway/{tenant}/payment/frontend/authorize HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "order": {
    "id": "text"
  },
  "paymentModeId": "text",
  "creditCardToken": "text",
  "threeDSToken": "text",
  "browserInfo": "text",
  "clientIP": "text"
}

{
  "successful": true,
  "paymentTransactionId": "FTrjO4SrNF0Had7yBCeVU5ziqwL",
  "requiresExternalPayment": true,
  "externalPaymentRedirectURL": "https://www.sandbox.paypal.com/checkoutnow?token=0SC35196GX656501J",
  "externalPaymentParameters": {}
}