Refund

post

https://api-sandbox.sprinque.com/api/v1/transactions/refund/{transaction_id}

The Refund API is used to process a refund for a transaction that has been successfully captured.
If the refund is successful, the credit note will be added to the transaction record and settlement will be (partially) reversed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

transaction_id

string

required

Unique id of the transaction generated by Sprinque.

Body Params

merchant_credit_note_id

string

required

Credit note number generated by the merchant for the invoice being refunded.

credit_note_url

uri

Url generated by the merchant from where the credit note pdf can be downloaded.

file_id

string

Either URL or file_id of the credit note is needed for refund. File_id can be generated by calling the upload_file api

credit_note_amount

string

required

Monetary value of the credit note.

credit_note_currency

string

length ≤ 3

Defaults to EUR

Credit note currency code in ISO 4217. Supported: EUR

date

required

Date of credit note. Format YYYY-MM-DD

metadata

object

Metadata is a JSON object for passing any custom information like the digital footprint of the buyer. (e.g., IP address, browser type etc)

Headers

X-API-KEY-ID

string

required

Sprinque authenticates using API keys.
API Key can be generated on the Sprinque
MCC portal from the “My Account” page.
The same key can be used for all API calls.

Response

200