production
development
https://sandbox.sibspayments.com
Paths
/{original-tx-id}/refund
post /{original-tx-id}/refund
input
Required in body
object
original-tx-id
Required in path
string
Authorization
Required in header
string
Content-Type
Optional in header
string
application/json
text/plain
text/plain
Accept
Optional in header
string
application/json
text/plain
text/plain
200
200 OK
Example Request
curl --request POST \
--url https://sandbox.sibspayments.com/sibs/spg/v1/payments/REPLACE_ORIGINAL-TX-ID/refund \
--header 'Authorization: REPLACE_THIS_VALUE' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{"merchant":{"terminalId":"6635330662825984","channel":"ivsuctatotuha","merchantTransactionId":"3819779831889920"},"customer":{"customerInfo":{"customerName":"John","shippingAddress":{"street1":"First street","street2":"Edwi Path","city":"Lisbon","postcode":"1700-123","country":"PT"},"billingAddress":{"street1":"First street","street2":"Nonvib Heights","city":"Lisbon","postcode":"1700-123","country":"PT"},"billingAddressSameAsShippingAddress":"true"},"extendedInfo":[{"key":"gafargohuluwetuf","value":"7.7"},{"key":"ganarebacnap","value":"88.86"},{"key":"wupifozuto","value":"92.68"}]},"transaction":{"amount":{"value":20.45,"currency":"EUR"},"description":"Peg saworare zefe zopub cononja je puz wako wu dubfe zul devicare.","transactionTimestamp":"2019-04-07T18:13:18.572+01:00","originalTransaction":{"id":"8377695075303424","datetime":"2019-04-07T18:13:18.572+01:00"}},"retry":{"counter":1}}'require 'uri'
require 'net/http'
require 'openssl'
url = URI("https://sandbox.sibspayments.com/sibs/spg/v1/payments/REPLACE_ORIGINAL-TX-ID/refund")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'REPLACE_THIS_VALUE'
request["content-type"] = 'application/json'
request["accept"] = 'application/json'
request.body = "{\"merchant\":{\"terminalId\":\"6635330662825984\",\"channel\":\"ivsuctatotuha\",\"merchantTransactionId\":\"3819779831889920\"},\"customer\":{\"customerInfo\":{\"customerName\":\"John\",\"shippingAddress\":{\"street1\":\"First street\",\"street2\":\"Edwi Path\",\"city\":\"Lisbon\",\"postcode\":\"1700-123\",\"country\":\"PT\"},\"billingAddress\":{\"street1\":\"First street\",\"street2\":\"Nonvib Heights\",\"city\":\"Lisbon\",\"postcode\":\"1700-123\",\"country\":\"PT\"},\"billingAddressSameAsShippingAddress\":\"true\"},\"extendedInfo\":[{\"key\":\"gafargohuluwetuf\",\"value\":\"7.7\"},{\"key\":\"ganarebacnap\",\"value\":\"88.86\"},{\"key\":\"wupifozuto\",\"value\":\"92.68\"}]},\"transaction\":{\"amount\":{\"value\":20.45,\"currency\":\"EUR\"},\"description\":\"Peg saworare zefe zopub cononja je puz wako wu dubfe zul devicare.\",\"transactionTimestamp\":\"2019-04-07T18:13:18.572+01:00\",\"originalTransaction\":{\"id\":\"8377695075303424\",\"datetime\":\"2019-04-07T18:13:18.572+01:00\"}},\"retry\":{\"counter\":1}}"
response = http.request(request)
puts response.read_bodyimport http.client
conn = http.client.HTTPSConnection("sandbox.sibspayments.com")
payload = "{\"merchant\":{\"terminalId\":\"6635330662825984\",\"channel\":\"ivsuctatotuha\",\"merchantTransactionId\":\"3819779831889920\"},\"customer\":{\"customerInfo\":{\"customerName\":\"John\",\"shippingAddress\":{\"street1\":\"First street\",\"street2\":\"Edwi Path\",\"city\":\"Lisbon\",\"postcode\":\"1700-123\",\"country\":\"PT\"},\"billingAddress\":{\"street1\":\"First street\",\"street2\":\"Nonvib Heights\",\"city\":\"Lisbon\",\"postcode\":\"1700-123\",\"country\":\"PT\"},\"billingAddressSameAsShippingAddress\":\"true\"},\"extendedInfo\":[{\"key\":\"gafargohuluwetuf\",\"value\":\"7.7\"},{\"key\":\"ganarebacnap\",\"value\":\"88.86\"},{\"key\":\"wupifozuto\",\"value\":\"92.68\"}]},\"transaction\":{\"amount\":{\"value\":20.45,\"currency\":\"EUR\"},\"description\":\"Peg saworare zefe zopub cononja je puz wako wu dubfe zul devicare.\",\"transactionTimestamp\":\"2019-04-07T18:13:18.572+01:00\",\"originalTransaction\":{\"id\":\"8377695075303424\",\"datetime\":\"2019-04-07T18:13:18.572+01:00\"}},\"retry\":{\"counter\":1}}"
headers = {
'Authorization': "REPLACE_THIS_VALUE",
'content-type': "application/json",
'accept': "application/json"
}
conn.request("POST", "/sibs/spg/v1/payments/REPLACE_ORIGINAL-TX-ID/refund", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.sibspayments.com/sibs/spg/v1/payments/REPLACE_ORIGINAL-TX-ID/refund",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{\"merchant\":{\"terminalId\":\"6635330662825984\",\"channel\":\"ivsuctatotuha\",\"merchantTransactionId\":\"3819779831889920\"},\"customer\":{\"customerInfo\":{\"customerName\":\"John\",\"shippingAddress\":{\"street1\":\"First street\",\"street2\":\"Edwi Path\",\"city\":\"Lisbon\",\"postcode\":\"1700-123\",\"country\":\"PT\"},\"billingAddress\":{\"street1\":\"First street\",\"street2\":\"Nonvib Heights\",\"city\":\"Lisbon\",\"postcode\":\"1700-123\",\"country\":\"PT\"},\"billingAddressSameAsShippingAddress\":\"true\"},\"extendedInfo\":[{\"key\":\"gafargohuluwetuf\",\"value\":\"7.7\"},{\"key\":\"ganarebacnap\",\"value\":\"88.86\"},{\"key\":\"wupifozuto\",\"value\":\"92.68\"}]},\"transaction\":{\"amount\":{\"value\":20.45,\"currency\":\"EUR\"},\"description\":\"Peg saworare zefe zopub cononja je puz wako wu dubfe zul devicare.\",\"transactionTimestamp\":\"2019-04-07T18:13:18.572+01:00\",\"originalTransaction\":{\"id\":\"8377695075303424\",\"datetime\":\"2019-04-07T18:13:18.572+01:00\"}},\"retry\":{\"counter\":1}}",
CURLOPT_HTTPHEADER => [
"Authorization: REPLACE_THIS_VALUE",
"accept: application/json",
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"merchant\":{\"terminalId\":\"6635330662825984\",\"channel\":\"ivsuctatotuha\",\"merchantTransactionId\":\"3819779831889920\"},\"customer\":{\"customerInfo\":{\"customerName\":\"John\",\"shippingAddress\":{\"street1\":\"First street\",\"street2\":\"Edwi Path\",\"city\":\"Lisbon\",\"postcode\":\"1700-123\",\"country\":\"PT\"},\"billingAddress\":{\"street1\":\"First street\",\"street2\":\"Nonvib Heights\",\"city\":\"Lisbon\",\"postcode\":\"1700-123\",\"country\":\"PT\"},\"billingAddressSameAsShippingAddress\":\"true\"},\"extendedInfo\":[{\"key\":\"gafargohuluwetuf\",\"value\":\"7.7\"},{\"key\":\"ganarebacnap\",\"value\":\"88.86\"},{\"key\":\"wupifozuto\",\"value\":\"92.68\"}]},\"transaction\":{\"amount\":{\"value\":20.45,\"currency\":\"EUR\"},\"description\":\"Peg saworare zefe zopub cononja je puz wako wu dubfe zul devicare.\",\"transactionTimestamp\":\"2019-04-07T18:13:18.572+01:00\",\"originalTransaction\":{\"id\":\"8377695075303424\",\"datetime\":\"2019-04-07T18:13:18.572+01:00\"}},\"retry\":{\"counter\":1}}");
Request request = new Request.Builder()
.url("https://sandbox.sibspayments.com/sibs/spg/v1/payments/REPLACE_ORIGINAL-TX-ID/refund")
.post(body)
.addHeader("Authorization", "REPLACE_THIS_VALUE")
.addHeader("content-type", "application/json")
.addHeader("accept", "application/json")
.build();
Response response = client.newCall(request).execute();const request = require('request');
const options = {
method: 'POST',
url: 'https://sandbox.sibspayments.com/sibs/spg/v1/payments/REPLACE_ORIGINAL-TX-ID/refund',
headers: {
Authorization: 'REPLACE_THIS_VALUE',
'content-type': 'application/json',
accept: 'application/json'
},
body: {
merchant: {
terminalId: '6635330662825984',
channel: 'ivsuctatotuha',
merchantTransactionId: '3819779831889920'
},
customer: {
customerInfo: {
customerName: 'John',
shippingAddress: {
street1: 'First street',
street2: 'Edwi Path',
city: 'Lisbon',
postcode: '1700-123',
country: 'PT'
},
billingAddress: {
street1: 'First street',
street2: 'Nonvib Heights',
city: 'Lisbon',
postcode: '1700-123',
country: 'PT'
},
billingAddressSameAsShippingAddress: 'true'
},
extendedInfo: [
{key: 'gafargohuluwetuf', value: '7.7'},
{key: 'ganarebacnap', value: '88.86'},
{key: 'wupifozuto', value: '92.68'}
]
},
transaction: {
amount: {value: 20.45, currency: 'EUR'},
description: 'Peg saworare zefe zopub cononja je puz wako wu dubfe zul devicare.',
transactionTimestamp: '2019-04-07T18:13:18.572+01:00',
originalTransaction: {id: '8377695075303424', datetime: '2019-04-07T18:13:18.572+01:00'}
},
retry: {counter: 1}
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://sandbox.sibspayments.com/sibs/spg/v1/payments/REPLACE_ORIGINAL-TX-ID/refund"
payload := strings.NewReader("{\"merchant\":{\"terminalId\":\"6635330662825984\",\"channel\":\"ivsuctatotuha\",\"merchantTransactionId\":\"3819779831889920\"},\"customer\":{\"customerInfo\":{\"customerName\":\"John\",\"shippingAddress\":{\"street1\":\"First street\",\"street2\":\"Edwi Path\",\"city\":\"Lisbon\",\"postcode\":\"1700-123\",\"country\":\"PT\"},\"billingAddress\":{\"street1\":\"First street\",\"street2\":\"Nonvib Heights\",\"city\":\"Lisbon\",\"postcode\":\"1700-123\",\"country\":\"PT\"},\"billingAddressSameAsShippingAddress\":\"true\"},\"extendedInfo\":[{\"key\":\"gafargohuluwetuf\",\"value\":\"7.7\"},{\"key\":\"ganarebacnap\",\"value\":\"88.86\"},{\"key\":\"wupifozuto\",\"value\":\"92.68\"}]},\"transaction\":{\"amount\":{\"value\":20.45,\"currency\":\"EUR\"},\"description\":\"Peg saworare zefe zopub cononja je puz wako wu dubfe zul devicare.\",\"transactionTimestamp\":\"2019-04-07T18:13:18.572+01:00\",\"originalTransaction\":{\"id\":\"8377695075303424\",\"datetime\":\"2019-04-07T18:13:18.572+01:00\"}},\"retry\":{\"counter\":1}}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "REPLACE_THIS_VALUE")
req.Header.Add("content-type", "application/json")
req.Header.Add("accept", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}import Foundation
let headers = [
"Authorization": "REPLACE_THIS_VALUE",
"content-type": "application/json",
"accept": "application/json"
]
let parameters = [
"merchant": [
"terminalId": "6635330662825984",
"channel": "ivsuctatotuha",
"merchantTransactionId": "3819779831889920"
],
"customer": [
"customerInfo": [
"customerName": "John",
"shippingAddress": [
"street1": "First street",
"street2": "Edwi Path",
"city": "Lisbon",
"postcode": "1700-123",
"country": "PT"
],
"billingAddress": [
"street1": "First street",
"street2": "Nonvib Heights",
"city": "Lisbon",
"postcode": "1700-123",
"country": "PT"
],
"billingAddressSameAsShippingAddress": "true"
],
"extendedInfo": [
[
"key": "gafargohuluwetuf",
"value": "7.7"
],
[
"key": "ganarebacnap",
"value": "88.86"
],
[
"key": "wupifozuto",
"value": "92.68"
]
]
],
"transaction": [
"amount": [
"value": 20.45,
"currency": "EUR"
],
"description": "Peg saworare zefe zopub cononja je puz wako wu dubfe zul devicare.",
"transactionTimestamp": "2019-04-07T18:13:18.572+01:00",
"originalTransaction": [
"id": "8377695075303424",
"datetime": "2019-04-07T18:13:18.572+01:00"
]
],
"retry": ["counter": 1]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox.sibspayments.com/sibs/spg/v1/payments/REPLACE_ORIGINAL-TX-ID/refund")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(witExample Response
POST https://sandbox.sibspayments.com/sibs/spg/v1/payments/{original-tx-id}/refund
{
"merchant": {
"terminalId": "8337641745416192",
"channel": "gadnavbofh",
"merchantTransactionId": "8144928133611520",
"merchantTransactionTimestamp": "2019-04-07T18:13:18.572+01:00"
},
"returnStatus": {
"statusCode": "000",
"statusMsg": "Success",
"statusDescription": "Jefre hizfoif juvwac masetve tietu lim duvhal edojubun ow irno lojermi oju cur redahi tis uhikic okevgic sovuzni."
},
"transactionID": "3452207978512384",
"amount": {
"value": 20.45,
"currency": "EUR"
},
"transactionTimestamp": "2019-04-07T18:13:18.572+01:00",
"transactionRecipientId": "5.23.107.76",
"execution": {
"startTime": "2020-07-15T11:10:49.131Z",
"endTime": "2020-07-15T11:10:49.131Z"
},
"paymentStatus": "sulhacgolwatsel"
}Try this operation
Definitions
Object that defines the back office operation request fields.
{
"properties": {
"merchant": {
"$ref": "#/definitions/MerchantInput",
"description": "Object that defines the Merchant. Check the Merchant definition."
},
"customer": {
"$ref": "#/definitions/Customer",
"description": "Object that defines a Customer. Check the Customer definition."
},
"transaction": {
"$ref": "#/definitions/TransactionInput",
"description": "Object that defines the information about the Transaction. Check the Transaction definition."
},
"retry": {
"description": "Object that defines the retry information. Check the Retry definition.",
"$ref": "#/definitions/Retry"
}
},
"additionalProperties": false
}
Object that defines an amount.
{
"properties": {
"value": {
"type": "number",
"format": "double",
"example": 20.45
},
"currency": {
"type": "string",
"description": "The currency of the transaction.",
"example": "EUR"
}
},
"additionalProperties": false
}
Object that defines the Original Transaction.
{
"properties": {
"id": {
"type": "string",
"description": "ID of the Transaction"
},
"datetime": {
"type": "string",
"description": "The datetime of the original transaction.",
"example": "2019-04-07T18:13:18.572+01:00"
}
},
"additionalProperties": false
}
Object that defines the back office operation response fields.
{
"properties": {
"merchant": {
"$ref": "#/definitions/MerchantOutput",
"description": "Object that defines the Merchant. Check the Merchant definition."
},
"returnStatus": {
"description": "Object that defines the Return Status. Check the ReturnStatus definition.",
"$ref": "#/definitions/ReturnStatus"
},
"transactionID": {
"type": "string",
"description": "ID of the transaction"
},
"amount": {
"description": "Amount involved in the transaction",
"$ref": "#/definitions/Amount"
},
"transactionTimestamp": {
"type": "string",
"description": "Transaction timestamp",
"example": "2019-04-07T18:13:18.572+01:00"
},
"transactionRecipientId": {
"type": "string",
"description": "Transaction recipient ID"
},
"execution": {
"description": "Description of an Execution, see the Execution definition.",
"$ref": "#/definitions/Execution"
},
"paymentStatus": {
"type": "string"
}
},
"additionalProperties": false
}
{
"properties": {
"amount": {
"description": "Transaction amount",
"$ref": "#/definitions/Amount"
},
"description": {
"type": "string",
"description": "Transaction description"
},
"transactionTimestamp": {
"type": "string",
"description": "Timestamp of the transaction",
"example": "2019-04-07T18:13:18.572+01:00"
},
"originalTransaction": {
"description": "Object that defines the information about the Original Transaction. Check the Original Transaction definition.",
"$ref": "#/definitions/OriginalTransaction"
}
},
"additionalProperties": false
}
Object that defines the status of the processed transaction.
{
"properties": {
"statusCode": {
"type": "string",
"description": "Identifier code of the processed transaction status.",
"example": "000"
},
"statusMsg": {
"type": "string",
"description": "Message of the processed transaction status.",
"example": "Success"
},
"statusDescription": {
"type": "string",
"description": "Description of the processed transaction status."
}
},
"additionalProperties": false
}
Object that defines a customer.
{
"properties": {
"customerInfo": {
"description": "Object that defines the customer predefined information (name, age, etc). Check the CustomerInfo definition.",
"example": "",
"$ref": "#/definitions/CustomerInfo"
},
"extendedInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/ExtendedInfo"
},
"description": "Key Value tuple array."
}
},
"additionalProperties": false
}
Object that defines the predefined customer information.
{
"properties": {
"customerName": {
"type": "string",
"description": "Name of the customer.",
"example": "John"
},
"shippingAddress": {
"$ref": "#/definitions/Address",
"description": "Object that defines the customers address. Check the Address definition."
},
"billingAddress": {
"$ref": "#/definitions/Address",
"description": "Object that defines the customers address. Check the Address definition."
},
"billingAddressSameAsShippingAddress": {
"type": "boolean",
"description": "Flag that identifies that the billing address is the same as the shipping address",
"example": "true"
}
},
"additionalProperties": false
}
Key value tuple.
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
{
"properties": {
"street1": {
"type": "string",
"example": "First street"
},
"street2": {
"type": "string"
},
"city": {
"type": "string",
"example": "Lisbon"
},
"postcode": {
"type": "string",
"example": "1700-123"
},
"country": {
"type": "string",
"example": "PT"
}
},
"additionalProperties": true
}
Object that defines a Merchant.
{
"properties": {
"terminalId": {
"type": "string",
"description": "Terminal ID"
},
"channel": {
"type": "string",
"description": "Channel used in the transaction"
},
"merchantTransactionId": {
"type": "string",
"description": "Unique identifier of the transaction in the merchant perspective"
}
},
"additionalProperties": false
}
Object that defines a Merchant.
{
"properties": {
"terminalId": {
"type": "string",
"description": "Terminal ID"
},
"channel": {
"type": "string",
"description": "Channel used in the transaction"
},
"merchantTransactionId": {
"type": "string",
"description": "Unique identifier of the transaction in the merchant perspective"
},
"merchantTransactionTimestamp": {
"type": "string",
"description": "Merchant transaction timestamp",
"example": "2019-04-07T18:13:18.572+01:00"
}
},
"additionalProperties": false
}
Retry counter for repeated invocations
{
"properties": {
"counter": {
"type": "integer",
"example": 1,
"description": "Counter for the number of retries for repeating invocations.",
"format": "int32"
}
},
"additionalProperties": false
}
{
"properties": {
"startTime": {
"type": "string",
"description": "Time of the acceptance of the request by the API.",
"format": "date-time",
"example": "2020-07-15T11:10:49.131Z"
},
"endTime": {
"type": "string",
"description": "Time of the response to the request by the API.",
"format": "date-time",
"example": "2020-07-15T11:10:49.131Z"
}
},
"additionalProperties": false
}