v1

latestOpenAPI 3.0.02026-07-246335313.6 KB

Payment APIs

Update Transaction Details

Update Transaction Details like description and User Configured Fields, Partial update allowed

put/api/{portOneKey}/update-transaction-details/{merchant_order_ref}

Path parameters

portOneKeystring required

merchant_order_refstring required

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

descriptionstring

The description of the transaction

user_configured_field1string

The first User Configured Field

user_configured_field2string

The first User Configured Field

user_configured_field3string

The third User Configured Field

user_configured_field4string

The forth User Configured Field

user_configured_field5string

The fifth User Configured Field

Example request

{
  "description": "Sample Text description",
  "user_configured_field1": "Success",
  "user_configured_field2": "tIV05AsEX4mffPTXayhmkZrWX7qb5w",
  "user_configured_field3": "Dummy text",
  "user_configured_field4": "Meaningful Reference",
  "user_configured_field5": "Random Reference"
}

Response

Successful response

{"stackTrail":"paths:/api/{portOneKey}/update-transaction-details/{merchant_order_ref}:put:responses:200:content:application/json:schema:properties:content","oasType":"schema","type":"unknown","description":"Object that contains UCF data and configured description"}

messagestring

The extra message about the transaction

status_codestring

The status_code for transaction of transaction creation

status_reasonstring

The status_reason for transaction of transaction creation