Model paymentrequests

Permissions

User Group	Create?	Read?	Update?	Delete?
finance		x
setup	x	x	x	x
admin	x	x	x
user		x
member		x
all

Fields

Name	Type	Link	Maps To	Default	Indexed?	Required?
__v	Number
_deleted	Boolean			false	x
_id	ObjectID			[Function]
_owner_id	ObjectID	User	_owner		x
_updated_by_id	ObjectID	User	_updated_by		x
callback_url	String
cancelled_at	Date
createdAt	Date
currency	String			ZAR		x
description	String
failed_at	Date
initiated_at	Date			[Function]
invoice_id	ObjectID	Invoice
invoice_nr	String
notes	String
paid_at	Date
payment_link	String
platform	String
platform_request_id	String
platform_response	Mixed
platform_url	String
redirect_url	String
status	String			initiated
total	Number					x
updatedAt	Date
user_id	ObjectID	User

Field Details

__v

{
  "path": "__v",
  "instance": "Number",
  "options": {},
  "validators": []
}

_deleted

{
  "path": "_deleted",
  "instance": "Boolean",
  "options": {
    "default": false,
    "index": true
  },
  "validators": [],
  "defaultValue": false
}

_id

{
  "path": "_id",
  "instance": "ObjectID",
  "options": {
    "auto": true,
    "type": "ObjectId"
  },
  "validators": [],
  "defaultValue": "[Function]"
}

_owner_id

{
  "path": "_owner_id",
  "instance": "ObjectID",
  "options": {
    "link": "User",
    "map_to": "_owner",
    "index": true
  },
  "validators": []
}

_updated_by_id

{
  "path": "_updated_by_id",
  "instance": "ObjectID",
  "options": {
    "link": "User",
    "map_to": "_updated_by",
    "index": true
  },
  "validators": []
}

callback_url

{
  "path": "callback_url",
  "instance": "String",
  "options": {},
  "validators": []
}

cancelled_at

{
  "path": "cancelled_at",
  "instance": "Date",
  "options": {},
  "validators": []
}

createdAt

{
  "path": "createdAt",
  "instance": "Date",
  "options": {
    "immutable": true
  },
  "validators": []
}

currency

{
  "path": "currency",
  "instance": "String",
  "options": {
    "required": true,
    "default": "ZAR"
  },
  "validators": [
    {
      "message": "Path `{PATH}` is required."
    }
  ],
  "isRequired": true,
  "defaultValue": "ZAR"
}

Validators

: Path `{PATH}` is required.

description

{
  "path": "description",
  "instance": "String",
  "options": {},
  "validators": []
}

failed_at

{
  "path": "failed_at",
  "instance": "Date",
  "options": {},
  "validators": []
}

initiated_at

{
  "path": "initiated_at",
  "instance": "Date",
  "options": {},
  "validators": [],
  "defaultValue": "[Function]"
}

invoice_id

{
  "path": "invoice_id",
  "instance": "ObjectID",
  "options": {
    "link": "Invoice"
  },
  "validators": []
}

invoice_nr

{
  "path": "invoice_nr",
  "instance": "String",
  "options": {},
  "validators": []
}

notes

{
  "path": "notes",
  "instance": "String",
  "options": {},
  "validators": []
}

paid_at

{
  "path": "paid_at",
  "instance": "Date",
  "options": {},
  "validators": []
}

payment_link

{
  "path": "payment_link",
  "instance": "String",
  "options": {},
  "validators": []
}

platform

{
  "path": "platform",
  "instance": "String",
  "options": {},
  "validators": []
}

platform_request_id

{
  "path": "platform_request_id",
  "instance": "String",
  "options": {},
  "validators": []
}

platform_response

{
  "path": "platform_response",
  "instance": "Mixed",
  "options": {},
  "validators": []
}

platform_url

{
  "path": "platform_url",
  "instance": "String",
  "options": {},
  "validators": []
}

redirect_url

{
  "path": "redirect_url",
  "instance": "String",
  "options": {},
  "validators": []
}

status

{
  "path": "status",
  "instance": "String",
  "options": {
    "enum": [
      "initiated",
      "pending",
      "processing",
      "paid",
      "failed",
      "cancelled"
    ],
    "default": "initiated"
  },
  "validators": [
    {
      "message": "`{VALUE}` is not a valid enum value for path `{PATH}`."
    }
  ],
  "defaultValue": "initiated"
}

Validators

: `{VALUE}` is not a valid enum value for path `{PATH}`.

total

{
  "path": "total",
  "instance": "Number",
  "options": {
    "required": true
  },
  "validators": [
    {
      "message": "Path `{PATH}` is required."
    },
    {
      "message": "Validator failed for path `{PATH}` with value `{VALUE}`"
    }
  ],
  "isRequired": true
}

Validators

: Path `{PATH}` is required.
: Validator failed for path `{PATH}` with value `{VALUE}`

updatedAt

{
  "path": "updatedAt",
  "instance": "Date",
  "options": {},
  "validators": []
}

user_id

{
  "path": "user_id",
  "instance": "ObjectID",
  "options": {
    "link": "User"
  },
  "validators": []
}