Enums Models Unions Clients

enrollment 0.0.1-dev

History | Watch
  • Contact: N/A
  • License: N/A

Resources

No resources

Headers

No headers

Imports

No imports

Enums

cardType

Name Value Description
american_express american_express

cartes_bancaires cartes_bancaires

diners_club diners_club

discover discover

maestro maestro

mastercard mastercard

visa visa

Interfaces

No interfaces

Models

address

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
line1 string Yes -

line2 string No -

line3 string No -

city string No -

state string No -

postal string No -

country string Yes -

The ISO 3166-3 country code. Case insensitive. See https://api.flow.io/reference/countries

Example: CAN

addressForm

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
line1 string Yes -

line2 string No -

line3 string No -

city string No -

state string No -

postal string No -

country string Yes -

The ISO 3166-3 country code. Case insensitive. See https://api.flow.io/reference/countries

Example: CAN

bankPayment

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
bic string Yes -

iban string Yes -

mandateId string Yes -

mandateType string Yes -

billingAddress address No -

bankPaymentForm

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
bic string Yes -

iban string Yes -

mandateId string Yes -

mandateType string Yes -

billingAddress addressForm No -

card

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
type cardType Yes -

number string Yes -

Example: 4111-1111-1111-1111
expirationMonth integer Yes -

The month of expiration expressed as a number. 1 = January, 12 = December

Minimum: 1
Maximum: 12
Example: 4
expirationYear integer Yes -

The 4 digit expiration year

Example: 2017
name string Yes -

cardForm

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
type cardType Yes -

number string Yes -

Example: 4111-1111-1111-1111
expirationMonth integer Yes -

The month of expiration expressed as a number. 1 = January, 12 = December

Minimum: 1
Maximum: 12
Example: 4
expirationYear integer Yes -

The 4 digit expiration year

Example: 2017
name string Yes -

cardPayment

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
card card Yes -

billingAddress address No -

cardPaymentForm

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
card cardForm Yes -

billingAddress addressForm No -

expiration

Example Json: Minimal | Full

Interfaces: None

The month and year at which a card expires

Field Type Required? Default Description
month integer Yes -

The month of expiration expressed as a number. 1 = January, 12 = December

Minimum: 1
Maximum: 12
Example: 4
year integer Yes -

The 4 digit expiration year

Example: 2017

Unions

payment

Interfaces: None

  • Type discriminator: discriminator
Type Discriminator Value Example Json Description
cardPayment cardPayment Minimal | Full

bankPayment bankPayment Minimal | Full

Annotations

No annotations