Class: Preauthorization

Preauthorization

If you'd like to reserve some money from the client's credit card but you'd also like to execute the transaction itself a bit later, then use preauthorizations. This is NOT possible with direct debit.
A preauthorization is valid for 7 days.

new Preauthorization()

Creates a new Preauthorization. Generally you should never create a PAYMILL object on your own.
Source:

Classes

Filter
Order

Members

<static> Status

Status of a Preauthorization.
Properties:
Name Type Description
OPEN string
PENDING string
CLOSED string
FAILED string
DELETED string
PREAUTH string
Source:

amount :string

Formatted amount which will be reserved for further transactions.
Type:
  • string
Source:

app_id :string

App (ID) that created this payment or null if created by yourself.
Type:
  • string
Source:

client :Client

Corresponding client object.
Type:
Source:

created_at :Date

Unix-Timestamp for the creation date.
Type:
  • Date
Source:

currency :string

ISO 4217 formatted currency code.
Type:
  • string
Source:

description :string

Additional description for this preauthorization.
Type:
  • string
Source:

id :string

Unique identifier for this payment.
Type:
  • string
Source:

livemode :boolean

Whether this preauthorization was issued while being in live mode or not.
Type:
  • boolean
Source:

payment :Payment

Corresponding payment object.
Type:
Source:

status :Preauthorization.Status

Indicates the current status of this preauthorization.
Type:
Source:

transaction :Transaction

Corresponding Transaction object.
Type:
Source:

updated_at :Date

Unix-Timestamp for the last update.
Type:
  • Date
Source: