NAnash
Job

Update Refund Request

Update the status or details of an existing refund request.

post/v1/refund-request/update

Request

  • Base URL
    https://api.sandbox.usenash.com
  • Auth
    none declared

Request body

refundRequestIdstring nullable

The ID of the refund request.

providerDeliveryIdstring nullable

The ID of the delivery.

status'under_review' | 'cancelled' | 'approved' | 'denied' | 'nash_approved' | 'draft' | 'needs_attention' nullable

The status of the refund request.

refundAmountCentsinteger nullable

The total refund amount in cents.

refundAmountDeliveryFeeCentsinteger nullable

The refund amount for the delivery fee in cents.

refundAmountOrderValueCentsinteger nullable

The refund amount for the order value in cents.

refundAmountTipCentsinteger nullable

The refund amount for the tip in cents.

responsestring nullable

The response from the courier.

Response

OK

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 nullable required

The requested refund amount for the order value.

refundAmountTipCentsinteger nullable required

The requested refund amount for the tip.

currencystring nullable required

The currency of the refund request.

responsestring nullable 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
}

Changes

No recorded changes to this operation across all 1 revision of this API.