PUT POS/v3.1/PurchaseOrders/{id}/Payments/{purchaseOrderPaymentId} Try Now

Refund or remove without refund

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id
Purchase OrderId
 string
Required
purchaseOrderPaymentId
PurchaseOrder PaymentId
 string
Required

Body Parameters

Refund Request

POPaymentRefundOrRemoveWithoutRefund
NameDescriptionTypeAdditional information
Action
Options for Refund
 RefundOption
Required
POPaymentRefund
PO Payment Refund Request
 POPaymentRefundRequest
Conditional - Only Required when Action is Refund

Request Formats

application/json, text/json

Sample: 
{
  "Action": "Refund",
  "POPaymentRefund": {
    "RefundDate": "2025-01-11T03:29",
    "Amount": 1.0,
    "Note": "",
    "AdjustAmount": true,
    "ReferenceNumber": ""
  }
}

Response Information

Resource Description

Payment refunded/Deleted Successfully

None.