Paystack · JSON Structure

Paystack Transfer Structure

JSON Structure for a Paystack transfer payout to a bank or mobile money wallet.

Type: object Properties: 12 Required: 5
PaymentsAfricaFintechRecurring BillingMarketplacesPayoutsMobile MoneyStripe

PaystackTransfer is a JSON Structure definition published by Paystack, describing 12 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/extended/v0/# meta-schema.

Properties

id transfer_code reference amount currency source reason recipient status transferred_at failures created_at

Meta-schema: https://json-structure.org/meta/extended/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/extended/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/paystack/main/json-structure/paystack-transfer-structure.json",
  "name": "PaystackTransfer",
  "type": "object",
  "description": "JSON Structure for a Paystack transfer payout to a bank or mobile money wallet.",
  "properties": {
    "id": { "type": "int64" },
    "transfer_code": { "type": "string", "description": "Prefixed with TRF_." },
    "reference": { "type": "string" },
    "amount": { "type": "int64" },
    "currency": { "type": "string" },
    "source": { "type": "string", "description": "Always 'balance'." },
    "reason": { "type": "string" },
    "recipient": { "type": "int64", "description": "Recipient id." },
    "status": { "type": "string", "description": "pending, otp, success, failed, reversed, abandoned." },
    "transferred_at": { "type": "string", "format": "date-time" },
    "failures": { "type": "any" },
    "created_at": { "type": "string", "format": "date-time" }
  },
  "required": ["transfer_code", "amount", "currency", "recipient", "status"]
}