Skip to main content
GET
/
v1
/
refund-requests
Get Refund Requests by Task ID or Job ID
curl --request GET \
  --url https://api.sandbox.usenash.com/v1/refund-requests \
  --header 'Authorization: Bearer <token>'
[
  {
    "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>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
taskId
string | null

The task ID to filter by.

​
jobId
string | null

The job ID to filter by.

Response

OK

​
id
string
required

The ID of the refund request.

Example:

"rfrq_01234567890123456789"

​
createdAt
string
required

The date and time when the refund request was created.

Example:

"2023-08-29T19:17:46.264523"

​
jobId
string
required

The job this refund request is associated with.

Example:

"job_01234567890123456789"

​
taskId
string
required

The task this refund request is associated with.

Example:

"tsk_01234567890123456789"

​
organizationId
string
required

The ID of the organization.

Example:

"org_01234567890123456789"

​
incidentSubtype
string
required

The subtype of the incident.

​
incidentNotes
string
required

Notes about the incident from the merchant.

​
status
required

The status of the refund request.

Available options:
1,
2,
3,
4,
5,
6,
7
Example:

"approved"

​
refundAmountCents
integer | null
required

The total requested refund amount.

Example:

11500

​
refundAmountDeliveryFeeCents
integer | null
required

The requested refund amount for the delivery fee.

Example:

1000

​
refundAmountOrderValueCents
integer
required

The requested refund amount for the order value.

Example:

10000

​
refundAmountTipCents
integer
required

The requested refund amount for the tip.

Example:

500

​
currency
string | null
required

The currency of the refund request.

Example:

"USD"

​
response
string
required

The response from the courier.

​
proofOfRefund
string | null
required

The supporting evidence for the refund.