Skip to content

Refund Payment

Request

Security
OAuth2ClientCredentials(Required scopes: organization:payflow:update)
Headers
X-Organization-Idstring(X-Organization-Id)

Required if the account is part of multiple organizations. If the account only has access to one organization, this header is not required.

Bodyapplication/jsonrequired
crossPaymentstring(Crosspayment)required
Any of:
string
currencystring(Currency)required
totalGrossAmountnumber(Totalgrossamount)required
totalNetAmountnumber(Totalnetamount)required
invoiceLinesArray of objects(Invoicelines)
Default:[]
POST
/api/refund
curl -i -X POST \
  https://api.spense.no/api/refund \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Organization-Id: string' \
  -d '{
    "crossPayment": "string",
    "currency": "string",
    "totalGrossAmount": 0,
    "totalNetAmount": 0,
    "invoiceLines": []
  }'

Responses

Successful Response

Bodyapplication/json
refundTypestring(Refundtype)required
debtorAccountNumberstring(Debtoraccountnumber)
Default:""
originalAmountnumber(Originalamount)required
originalCurrencystring(Originalcurrency)required
grossRefundedAmountnumber(Grossrefundedamount)required
netRefundedAmountnumber(Netrefundedamount)required
remainingAmountnumber or null(Remainingamount)required
Any of:
number
refundIdstring(Refundid)required
Response
{
  "refundType": "string",
  "debtorAccountNumber": "",
  "originalAmount": 0,
  "originalCurrency": "string",
  "grossRefundedAmount": 0,
  "netRefundedAmount": 0,
  "remainingAmount": 0,
  "refundId": "string"
}
Copyright © Spense AS