Refund

Used to trigger refund process for a particular pw_id.

Method: POST

Action: refund

Request

Format: POST data

  • action required : string (32)
Remark Sample
The action of this call, must be hardcoded to “refund” refund
  • op required : string (32)
Remark Sample
The sub-action of this call - initiate or submit initiate
  • timestamp required : timestamp
Remark Sample
The timestamp for this API call -
  • api_key required : string (32)
Remark Sample
Pipwave-assigned merchant’s API key 123456
  • pw_id *required : string (32)
Remark Sample
Pipwave’s transaction reference ID, either this or txn_id must be sent 123456
  • txn_id *required : string (255)
Remark Sample
Merchant’s transaction ID, either this or pw_id must be sent 123456
  • refund_amount : decimal (11, 2)
Remark Sample
If not provided, full refund will be affected -
  • extra_param : string (255)
Remark Sample
Extra params which is required by payment method to process the refund, in JSON format -

Response

Format: JSON

  • status : string (5)
Remark Sample
Status of the request. Refer to appendix for list of possible values. 200
  • message : string (255)
Remark Sample
Error message, if any -
  • supports_refund : boolean
Remark Sample
Tells if this transaction supports refund -
  • supports_partial_refund : boolean
Remark Sample
Tells if this transaction supports partial refund -
  • extra_params : array
Remark Sample
If there is any extra parameters required, this section will be filled up -
  • reverse_pw_id : string (32)
Remark Sample
The refund reference ID from pipwave -
  • pg_raw_data : string
Remark Sample
JSON of original PG response -

Signature

The data involved in generating the signature for this API are:

  • timestamp
  • action
  • api_key
  • op
  • pw_id, if provided
  • txn_id, if provided
  • refund_amount, if provided
  • extra_param, if provided
  • api_secret

results matching ""

    No results matching ""