production
development
https://sandbox.sibspayments.com
Paths
/{original-tx-id}/refund
post /{original-tx-id}/refund
clientid
X-IBM-Client-Id
(apiKey located in header)
input
Required in body
object
original-tx-id
Required in path
string
authorization
Required in header
string
Signature
Optional in header
string
For now, the type of HMAC used will be SHA2 (SHA512). base64
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
Example Request
Example Response
POST https://sandbox.sibspayments.com/sibs/spg/v2/payments/{original-tx-id}/refund
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
}
Parameter with the value and currency of the transaction.
{
"required": [
"value",
"currency"
],
"properties": {
"value": {
"type": "number",
"format": "double",
"example": 5
},
"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",
"example": "{Place TransactionId}"
},
"datetime": {
"type": "string",
"description": "The datetime of the original transaction.",
"example": "2020-12-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": "Describes the status of the request. (Attention: it doesn't describe the state of the transaction itself).",
"$ref": "#/definitions/ReturnStatus"
},
"transactionID": {
"type": "string",
"description": "ID of the transaction"
},
"amount": {
"description": "Parameter with the value and currency of the transaction.",
"$ref": "#/definitions/Amount"
},
"transactionTimestamp": {
"type": "string",
"description": "Transaction timestamp",
"example": "2019-04-07T18:13:18.572+01:00"
},
"transactionRecipientId": {
"type": "string",
"description": "Original Transaction ID."
},
"execution": {
"description": "Description of an Execution, see the Execution definition.",
"$ref": "#/definitions/Execution"
},
"paymentStatus": {
"type": "string",
"description": "Status of the payment.",
"enum": [
"Success",
"Partial",
"Declined",
"InProcessing",
"Pending",
"Timeout",
"Error"
],
"default": "Success"
},
"hmac": {
"type": "string",
"maxLength": 128,
"description": "For now, the type of HMAC used will be SHA2 (SHA512)."
}
},
"additionalProperties": false
}
{
"properties": {
"amount": {
"description": "Transaction amount",
"$ref": "#/definitions/Amount"
},
"description": {
"type": "string",
"description": "Transaction description",
"example": "Transaction short description"
},
"transactionTimestamp": {
"type": "string",
"description": "Timestamp of the transaction",
"example": "2020-12-07T18:13:18.572+01:00"
},
"originalTransaction": {
"description": "Original transaction of a Backoffice transaction.",
"$ref": "#/definitions/OriginalTransaction"
}
},
"additionalProperties": false
}
Describes the status of the request. (Attention: it doesn't describe the state of the transaction itself).
{
"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,
"required": [
"statusCode",
"statusMsg",
"statusDescription"
]
}
Object that defines a customer.
{
"properties": {
"customerInfo": {
"description": "Object that defines the customer predefined information (name, age, etc). Check the CustomerInfo definition.",
"$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.",
"maxLength": 45,
"example": "John"
},
"customerEmail": {
"type": "string",
"description": "Customer e-mail."
},
"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",
"required": [
"key",
"value"
],
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
{
"properties": {
"street1": {
"type": "string",
"maxLength": 70,
"description": "Address Street. Maximum length is 50.",
"example": "First street"
},
"street2": {
"type": "string",
"maxLength": 70,
"description": "Address Additional Street. Maximum length is 19."
},
"city": {
"type": "string",
"maxLength": 35,
"description": "Address city or town. Maximum length is 35.",
"example": "Lisbon"
},
"postcode": {
"type": "string",
"maxLength": 16,
"description": "Address Postal Code. Maximum length is 16.",
"example": "1700-123"
},
"country": {
"type": "string",
"pattern": "[A-Z]{2}",
"description": "Country Code. Alpha2",
"example": "PT"
}
},
"additionalProperties": true
}
Object that defines a Merchant.
{
"properties": {
"terminalId": {
"type": "string",
"description": "Terminal ID",
"example": "47215"
},
"channel": {
"type": "string",
"description": "Channel used in the transaction",
"example": "web"
},
"merchantTransactionId": {
"type": "string",
"description": "Unique identifier of the transaction in the merchant perspective",
"example": "5351136",
"maxLength": 35
}
},
"additionalProperties": false
}
Object that defines a Merchant.
{
"properties": {
"terminalId": {
"type": "string",
"description": "Merchant terminal id."
},
"channel": {
"type": "string",
"description": "Merchant channel."
},
"merchantTransactionId": {
"type": "string",
"description": "Id of the transaction in merchant store.",
"maxLength": 35
},
"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
}
{
"required": [
"startTime",
"endTime"
],
"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
}