Create Refund

post

https://api.portone.cloud/api/refund/{portone_order_ref}

Create Refund for the transaction created on PortOne. Merchant can either create the full or partial refund. Few PSPs do not support refunds or partial refunds. Please refer PortOne docs for additional information. The response body contains the amount to refund and the array of all refunds performed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

portone_order_ref

string

required

Body Params

amount

double

required

The amount you want to refund (ignored if a refund of type 'full' is requested)

channel

string

required

The payment channel key used to make the payment for the transaction

description

string

required

The description for the refund

environment

string

enum

required

The environment of the transaction is either live OR sandbox

Allowed:

refund_type

string

enum

required

The type of the refund indicates whether a full or partial refund is being requested. If the refund type is 'full', the 'amount' field is ignored

Allowed:

refund_reason

string

required

The reason for the refund

Headers

X-Portone-Client-Key

string

Authorization

string

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token in this guide

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400Failure response

401Failure response