Skip to main content

CreateCreditNoteRequest

creditAmountinteger<int64>

Possible values: >= 0

currencystring
customerIdstringrequired

Possible values: non-empty

lineItems object[]required
  • Array [
  • descriptionstringrequired

    Possible values: non-empty

    externalLineItemIdstringnullable
    quantityinteger<int32>

    Possible values: >= 1

    typestring
    unitAmountinteger<int64>required

    Possible values: >= 0

  • ]
  • locationIdstringnullable
    merchantIdstringnullable
    outOfBandAmountinteger<int64>

    Possible values: >= 0

    paymentIdstringrequired

    Possible values: non-empty

    reasonstringnullable
    refundAmountinteger<int64>

    Possible values: >= 0

    refundedTipAmountinteger<int64>nullable

    Possible values: >= 0

    transactionIdstringnullable
    CreateCreditNoteRequest
    {
    "creditAmount": 0,
    "currency": "string",
    "customerId": "string",
    "lineItems": [
    {
    "description": "string",
    "externalLineItemId": "string",
    "quantity": 0,
    "type": "string",
    "unitAmount": 0
    }
    ],
    "locationId": "string",
    "merchantId": "string",
    "outOfBandAmount": 0,
    "paymentId": "string",
    "reason": "string",
    "refundAmount": 0,
    "refundedTipAmount": 0,
    "transactionId": "string"
    }