API docs by Redocly

Repzo API - Refund (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Refund endpoints.

Find refunds

query Parameters
object

Query parameters for filtering refunds

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0
}

Create a refund

Request Body schema: application/json
client
required
string

Client ID associated with the refund

rep
string

Representative ID who processed the refund

invoice
string

Invoice ID being refunded

amount
required
number

Refund amount

reason
required
string

Reason for the refund

refundMethod
string

Method of refund

reference
string

Reference number for the refund

notes
string

Additional notes

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "rep": "string",
  • "invoice": "string",
  • "amount": 0,
  • "reason": "string",
  • "refundMethod": "string",
  • "reference": "string",
  • "notes": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "invoice": "string",
  • "amount": 0,
  • "reason": "string",
  • "status": "pending",
  • "refundMethod": "string",
  • "reference": "string",
  • "notes": "string",
  • "processedAt": "2019-08-24T14:15:22Z",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a refund by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "invoice": "string",
  • "amount": 0,
  • "reason": "string",
  • "status": "pending",
  • "refundMethod": "string",
  • "reference": "string",
  • "notes": "string",
  • "processedAt": "2019-08-24T14:15:22Z",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Update a refund

path Parameters
id
required
string
Request Body schema: application/json
status
string
Enum: "pending" "approved" "rejected" "processed"

Status of the refund

refundMethod
string

Method of refund

reference
string

Reference number for the refund

notes
string

Additional notes

processedAt
string <date-time>

When the refund was processed

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "status": "pending",
  • "refundMethod": "string",
  • "reference": "string",
  • "notes": "string",
  • "processedAt": "2019-08-24T14:15:22Z",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "invoice": "string",
  • "amount": 0,
  • "reason": "string",
  • "status": "pending",
  • "refundMethod": "string",
  • "reference": "string",
  • "notes": "string",
  • "processedAt": "2019-08-24T14:15:22Z",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}