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>'
import requests

url = "https://api.sandbox.usenash.com/v1/refund-requests"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.usenash.com/v1/refund-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.usenash.com/v1/refund-requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.usenash.com/v1/refund-requests"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.sandbox.usenash.com/v1/refund-requests")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sandbox.usenash.com/v1/refund-requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "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>",
    "requestAmountCents": 11500,
    "requestAmountDeliveryFeeCents": 1000,
    "requestAmountOrderValueCents": 10000,
    "requestAmountTipCents": 500,
    "resolutionDate": "2023-08-30T14:30:00.000000"
  }
]
[
  {
    "error": {
      "code": "<string>",
      "message": "<string>",
      "details": {}
    },
    "response_status": "<string>",
    "RequestID": "<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.

requestAmountCents
integer | null
required

The request amount for the delivery fee, order value, and tip in cents.

Example:

11500

requestAmountDeliveryFeeCents
integer | null
required

The request amount for the delivery fee in cents.

Example:

1000

requestAmountOrderValueCents
integer | null
required

The request amount for the order value in cents.

Example:

10000

requestAmountTipCents
integer | null
required

The request amount for the tip in cents.

Example:

500

resolutionDate
string | null

The date and time when the refund request was resolved (status changed to approved, denied, cancelled, or nash_approved).

Example:

"2023-08-30T14:30:00.000000"