API Reference

Create Refund

post
https://gw.praxisgate.com/direct/refund
Body Params
string
required
length ≤ 50

Merchant API client account identifier.

string
required
length ≤ 32

Identifier of your application (website).

string
required
length ≤ 3

API version.

integer
required

Request time (unix timestamp, seconds).

string
required
length ≤ 16

Transaction type.

string
required
length ≤ 10

Base Currency: The user's account currency on the merchant site.

integer
required

Transaction amount in cents.

Note: For certain currencies there is a fraction other than 100 cents per unit, this is important if you multiply by 100 to send the amount in cents.

string
required
length ≤ 50

Unique customer id in your system.

Note: Personally Identifiable Information (PII), such as email addresses, is strictly forbidden. If your user identifier contains any PII, you must hash or encrypt it before sending it to the API.

string
enum
required
length ≤ 5

User locale, specified as a BCP 47 Language Tag (e.g., 'en-GB'). The first component is the ISO 639-1 language code, and the second is the ISO 3166-1 country code.

Note: Contact [email protected] to add new locale if not available in the list.

string
required
length ≤ 50

Transaction or session identifier in your system.

integer
required

In case of refund, this value specifies the ID of transaction to be refunded

integer

Original transaction identifier from. Send the tid of withdrawal request if you want the payout amount to be deducted from withdrawal request as processed.

string
length ≤ 50

Unique customer id in your system.

Note: Personally Identifiable Information (PII), such as email addresses, is strictly forbidden. If your user identifier contains any PII, you must hash or encrypt it before sending it to the API.

string
length ≤ 256

Your custom field to tag the transaction with some necessary information.

string
length ≤ 256

Your custom field to tag the transaction with some necessary information.

Headers
string
required

Authentication HTTP header of your outgoing request to the API. Below request parameters should be used for creating signature in request header.

  • merchant_id
  • application_key
  • timestamp
  • transaction_type
  • cid
  • order_id
  • currency
  • amount
  • reference_id
  • withdrawal_request_id
Responses

Updated 6 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago