GET
/
v1
/
refund-requests
curl --request GET \
  --url https://api.sandbox.usenash.com/v1/refund-requests
[
  {
    "id": "rfrq_01234567890123456789",
    "createdAt": "2023-08-29T19:17:46.264523",
    "jobId": "job_01234567890123456789",
    "taskId": "tsk_01234567890123456789",
    "organizationId": "org_01234567890123456789",
    "incidentSubtype": "<string>",
    "incidentNotes": "<string>",
    "status": "approved",
    "refundAmountCents": 11500,
    "refundAmountDeliveryFeeCents": 1000,
    "refundAmountOrderValueCents": 10000,
    "refundAmountTipCents": 500,
    "currency": "USD",
    "response": "<string>",
    "proofOfRefund": "<string>"
  }
]

Query Parameters

​
taskId
string | null

The task ID to filter by.

​
jobId
string | null

The job ID to filter by.

Response

200
application/json
OK
​
id
string
required

The ID of the refund request.

​
createdAt
string
required

The date and time when the refund request was created.

​
jobId
string
required

The job this refund request is associated with.

​
taskId
string
required

The task this refund request is associated with.

​
organizationId
string
required

The ID of the organization.

​
incidentSubtype
string
required

The subtype of the incident.

​
incidentNotes
string
required

Notes about the incident from the merchant.

​
status
enum<integer>
required

The status of the refund request.

Available options:
1,
2,
3,
4,
5
​
refundAmountCents
integer
required

The total requested refund amount.

​
refundAmountDeliveryFeeCents
integer
required

The requested refund amount for the delivery fee.

​
refundAmountOrderValueCents
integer
required

The requested refund amount for the order value.

​
refundAmountTipCents
integer
required

The requested refund amount for the tip.

​
currency
string
required

The currency of the refund request.

​
response
string
required

The response from the courier.

​
proofOfRefund
string
required

The supporting evidence for the refund.

Create Delivery IncidentGet Refund Request