v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Create an Invoice Return

Use this route to retrieve a receipt by Id

post/invoicereturn

Query parameters

idinteger required

Invoice Id

echoboolean

Request body

merchantIdinteger required

typestring

totalAmountstring

subTotalAmountstring

discountAmountstring

balancestring

paidAmountstring

Response

201

idinteger

merchantIdinteger

invoiceIdinteger

referencestring

createdstring

modifiedstring

subtotalAmountstring

discountAmountstring

totalAmountstring

lineItemCountinteger

balancestring

lineItemsobject[]

shippingLineItemsobject[]

discountsobject[]

taxesobject[]

adjustmentAmountstring

Example response

{
  "id": 176,
  "merchantId": 516167953,
  "invoiceId": 263735,
  "reference": "R27678DO7HK5",
  "created": "2022-03-14T18:23:08.047Z",
  "modified": "2022-03-14T18:23:08.39Z",
  "subtotalAmount": "100",
  "discountAmount": "0",
  "totalAmount": "0",
  "balance": "100",
  "payments": [
    {
      "created": "2022-03-14T18:23:07.837Z",
      "paymentToken": "PiMH044IH6Iklj8esghZ8humUZ4C74qn",
      "originalId": 86505715,
      "id": 86620404,
      "creatorName": "SDK Testing Key",
      "merchantId": 516167953,
      "batch": "0025",
      "batchId": 10000000271417,
      "tenderType": "Card",
      "currency": "USD",
      "amount": "-100",
      "cardAccount": {
        "cardType": "Visa",
        "entryMode": "Keyed",
        "last4": "5556",
        "token": "PiMH044IH6Iklj8esghZ8humUZ4C74qn",
        "expiryMonth": "11",
        "expiryYear": "38",
        "cardPresent": true
      },
      "status": "Declined",
      "settledAmount": "0",
      "settledCurrency": "USD",
      "cardPresent": true,
      "authMessage": "Payment already refunded",
      "availableAuthAmount": "0",
      "reference": "207318009996",
      "invoice": "1050",
      "customerName": "Sora Dawn",
      "type": "Return"
    }
  ],
  "adjustmentAmount": "0"
}