1. Payment ID

Partial Refund Service with Payment ID (PaymentId)

Partial Refund

POST {{Private Base Address}}/api/paywall/private/refund/partial/by/paymentid

Important: In order to use the Partial Refund with Payment ID service, you must send the 'apikeyprivate' and 'apiclientprivate' parameters in the Header field. PaymentPrivateAPI Address

Parameter

Type

Compulsory

Description

apikeyprivate

string

Yes

The Private Key obtained from the merchant panel.

apiclientprivate

string

Yes

The Private Client obtained from the merchant panel.

The parameters to be sent to the service are as follows:

Parameter

Type

Compulsory

Description

PaymentId

int

Yes

This is the value contained in the PaymentId parameter within the response object returned by Paywall after the payment initiation.

Date

Yes

Transaction date.

Amount

Decimal

Yes

Amount to be refunded.

{
    "Date": "2024-06-13",
    "PaymentId": 994838374,
    "Amount": 101.5,
    "MarketPlace": {
        "ProviderCommissionUpdate": true,
        "Platform": {
            "Decrease": true,
            "DecreaseAmount": 101.5
        },
        "Member": {
            "Decrease": false,
            "DecreaseAmount": null
        }
    }
}

using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

public class Program
{
    private static readonly HttpClient client = new HttpClient();

    private static async Task Main()
    {
        var data = new 
        {
            Date = "2023-01-23",
            MerchantUniqueCode = "12222a222a",
            Amount = 70
        };
        var content = new StringContent(JsonConvert.SerializeObject(data), Encoding.UTF8, "application/json");
        content.Headers.Add("apikeyprivate", "%PRIVATEKEY%");
        content.Headers.Add("apiclientprivate", "%PRIVATECLIENT%");

        var response = await client.PostAsync("{{Private Base Address}}/api/paywall/private/refund/partial", content);

        var responseString = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseString);
    }
}

package main

import (
    "bytes"
    "fmt"
    "io/ioutil"
    "net/http"
    "encoding/json"
)

func main() {
    url := "{{Private Base Address}}/api/paywall/private/refund/partial"
    data := map[string]interface{}{
        "Date": "2023-01-23",
        "MerchantUniqueCode": "12222a222a",
        "Amount": 70,
    }
    reqBody, _ := json.Marshal(data)
    
    req, _ := http.NewRequest("POST", url, bytes.NewBuffer(reqBody))
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("apikeyprivate", "%PRIVATEKEY%")
    req.Header.Set("apiclientprivate", "%PRIVATECLIENT%")
    
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    
    body, _ := ioutil.ReadAll(resp.Body)
    fmt.Println(string(body))
}

import java.net.http.HttpClient;
import java.net.http.HttpHeaders;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import java.net.http.HttpResponse.BodyHandlers;
import java.util.HashMap;
import java.util.Map;

public class Main {

    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();

        Map<String, Object> values = new HashMap<String, Object>() {{
            put("Date", "2023-01-23");
            put("MerchantUniqueCode", "12222a222a");
            put("Amount", 70);
        }};

        String requestBody = new ObjectMapper().writeValueAsString(values);

        HttpRequest request = HttpRequest.newBuilder()
                .uri(new URI("{{Private Base Address}}/api/paywall/private/refund/partial"))
                .setHeader("Content-Type", "application/json")
                .setHeader("apikeyprivate", "%PRIVATEKEY%")
                .setHeader("apiclientprivate", "%PRIVATECLIENT%")
                .POST(HttpRequest.BodyPublishers.ofString(requestBody))
                .build();

        HttpResponse<String> response = client.send(request, BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

<?php

$url = '{{Private Base Address}}/api/paywall/private/refund/partial';
$data = array(
    'Date' => '2023-01-23',
    'MerchantUniqueCode' => '12222a222a',
    'Amount' => 70,
);

$options = array(
    'http' => array(
        'header'  => "Content-type: application/json\r\n" .
                     "apikeyprivate: %PRIVATEKEY%\r\n" . 
                     "apiclientprivate: %PRIVATECLIENT%\r\n",
        'method'  => 'POST',
        'content' => json_encode($data),
    ),
);
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) { /* Handle error */ }

var_dump($result);
?>

import requests
import json

url = "{{Private Base Address}}/api/paywall/private/refund/partial"
headers = {
    'Content-Type': 'application/json',
    'apikeyprivate': '%PRIVATEKEY%',
    'apiclientprivate': '%PRIVATECLIENT%',
}
data = {
    "Date": "2023-01-23",
    "MerchantUniqueCode": "12222a222a",
    "Amount": 70,
}

response = requests.post(url, headers=headers, data=json.dumps(data))

print(response.json())

require 'net/http'
require 'uri'
require 'json'

uri = URI.parse("{{Private Base Address}}/api/paywall/private/refund/partial")
http = Net::HTTP.new(uri.host, uri.port)

request = Net::HTTP::Post.new(uri.request_uri, {
    'Content-Type' => 'application/json',
    'apikeyprivate' => '%PRIVATEKEY%',
    'apiclientprivate' => '%PRIVATECLIENT%',
})
request.body = {Date: "2023-01-23", MerchantUniqueCode: "12222a222a", Amount: 70}.to_json

response = http.request(request)

puts response.body

import axios from 'axios';

const data = {
    Date: "2023-01-23",
    MerchantUniqueCode: "12222a222a",
    Amount: 70,
};

axios.post('{{Private Base Address}}/api/paywall/private/refund/partial', data, {
    headers: {
        'Content-Type': 'application/json',
        'apikeyprivate': '%PRIVATEKEY%',
        'apiclientprivate': '%PRIVATECLIENT%',
    }
})
.then((response) => {
    console.log(response.data);
})
.catch((error) => {
    console.log(error);
});

curl -X POST "{{Private Base Address}}/api/paywall/private/refund/partial" \
-H "Content-Type: application/json" \
-H "apikeyprivate: %PRIVATEKEY%" \
-H "apiclientprivate: %PRIVATECLIENT%" \
-d '{
    "Date": "2023-01-23",
    "MerchantUniqueCode": "12222a222a",
    "Amount": 70
}'

Response returned from the service:

Parameter

Type

Description

ErrorCode

int

Error code. Returns “0” if the operation is successful.

Result

bool

Returns a true or false value. Returns “true” if the operation is successful.

Message

string

If the operation fails, this is the message describing the error; it provides language support based on the locale parameter.

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "Success",
    "Body": null
}

Previous10. Partial Refund Next2. Paywall Transaction ID

Last updated 22 days ago