Sign in

v1

latestOpenAPI 3.0.02026-07-246335313.6 KB
Payment APIs

Generate signature hash

This endpoint allows you to generate a signature for a merchant transaction The response will include the generated signature for the provided transaction details.

post/api/merchant/generate-signature

Headers

Authorizationstring

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token <a href="/docs/jwt-authentication" target="_blank">in this guide</a>

X-Portone-Client-Keystring
Content-Typestring

Request body

portone_keystring required

The merchant's Portone API key.

currencystring required

The currency of the transaction.

amountnumber double required

The amount of the transaction.

merchant_order_idstring required

The unique merchant order reference generated by the merchant.

success_urlstring required

The URL to redirect to upon successful transaction.

failure_urlstring required

The URL to redirect to upon failed transaction.

Example request

{
  "portone_key": "sjcrvcbVYkFobHlx",
  "currency": "THB",
  "amount": 111.12,
  "merchant_order_id": "e203767a-ae29-42dc-820f-61cbde24966e",
  "success_url": "https://yourwebsite.com/success",
  "failure_url": "https://yourwebsite.com/failure"
}

Response

OK

messagestring

The description of the API request execution result

status_codestring

The status code of API response

status_reasonstring

The status reason of API response