Paystack · Schema

Paystack Refund

A refund issued against a successful Paystack transaction.

PaymentsAfricaFintechRecurring BillingMarketplacesPayoutsMobile MoneyStripe

Properties

Name Type Description
id integer
transaction integer ID or reference of the transaction being refunded.
amount integer Refund amount in the lowest denomination.
currency string
channel string
merchant_note stringnull
customer_note stringnull
status string
refunded_by stringnull
refunded_at stringnull
expected_at stringnull
created_at string
View JSON Schema on GitHub

JSON Schema

paystack-refund-schema.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/paystack/main/json-schema/paystack-refund-schema.json",
  "title": "Paystack Refund",
  "description": "A refund issued against a successful Paystack transaction.",
  "type": "object",
  "required": ["transaction", "amount", "currency", "status"],
  "properties": {
    "id": { "type": "integer" },
    "transaction": { "type": "integer", "description": "ID or reference of the transaction being refunded." },
    "amount": { "type": "integer", "description": "Refund amount in the lowest denomination." },
    "currency": { "type": "string" },
    "channel": { "type": "string" },
    "merchant_note": { "type": ["string", "null"] },
    "customer_note": { "type": ["string", "null"] },
    "status": {
      "type": "string",
      "enum": ["pending", "processing", "processed", "failed"]
    },
    "refunded_by": { "type": ["string", "null"] },
    "refunded_at": { "type": ["string", "null"], "format": "date-time" },
    "expected_at": { "type": ["string", "null"], "format": "date-time" },
    "created_at": { "type": "string", "format": "date-time" }
  }
}