# Reference

# Card Token Creatable

Property	Type	Description	Optional
`pan`	`string`	Card PAN - Primary Account Number. Includes 12-19 characters, no spaces allowed.	No
`expires`	`[number,number]`	`[month, year]` where month is `1` to `12` and year is `0` to `99`	No
`csc`	`string`		Yes
`verification`	`Verification`		Yes
`client`	`{ip?: string}`		Yes

# Card Token

Property	Type	Description	Optional
`scheme`	`Scheme`	Card scheme
`iin`	`string`	First 6 digits of card PAN
`last4`	`string`	Last 4 digits of card PAN
`expires`	`[number,number]`	`[month, year]` where month is `1` to `12` and year is `0` to `99`
`type`	`string`	`"debit"` or `"credit"`	Yes
`csc`	`string`	`"matched"`, `"mismatched"` or`"present"`	Yes

# Client

Property	Type	Description	Optional
`ip`	`"string"`		Yes
`browser`	`Browser`		Yes
`callback`	`"string"`	URL to receive the result from 3DS	Yes

# Customer Creatable

Use this type when creating a Customer. If you do not specify a currency when creating a customer, it will default to "SEK".

Property	Type	Description	Optional
`id`	`string`	Unique 16-letter identifier in our system	Yes
`number`	`string`	Customer number in your system	Yes
`contact`	`Contact`		Yes
`method`	`Payment Method Creatable`[]
`currency`	`Currency`	3-letter currency code, e.g. "SEK"	Yes
`limit`	`number` (in major units)	Credit limit in the specified currency for the customer	Yes
`order`	`Order \| Order[]`	Order or Orders (without the fields payment and customer) to be created simultaneously as the customer	Yes
`subscription`	`Subscription \| Subscription[]`	Subscription or Subscriptions to be created simultaneously as the customer.	Yes

# Customer

Responses from creating or listing customers will contain a Customer object, which includes an "id" and may include a "status", subscriptions and "link" fields in addition to the ones in the Creatable type.

Property	Type	Description	Optional
`id`	`string`	Intergiro customer identifier
`number`	`string`		Yes
`contact`	`Contact`		Yes
`method`	`Payment Method`[]
`link`	`CustomerLink`		Yes
`status`	`string`	`"active"`, `"created"`, `"inactive"`, `"pending"` or `"suspended"`	Yes
`subscription`	`Subscription[]`		Yes
`currency`	`Currency`

# Example Customer

{
    "id": "Uw8hDZb4T-YX17O-",
    "number": "2bQ7p_1sadDddIBB",
    "method": [
        {
            "type": "card",
            "scheme": "visa",
            "iin": "411111",
            "last4": "1111",
            "expires": [2, 22],
            "acquirer": "intergiro",
            "created": "2021-08-17T08:31:07.058Z",
            "token": "<card.token>",
        }
    ],
    "subscription": [],
    "status": "active",
	"total": 0,
	"balance": [],
	"currency": "SEK",
    "contact": {
        "type": "person",
        "name": "John Doe",
        "address": {
            "street": "Storgatan 1",
            "zip_code": "111 23",
            "city": "Stockholm",
            "country_code": "SE"
        },
        "email": "johndoe@example.com",
        "phone": "+46987654321"
    }
}

# Event

# Type

The following are valid types of events: "cancel", "charge", "defer", "order", "refund".

# Creatable

Note

items are in major units (e.g. 4.5 is equivalent to 4.50 EUR).

Property	Type	Description	Optional
`type`	`Event.Type`	The Type of event to be created.
`items`	`number \| Item \| Item[]`	Amounts or items that are referenced by the event, if applicable.	Yes
`descriptor`	`string`	Merchant defined descriptor of the event.	Yes

# Event

Note

items are in major units (e.g. 4.5 is equivalent to 4.50 EUR).

Property	Type	Description	Optional
`type`	`Event.Type`	The Type of the event.
`items`	`number \| Item \| Item[]`	Amounts or items that are referenced by the event, if applicable.	Yes
`reference`	`string`	Reference number of the acquirer.	Yes
`date`	`DateTime`	Time of the event creation.	Yes
`descriptor`	`string`	Merchant defined descriptor of the event.	Yes

# Fail Event

Property	Type	Description	Optional
`type`	`"fail"`
`original`	`Event.Type`	Type of the failed event.
`error`	`Error`	Error that lead to the failed event	Yes

# Order Creatable

Note

items are in major units (e.g. 4.5 is equivalent to 4.50 EUR).

Property	Type	Description	Optional
`id`	`string`	Identifier received from the order-create endpoint.	Yes
`number`	`string`	Order number in your system.	Yes
`customer`	`string \| Contact`	Customer contact information or customer id.	Yes
`items`	`number \| Item \| Item[]`
`currency`	`Currency`
`payment`	For one-off orders with a card use `Card Payment Creatable` For orders with a customer payment method use `Payment Method` For orders with a payment link, use `Defer Payment Creatable`
`category`	`"purchase"` `"topup"` `"tip"`	Defaults to `"purchase"` Purchase - used for all regular e-commerce transactions Topup/Tip - used for Intergiro BaaS transactions	Yes
`theme`	`string`	i.e. "intergiro" or "dark"	Yes
`meta`	`any`	Data used by the merchant.	Yes
`callback`	`string`	URL to receive the callbacks.	Yes
`charge`	`"auto"`	If included, the order will be immediately charged after authorization succeeds. If not included, the order must be manually charged via Merchant Portal or API.	Yes
`sender`	`Contact`	Required for Visa AFT transactions (if order category is `tip` or `topup`). Full name (first and last), address, account number and account type are required.	Yes
`receiver`	`Contact`	Required for Visa AFT transactions (if order category is `tip` or `topup`). Full name (first and last), address, account number and account type are required.	Yes
`wallet`	`Wallet`		Yes

# Example

{
    "number": "aaa-001",
    "item": [
        {
            "name": "t-shirt",
            "price": 42.00,
            "quantity": 2
        },
        {
            "name": "trousers",
            "price": 100.00,
            "quantity": 1,
            "unit": "st",
            "vat": 25.00
        }
    ],
    "currency": "SEK",
    "payment": {
        "type": "card",
        "card": "tokenized.card.information"
    }
}

# Order

Note

items are in major units (e.g. 4.5 is equivalent to 4.50 EUR).

Property	Type	Description	Optional
`id`	`string`	Identifier in our system.
`number`	`string`	Order number in your system.	Yes
`created`	`DateTime`	Date and the time of the order.
`customer`	`string \| Contact`	customer id. or Customer contact information	Yes
`items`	`number \| Item \| Item[]`
`currency`	`Currency`
`payment`	`Card Payment`	see Payment data type
`event`	`Event[]`	see Event data type	Yes
`category`	`"purchase"`, `"withdrawal"`, `"topup"` or `"tip"`	Defaults to "purchase".	Yes
`theme`	`string`	i.e. "intergiro" or "dark"	Yes
`meta`	`any`	Data used by the merchant.	Yes
`callback`	`string`	URL to receive the callbacks.	Yes
`language`	`string`	Two character language code, i.e. sv for swedish	Yes
`wallet`	`Wallet`		Yes

# Example

{
    "id": "BlTmF3S382kFbn5U",
    "number": "aaa-00b",
    "item": {
        "name": "rubber duck",
        "price": 50.00,
        "quantity": 2,
    },
    "currency": "SEK",
    "payment": {
        "type": "card",
        "descriptor": "Text on statement",
        "amount": 100,
        "created": "1970-01-01T12:00:00.001Z",
        "currency": "SEK",
        "expires": [6, 23],
        "iin": "411111",
        "last4": "1111",
        "scheme": "mastercard",
        "status": "created",
        "card": "tokenized.card.information",
        "reference": "abcdefghijklmnop",
        "service": "intergiro"
    },
    "created": "1970-01-01T12:00:00.001Z"
}

# Card Payment Creatable

Property	Type	Description	Optional
`type`	`"card"`
`card`	`JWT`	Contains encrypted card information.
`client`	Client		Yes
`subsequent`	Subsequent		Yes

# Subsequent

Property	Type	Description	Optional
`reference`	`string`	Reference to the saved card.
`initiator`	`"cardholder" \| "merchant"`	Defaults to `merchant`.	Yes

# Card Payment

Property	Type	Description	Optional
`type`	`"card"`
`created`	`DateTime`	Date and the time when the payment was processed.
`card`	`JWT`	Contains encrypted card information.	Yes
`scheme`	`string`	Indicates the card scheme.
`iin`	`string`	First 6 digits on card.
`last4`	`string`	Last 4 digits on card.
`expires`	`[number,number]`	`[month, year]` where month is `1` to `12` and year is `0` to `99`.
`service`	`"intergiro"`
`status`	`string`
`descriptor`	`string`	Text on Statement.	Yes
`reference`	`string`	Reference number of the acquirer.
`schemeReference`	`string`	Reference number of the payment scheme.	Yes

# Payment method creatable

For automatic payment with a customer, a payment method has to be created first. This can be done either with already tokenized cards or through the Registration Process.

Property	Type	Description	Optional
`type`	`"token"`	Indicator for method type	No
`card`	`string`	Card token	No
`client`	`Client`		Yes

# Payment method

Property	Type	Description	Optional
`type`	`string`	`"card"` or `"token"`
`created`	`DateTime`
`token`	`string`	Tokenized payment information
`scheme`	`Scheme`
`iin`	`string`	First 6 digits on card
`last4`	`string`	Last 4 digits on card
`expires`	`[number, number]`	`[month, year]` where month is `1` to `12` and year is `0` to `99`
`acquirer`	`string`	`"intergiro"` or `"clearhaus"`	Yes

# Example:

{
    "type": "card",
    "created": "2020-03-13T13:37:13.123Z",
    "token": "abc.def.ghi",
    "scheme": "visa",
    "iin": "411111",
    "last4": "1111",
    "expires": [ 2, 22 ],
}

# Defer Payment Creatable

Property	Type	Description	Optional
`type`	`"defer"`
`method`	`"link"`
`cardholderName`	`"required"` or `"none"`	Use `"required"` if the cardholder name needs to be added by the customer when making the payment. Defaults to "none".	Yes
`redirectUrl`	`string`	URL to be redirected to after customer completed the payment.	Yes

# CustomerLink

Information associated to single use login links for the customer page.

Property	Type	Optional
`url`	`string`
`created`	`DateTime`
`expires`	`DateTime`
`key`	authly.Token	Yes
`contact`	`string`	Yes

# Example:

{
    "url": "http://localhost:7071/customer/1234567890abcdef/link/0987654321098765",
    "id": "0987654321098765",
    "created": "2020-12-08T09:19:42.835Z",
    "expires": "2020-12-11T09:19:42.835Z",
    "key": "abc.def.ghi",
    "contact": "m.exampleperson@example.net",
    "used": false
}

# Customer Payment

# Customer Payment Creatable

Property	Type	Description	Optional
`type`	`"customer"`

# Token

The Token is a JWT where the body includes a Base64, that in itself encodes a card.Token object. The table below shows the contents of a card.Token:

Property	Type	Description	Optional
`issuer`	`"card"`
`created`	`Date`
`audience`	`string`	`"production"` or `"development"`
`encrypted`	`string`	Encrypted card information
`expires`	`[number,number]`	`[month, year]` where month is `1` to `12` and year is `0` to `99`
`verification`	`Verification`		Yes

# Verification

Property	Type	Description
`type`	`"method" \| "challenge" \| "guard" \| "pares"`
`data`	Verification Data	base64 encoded string or a json object

# Verification Data

Property	Type	Verification type
`threeDSServerTransID`	`string`	`method \| challenge`
`acsTransID`	`string`	`challenge`
`challengeCompletionInd`	`string`	`challenge`
`messageType`	`string`	`challenge`
`transStatus`	`string`	`challenge`

← Card Token API Postman →