Reference
Authorization
Creatable
Authorization Creatable
Property | Type | Description | Optional |
number | string | has to be a unique identifier | |
amount | number | | Yes |
items | number | Item | Item[] | | Yes |
currency | Currency | | |
card | Signed JWT or Card.Creatable | | |
descriptor | string | | Yes |
capture | "auto" | | Yes |
recurring | Recurring | | Yes |
category | "purchase" | "withdrawal" | | Yes |
browser | Browser | | Yes |
contact | Contact | | Yes |
target | string | verification target url | Yes |
Authorization
Property | Type | Description | Optional |
id | string | Intergiro's internal generated unique ID number | |
merchant | string | Intergiro's internal generated unique ID number | |
number | string | Number specified by integrator (must be unique) | |
reference | string | Scheme dependent external reference number | |
created | DateTime | | |
amount | number | | |
currency | Currency | | |
card | Card | | |
descriptor | string | | Yes |
recurring | Recurring | | Yes |
history | History[] | | |
change | Change[] | | Yes |
capture | Capture[] | | |
refund | Refund[] | | |
void | DateTime | | Yes |
status | Partial<Record<Status, number>> | | |
category | "purchase" | "withdrawal" | | Yes |
fraudio | Fraudio | Risk evaluation object. | Yes |
processor | Processor | Information about the processor response. | Yes |
Status
Authorization.Status is string set to "authorized"
, "cancelled"
, "captured"
, "refunded"
or "settled"
.
Recurring
Recurring can be defined in four ways:
- As the string
"initial"
- As an Initial recurring:
{ type: "initial"; initiator: "cardholder"}
- As a Subsequent recurring:
{ type: "subsequent"; reference: string; scheduled?: false; initiator: "merchant" | "cardholder"}
- As a Scheduled recurring:
{ type: "subsequent"; reference: string; scheduled: true; initiator: "merchant" }
Change
Creatable
Property | Type | Optional |
number | string | Yes |
amount | number | Yes |
Change
Property | Type | Description | Optional |
number | string | | Yes |
created | DateTime | | |
amount | number | | |
Capture
Creatable
Property | Type | Optional |
number | string | Yes |
amount | number | Yes |
auto | true | Yes |
descriptor | number | Yes |
Capture
Property | Type | Description | Optional |
number | string | | Yes |
created | DateTime | | |
reference | string | | Yes |
approved | DateTime | | Yes |
amount | number | | |
auto | true | | Yes |
settlement | Settlement.Transaction | | Yes |
descriptor | string | | Yes |
status | string | "approved" , "pending" or "settled" | |
Refund
Creatable
Property | Type | Optional |
number | string | Yes |
amount | number | Yes |
descriptor | number | Yes |
Refund
Property | Type | Description | Optional |
number | string | | Yes |
created | DateTime | | |
reference | string | | |
approved | DateTime | | Yes |
amount | number | | |
descriptor | string | | Yes |
settlement | Settlement.Transaction | | Yes |
status | string | "approved" , "pending" or "settled" | |
History
History can be of type Create, Capture, Refund, Settlement, Verification or Void. Each type extends type Base.
Base
Property | Type | Description | Optional |
merchant | string | | |
number | string | | |
date | DateTime | | |
type | "create" | "capture" | "refund" | "settlement" | "verification" | "void" | | |
status | "fail" | "success" | "pending" | | |
fraudio | Fraudio | Risk evaluation object. | Yes |
Create
History.Create is of type Fail, Success or Pending.
Fail
Property | Type | Description | Optional |
type | "create" | | |
status | "fail" | | |
amount | number | | Yes |
currency | Currency | | Yes |
card | Card | | Yes |
descriptor | string | | Yes |
recurring | Recurring | | Yes |
verification | "verified" | "rejected" | "unavailable" | | Yes |
rule | string[] | | Yes |
reason | Error Code | | |
error | Error | | |
Success
Property | Type | Description | Optional |
type | "create" | | |
status | "success" | | |
verification | "verified" | "rejected" | "unavailable" | | Yes |
Pending
Property | Type | Description | Optional |
type | "create" | | |
status | "pending" | | |
amount | number | | Yes |
currency | Currency | | Yes |
card | Card | | Yes |
descriptor | string | | Yes |
recurring | Recurring | | Yes |
rule | string[] | | |
reason | "verification required" | | |
Capture and Refund
History.Capture and History.Refund are of type Fail or Success.
Fail
Property | Type | Description | Optional |
type | "capture" | "refund" | | |
status | "fail" | | |
amount | number | | |
currency | Currency | | |
reason | Error Code | | |
error | Error | | |
Success
Property | Type | Description | Optional |
type | "capture" | "refund" | | |
status | "fail" | | |
amount | number | | |
currency | Currency | | |
reference | string | | |
Settlement
Property | Type | Description | Optional |
type | "settlement" | | |
status | "success" | | |
operation | string | | |
reference | string | | |
payout | Date | | |
Verification
History.Verification is of type Fail, Success or Pending.
Fail
Success
Pending
Void
History.Void
is of type Fail or Success.
Fail
Property | Type | Description | Optional |
type | "verification" | | |
status | "fail" | | |
reason | Error Code | | |
error | Error | | |
Success
Property | Type | Description | Optional |
type | "verification" | | |
status | "success" | | |
Fraudio
The Fraudio
type is for risk evalution.
Property | Type | Description | Optional |
score | number | Value between 0 and 1. The higher the score the higher the risk. | |
recommendation | "green" | "yellow" | "red" | Fraudio's recommendation. | |
id | string | | |
threshold | number | Value between 0 and 1. | Yes |
model | string | | Yes |
notes | string | | Yes |
transaction | string | | Yes |
Processor
The Processor
contains information given by the processor.
Property | Type | Description | Optional |
name | string | | |
mid | string | | |
entry | "e-commerce" | string | | |
reference | Reference | | |
response | Response | | |
code | string | | |
eci | string | | Yes |
Response
Property | Type | Description | Optional |
code | string | | |
csc | string | | |
description | string | | |
Reference
Property | Type | Description | Optional |
transaction | string | | |
retrieval | string | | |
scheme | string | | |