Direct Integration
Order management APIs
Refund API

POST /v1/direct/order/refund-request

Headers

api-key: Server API key provided via secure email or the merchant dashboard

JSON Schema

JSON
{
   "orderID":{
      "type":"string",
      "description":"This orderID is the one generated by your integration. If you are using an integration like Salesforce this will be the ID of the order created in Salesforce.",
      "required":true
   },
   "amount":{
      "type":"number",
      "description":"Specified when the refund request is a partial refund request with a specific amount. This amount must be less than the order total."
   }
}

Response Codes

CodeDescription
201Request created
400Headers or request body were not provided correctly
401API Key not valid
403API Key cannot access this resource
422The order is in a state where refund cannot be requested, e.g., void
500Internal server error