v1

latestOpenAPI 3.0.02026-07-246335313.6 KB

Payout APIs

Approve Payout Txns

post/api/merchant/payout/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

approver_emailstring required

The email_address of the approver user

approver_namestring required

The name of the approver user

otpstring required

The One Time Password sent on the configured 2FA setup

txn_refsstring[] required

The array of payout transaction references

signature_hashstring required

The SignatureHash generated for the specific payload data

environment'live' | 'sandbox' required

The environment of the transaction is either live OR sandbox

Example request

{
  "approver_email": "jatin+new@portone.io",
  "otp": "054447",
  "approver_name": "jatin",
  "txn_refs": [
    "PARTNERTEST021631824785546830158"
  ],
  "signature_hash": "{{signature_hash}}",
  "environment": "sandbox"
}

Response

Successful response

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