--- swagger: "2.0" info: x-ibm-name: refund-sandbox title: REFUND API version: 1.0.0 description: The Refund API requests the refund of the amount (full or partial) of a previous payment (purchase or captures transactions only). schemes: - https basePath: /sibs/spg/v1/payments consumes: - application/json - text/plain produces: - application/json - text/plain security: [] x-ibm-configuration: testable: true enforced: true phase: realized paths: /{original-tx-id}/refund: post: responses: 200: description: 200 OK schema: $ref: '#/definitions/BackOfficeResponse' parameters: - $ref: '#/parameters/input' - $ref: '#/parameters/original-tx-id' - $ref: '#/parameters/Authorization' operationId: refund definitions: BackOfficeRequest: 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 description: Object that defines the back office operation request fields. Amount: properties: value: type: number format: double example: 20.450000 currency: type: string description: The currency of the transaction. example: EUR additionalProperties: false description: Object that defines an amount. OriginalTransaction: 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 description: Object that defines the Original Transaction. BackOfficeResponse: 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 description: Object that defines the back office operation response fields. TransactionInput: 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 ReturnStatus: 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 description: Object that defines the status of the processed transaction. 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 description: Object that defines a customer. CustomerInfo: 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 description: Object that defines the predefined customer information. ExtendedInfo: type: object properties: key: type: string value: type: string description: Key value tuple. Address: 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 MerchantInput: 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 description: Object that defines a Merchant. MerchantOutput: 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 description: Object that defines a Merchant. Retry: properties: counter: type: integer example: 1 description: Counter for the number of retries for repeating invocations. format: int32 additionalProperties: false description: Retry counter for repeated invocations Execution: 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 tags: [] parameters: input: name: input required: true in: body schema: $ref: '#/definitions/BackOfficeRequest' original-tx-id: name: original-tx-id type: string required: true in: path Authorization: name: Authorization type: string required: true in: header x-ibm-endpoints: - endpointUrl: https://sandbox.sibspayments.com type: - production - development ...