v1

latestOpenAPI 3.0.02026-07-246335313.6 KB

Payout APIs

Generate OTP - Approve

post/api/merchant/payout/generateOTP/approve

Headers

X-Portone-Client-Keystring

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>

Request body

emailstring required

The email_address of the approver user

two_fa_type'email' | 'phone' required

The type of 2FA setup. Accepted values are email, phone

environment'live' | 'sandbox' required

The environment of the transaction is either live OR sandbox

Example request

{
  "email": "jatin+new@portone.io",
  "two_fa_type": "email",
  "environment": "sandbox"
}

Response

Successful response

actionstring

The action type of OTP. Either verify or approve.

messagestring

The description of the API request execution result

status_codestring

The status_code for API request execution result

status_reasonstring

The status_reason for API request execution result

typestring

The type of the 2fa setup. e.g. phone or email