v1

latestOpenAPI 3.0.02026-07-246335313.6 KB

Payout APIs

Verify Payout Transactions

post/api/merchant/payout/verify

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>

Content-Typestring

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

{
  "email": "sagar@portone.io",
  "otp": "131371",
  "name": "teststaging1",
  "txn_refs": [
    "PARTNERTEST021631134187971232347",
    "PARTNERTEST021631134187965732348"
  ],
  "signature_hash": "emFLgXdZJQzpm1O8HcHWi16KJRxeg+wuTGzr1wv7Nng=",
  "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