# States

On authorization a state first goes through pre-authorization then post-authorization.

# PreAuthorization

Property Type
merchant Merchant
authorization See definition below
now Date

authorization field:

Property Type Description Optional
amount number
currency Currency
card See definition below
capture "auto" Yes
descriptor string Yes
number string Number specified by integrator (must be unique) Yes
verification string "verified", "unavailable" or "rejected" Yes
recurring Recurring Yes

The card field is defined as Card except csc is optional and if it is set, is only allowed to be set to the string "present".

# PostAuthorization

Property Type Optional
merchant Merchant
amount number
authorization See definition below
descriptor string Yes
now Date

authorization field:

Property Type Description Optional
amount number
currency Currency
card Card
created DateTime
number string Number specified by integrator (must be unique) Yes
captured See definition below Yes
refunded See definition below Yes
voided DateTime Yes
recurring string "initial" or "subsequent" Yes

captured field:

Property Type Optional
amount number
latest DateTime
auto true Yes

refunded field (all fields are required):

Property Type
amount number
latest DateTime

# Authorization

This Authorization type is a State used for frontend and is not to be confused with the other Authorization type, which is stored in the Database.

Property Type Description
merchant Merchant or {id: string} id is Intergiro's internal generated unique identifier
authorization See definition below

authorization field:

Property Type Description Optional
id string Intergiro's internal generated unique ID number
number string Number specified by integrator (must be unique)
reference string Scheme dependent external reference number
amount number
currency Currency
card Card
descriptor string Yes
recurring Recurring Yes
verification string "verified", "unavailable" or "rejected" Yes
history History[]
change Change[] Yes
captured See definition below
refunded See definition below
settled See definition below
voided DateTime Yes
status Status[]
created DateTime
category string "purchase" | "withdrawal"

captured field:

Property Type Optional
history Capture[];
amount number
latest DateTime Yes
auto true Yes

refunded field:

Property Type Optional
history Refund[]
amount number
latest DateTime Yes

settled field:

Property Type Optional
history Settlement.Transaction[]
gross number
fee number
net number
latest DateTime Yes

# FailedAuthorization

Property Type Description
merchant Merchant or {id: string} id is Intergiro's internal generated unique identifier
authorization See definition below

authorization field:

Property Type Description Optional
id string Intergiro's internal generated unique ID number Yes
number string Number specified by integrator (must be unique)
amount number Yes
currency Currency Yes
card Card Yes
capture "auto" Yes
descriptor string Yes
recurring Recurring Yes
verification string "verified", "unavailable" or "rejected" Yes
status "failed"[] array containing only the word "failed"
history History[]
reason string
created DateTime

# Card

The Card State has the same definition as Card except expires is set to a Date instead of [number, number].

# State Merchant

All fields are required.

Property Type Description
id string Intergiro's internal generated unique ID number
descriptor string
country Alpha2
name string
currency Currency
scheme Scheme
refundable number
captured number
settled number
fees number