v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB

Job

Get Refund Requests by Task ID or Job ID

Retrieve all refund requests associated with a task or job. At least one of task_id or job_id must be provided.

get/v1/refund-requests

Query parameters

taskIdstring nullable

The task ID to filter by.

jobIdstring nullable

The job ID to filter by.

Response

idstring required

The ID of the refund request.

createdAtstring required

The date and time when the refund request was created.

resolutionDatestring nullable

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

jobIdstring required

The job this refund request is associated with.

taskIdstring required

The task this refund request is associated with.

organizationIdstring required

The ID of the organization.

incidentSubtypestring required

The subtype of the incident.

incidentNotesstring required

Notes about the incident from the merchant.

refundAmountCentsinteger nullable required

The total requested refund amount.

refundAmountDeliveryFeeCentsinteger nullable required

The requested refund amount for the delivery fee.

refundAmountOrderValueCentsinteger required

The requested refund amount for the order value.

refundAmountTipCentsinteger required

The requested refund amount for the tip.

currencystring nullable required

The currency of the refund request.

responsestring required

The response from the courier.

proofOfRefundstring nullable required

The supporting evidence for the refund.

requestAmountCentsinteger nullable required

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

requestAmountDeliveryFeeCentsinteger nullable required

The request amount for the delivery fee in cents.

requestAmountOrderValueCentsinteger nullable required

The request amount for the order value in cents.

requestAmountTipCentsinteger nullable required

The request amount for the tip in cents.

Example response

[
  {
    "id": "rfrq_01234567890123456789",
    "createdAt": "2023-08-29T19:17:46.264523",
    "resolutionDate": "2023-08-30T14:30:00.000000",
    "jobId": "job_01234567890123456789",
    "taskId": "tsk_01234567890123456789",
    "organizationId": "org_01234567890123456789",
    "refundAmountCents": 11500,
    "refundAmountDeliveryFeeCents": 1000,
    "refundAmountOrderValueCents": 10000,
    "refundAmountTipCents": 500,
    "currency": "USD",
    "requestAmountCents": 11500,
    "requestAmountDeliveryFeeCents": 1000,
    "requestAmountOrderValueCents": 10000,
    "requestAmountTipCents": 500
  }
]