Order Card Scenarios

Private Base Cards

OrderCard Base Private [1.3]

Base Private Card with New Client and New Agreement

Parameters:

 "externalId": "",

// optional parameter

"privateClient": {

// mandatory block for New Base Card

"id": "",

// should be absent

(in order to create new Client)

"name": "",

"surname": "",

"mobilePhone": "",

// mandatory parameters

},

"card": {

// mandatory block

"productCode": "",

// mandatory parameter

"cardAccount": "",

// Can be absent

(in order to create new "card.cardAccount")

// Can be filled with own value

(in order to create new "card.cardAccount" with own id)

"currencies": [""],

// mandatory parameter

"holder": { },

parameters will be ignored

(holder is a Private Client)

"deliveryAddress": { },

// mandatory block

(will be used in Client Agreement)

"supplementary": "false",

// FALSE is mandatory for BASE card

Example:

    "privateClient": {

        "name": "{{name}}",

        "surname": "{{surname}}",

        "mobilePhone": "{{mobilePhone}}",

    },

    "card": {

        "productCode": "{{productCode}}",

        "currencies": ["EUR"],

        "deliveryAddress": {

            "country": "{{country}}",

            "city": "{{city}}",

            "street": "{{street}}",

        },

        "supplementary": "false",

    },

Validations:

- CardOrder will be rejected if provided "card.productCode" is not registered;

- CardOrder will be rejected if "privateClient.name" OR "privateClient.surname" is not provided;

OrderCard Base Private [1.3]

Attached Private Card with New Agreement

Parameters:

 "externalId": "",

// optional parameter

"privateClient": {

// mandatory block for New Base Card

"id": "",

// mandatory parameter, existing ID

(in order to use existing Client data)

Other parameters will be ignored

},

"card": {

// mandatory block

"productCode": "",

// mandatory parameter

"cardAccount": "",

// Can be absent

(in order to create new "card.cardAccount")

// Can be filled with own value

(in order to create new "card.cardAccount" with own id)

"currencies": [""],

// mandatory parameter

"holder": { },

parameters will be ignored

(holder is a Private Client)

"deliveryAddress": { },

// mandatory block

(will be used in Client Agreement)

"supplementary": "false",

// FALSE is mandatory for BASE card

Example:

    "privateClient": {

        "id": "{{id}}",

    },

    "card": {

        "productCode": "{{productCode}}",

        "currencies": ["EUR"],

        "deliveryAddress": {

            "country": "{{country}}",

            "city": "{{city}}",

            "street": "{{street}}",

        },

        "supplementary": "false",

    },

Validations:

- CardOrder will be rejected if provided "privateClient.id" not found;

- CardOrder will be rejected if "privateClient.id" is not provided;

OrderCard Base Private [1.3]

Attached Private Card with Existing Agreement

Parameters:

 "externalId": "",

// optional parameter

"privateClient": {

// mandatory block for New Base Card

"id": "",

// mandatory parameter, existing ID

(in order to use existing Client data)

Other parameters will be ignored

},

"card": {

// mandatory block

"productCode": "",

// mandatory parameter

"cardAccount": "",

// mandatory parameter, existing Account

(in order to use existing Client Account)

"currencies": [""],

// mandatory parameter

"holder": { },

parameters will be ignored

(holder is a Private Client)

"deliveryAddress": { },

// parameters will be ignored

"supplementary": "false",

// FALSE is mandatory for BASE card

Example:

    "privateClient": {

        "id": "{{id}}",

    },

    "card": {

        "productCode": "{{productCode}}",

        "cardAccount": "{{cardAccount}}"

        "currencies": ["EUR"],

        "supplementary": "false",

    },

Validations:

- CardOrder will be rejected if provided "privateClient.id" not found;

- CardOrder will be rejected if "privateClient.id" is not provided;

- CardOrder will be rejected if provided "card.productCode" does not match the details of the existing agreement;

- CardOrder will be rejected if provided "card.currency" does not match the details of the existing "card.cardAccount";

Private Supplementary Cards

OrderCard Supplementary Private [1.3]

Supplementary Private Card with new Client

Parameters:

 "externalId": "",

// optional parameter

"privateClient": {

// mandatory block for New Base Card

"id": "",

// mandatory parameter, existing ID

(in order to use existing Client data)

Other parameters will be ignored

},

"card": {

// mandatory block

"productCode": "",

// mandatory parameter

"cardAccount": "",

// mandatory parameter, existing Account

(in order to use existing Client Account)

"currencies": [""],

// mandatory parameter

"holder": {

// mandatory block should contain Client data

(holder as Supplementary Card owner)

"name": "",

"surname": "",

"mobilePhone": "",

// mandatory parameters

},

"deliveryAddress": { },

// parameters will be ignored

"supplementary": "true",

// True is mandatory for Supplementary card

Example:

    "privateClient": {

        "id": "{{id}}",

    },

    "card": {

        "productCode": "{{productCode}}",

        "cardAccount": "{{cardAccount}}"

        "currencies": ["EUR"],

        "holder": {

            "name": "{{name}}",

                "surname": "{{surname}}",

                "mobilePhone": "{{mobilePhone}}",

        },

        "supplementary": "true",

    },

Validations:

- CardOrder will be rejected if "privateClient.id" is not provided;

- CardOrder will be rejected if provided "privateClient.id" or "card.cardAccount" could not be found;

- CardOrder will be rejected if provided "card.cardAccount" do not match requested "privateClient.id";

- CardOrder will be rejected If provided "card.productCode" does not match the product of the found agreement;

- CardOrder will be rejected if provided "card.currency" does not match the details of the existing card account;

OrderCard Supplementary Private [1.3]

Supplementary Private Card with existing Client

Parameters:

 "externalId": "",

// optional parameter

"privateClient": {

// mandatory block for New Base Card

"id": "",

// mandatory parameter, existing ID

(in order to use existing Client data)

("privateClient.id" should be used from initial client, base Card owner)

Other parameters will be ignored

},

"card": {

// mandatory block

"productCode": "",

// mandatory parameter

"cardAccount": "",

// mandatory parameter, existing Account

(in order to use existing Client Account)

(Account.id should be used from initial client, base Card owner)

"currencies": [""],

// mandatory parameter

"holder": {

// mandatory block should contain Client data

"id": "",

// mandatory parameter, existing 2nd Client.

(in order to use existing Client data)

(holder.id should be used from another client, planned to be used as Supplementary Card owner)

},

"deliveryAddress": { },

// parameters will be ignored

"supplementary": "true",

// True is mandatory for Supplementary card

Example:

    "privateClient": {

        "id": "{{id}}",

    },

    "card": {

        "productCode": "{{productCode}}",

        "cardAccount": "{{cardAccount}}"

        "currencies": ["EUR"],

        "holder": {

            "id": "{{id}}",

        },

        "supplementary": "true",

    },

Validations:

- CardOrder will be rejected if "privateClient.id" is not provided;

- CardOrder will be rejected if provided "privateClient.id" or "card.cardAccount" could not be found;

- CardOrder will be rejected If provided "card.productCode" does not match the product of the found agreement;

- CardOrder will be rejected if provided "card.currency" does not match the details of the existing "card.cardAccount";

- CardOrder will be rejected if provided "card.cardAccount" do not match requested "privateClient.id";

Business Base Cards

OrderCard Base Business [1.3]

Base Business Card with New Client and New Agreement

Parameters:

 "externalId": "",

// optional parameter

"businessClient": {

// mandatory block for Business Card

(Company data)

"registrationNumber": ""

// mandatory parameter

},

"card": {

// mandatory block

"productCode": "",

// mandatory parameter

"cardAccount": "",

// Can be absent

(in order to create new "card.cardAccount")

// Can be filled with own value

(in order to create new "card.cardAccount" with own id)

"currencies": [""],

// mandatory parameter

"holder": {

// mandatory block should contain Client data

(Business Cardholder data)

"name": "",

"surname": "",

"mobilePhone": "",

// mandatory parameters

},

"deliveryAddress": { },

// mandatory block

(will be used in Client Agreement)

"supplementary": "false",

// FALSE is mandatory for BASE card

Example:

    "businessClient": {

        "registrationNumber": "{{registrationNumber}}",

    },

    "card": {

        "productCode": "{{productCode}}",

        "currencies": ["EUR"],

        "holder": {

            "name": "{{name}}",

                "surname": "{{surname}}",

                "mobilePhone": "{{mobilePhone}}",

        },

        "deliveryAddress": {

            "country": "{{country}}",

            "city": "{{city}}",

            "street": "{{street}}",

        },

        "supplementary": "false",

    },

Validations:

- CardOrder will be rejected if "businessClient.registrationNumber" is not provided in order;

- CardOrder will be rejected if provided "card.productCode" is not registered;

OrderCard Base Business [1.3]

Additional Business Card with New Client and New Agreement

Parameters:

 "externalId": "",

// optional parameter

"businessClient": {

// mandatory block for Business Card

"registrationNumber": ""

// mandatory parameter, existing RegNum

(in order to create Business Card within the same Company)

// other parameters should match if used

},

"card": {

// mandatory block

"productCode": "",

// mandatory parameter

"cardAccount": "",

// Can be absent

(in order to create new "card.cardAccount")

// Can be filled with own value

(in order to create new "card.cardAccount" with own id)

"currencies": [""],

// mandatory parameter

"holder": {

// mandatory block should contain Client data

(Business Cardholder data)

"name": "",

"surname": "",

"mobilePhone": "",

// mandatory parameters

},

"deliveryAddress": { },

// mandatory block

(will be used in Client Agreement)

"supplementary": "false",

// FALSE is mandatory for BASE card

Example:

    "businessClient": {

        "registrationNumber": "{{registrationNumber}}",

    },

    "card": {

        "productCode": "{{productCode}}",

        "currencies": ["EUR"],

        "holder": {

            "name": "{{name}}",

                "surname": "{{surname}}",

                "mobilePhone": "{{mobilePhone}}",

        },

        "deliveryAddress": {

            "country": "{{country}}",

            "city": "{{city}}",

            "street": "{{street}}",

        },

        "supplementary": "false",

    },

Validations:

- CardOrder will be rejected if "businessClient.registrationNumber" is not provided in order;

- CardOrder will be rejected if provided "card.productCode" is not registered;

- CardOrder will be rejected if provided business client details do not match existing business client;

OrderCard Base Business [1.3]

Attached Business Card with New Agreement (existing business client and existing cardholder)

Parameters:

 "externalId": "",

// optional parameter

"businessClient": {

// mandatory block for Business Card

"registrationNumber": ""

// mandatory parameter, existing RegNum

(in order to create Business Card within the same Company)

// Other parameters will be ignored

},

"card": {

// mandatory block

"productCode": "",

// mandatory parameter

"cardAccount": "",

// Can be absent

(in order to create new "card.cardAccount")

// Can be filled with own value

(in order to create new "card.cardAccount" with own id)

"currencies": [""],

// mandatory parameter

"holder": {

// mandatory block should contain Client data

"id": "",

// mandatory parameter, existing Client ID

(in order to use existing Business Cardholder data)

// Other parameters will be ignored

},

"deliveryAddress": { },

// mandatory block

(will be used in Client Agreement)

"supplementary": "false",

// FALSE is mandatory for BASE card

Example:

    "businessClient": {

        "registrationNumber": "{{registrationNumber}}",

    },

    "card": {

        "productCode": "{{productCode}}",

        "currencies": ["EUR"],

        "holder": {

            "id": "{{id}}",

        },

        "deliveryAddress": {

            "country": "{{country}}",

            "city": "{{city}}",

            "street": "{{street}}",

        },

        "supplementary": "false",

    },

Validations:

- CardOrder will be rejected if provided "businessClient.registrationNumber" not found;

- CardOrder will be rejected if provided "card.holder.id" not found;

- CardOrder will be rejected if "businessClient.registrationNumber" is not provided in order;

- CardOrder will be rejected if provided "card.productCode" is not registered;

- CardOrder will be rejected if provided registration number does not match the registration number of original Business Client;

OrderCard Base Business [1.3]

Attached Business Card with existing Agreement (existing business client and existing cardholder)

Parameters:

 "externalId": "",

// optional parameter

"businessClient": {

// mandatory block for Business Card

"registrationNumber": ""

// mandatory parameter, existing RegNum

(in order to create Business Card within the same Company)

// Other parameters will be ignored

},

"card": {

// mandatory block

"productCode": "",

// mandatory parameter

"cardAccount": "",

// mandatory parameter, existing Account

(in order to use existing Client Account)

"currencies": [""],

// mandatory parameter

"holder": {

// mandatory block  should contain Client data

"id": "",

// mandatory parameter, existing Client ID

(in order to use existing Business Cardholder data)

// Other parameters will be ignored

},

"deliveryAddress": { },

// parameters will be ignored

"supplementary": "false",

// FALSE is mandatory for BASE card

Example:

    "businessClient": {

        "registrationNumber": "{{registrationNumber}}",

    },

    "card": {

        "productCode": "{{productCode}}",

        "cardAccount": "{{cardAccount}}",

        "currencies": ["EUR"],

        "holder": {

            "id": "{{id}}",

        },

        "supplementary": "false",

    },

Validations:

- CardOrder will be rejected if provided registration number, "card.holder.id" or CardAccount could not be found;

- CardOrder will be rejected if provided "card.holder.id" does not own the same "businessClient.registrationNumber" as provided in "businessClient" part;

- CardOrder will be rejected if provided "card.productCode" or "card.currency" does not match the product or currency of the found agreement;

Business Supplementary Cards

OrderCard Supplementary Business[1.3]

Supplementary Business Card with new Holder

Parameters:

 "externalId": "",

// optional parameter

"businessClient": {

// mandatory block for Business Card

"registrationNumber": "",

// mandatory parameter, existing ID

(in order to create Business Card within the same Company)

// other parameters should match if used

},

"card": {

// mandatory block

"productCode": "",

// mandatory parameter

"cardAccount": "",

// mandatory parameter, existing Account

(in order to use existing Client Account)

"currencies": [""],

// mandatory parameter

"holder": {

// mandatory block should contain Client data

(Business Cardholder data)

"name": "",

"surname": "",

"mobilePhone": "",

// mandatory parameters

},

"deliveryAddress": { },

// parameters will be ignored

"supplementary": "true",

// True is mandatory for Supplementary card

Example:

   "businessClient": {

        "registrationNumber": "{{registrationNumber}}",

    },

    "card": {

        "productCode": "{{productCode}}",

        "cardAccount": "{{cardAccount}}"

        "currencies": ["EUR"],

        "holder": {

            "name": "{{name}}",

                "surname": "{{surname}}",

                "mobilePhone": "{{mobilePhone}}",

        },

        "supplementary": "true",

    },

Validations:

- CardOrder will be rejected if provided "card.productCode" does not match the product of the found agreement;

- CardOrder will be rejected if provided "card.currency" does not match the details of the existing card account;

- CardOrder will be rejected if provided "businessClient.registrationNumber" or "card.cardAccount" could not be found;

- CardOrder will be rejected if provided "businessClient.registrationNumber" or "card.cardAccount" do not match requested ones;

OrderCard Supplementary Business[1.3]

Supplementary Business Card with existing Holder

Parameters:

 "externalId": "",

// optional parameter

"businessClient": {

// mandatory block for Business Card

"registrationNumber": ""

// mandatory parameter, existing RegNum

(in order to create Business Card within the same Company)

(Reg.num should match initial client, base Business Card owner and Supplementary Client owner)

// Other parameters will be ignored

},

"card": {

// mandatory block

"productCode": "",

// mandatory parameter

"cardAccount": "",

// mandatory parameter, existing Account

(in order to use existing Client Account)

(Account should be used from another client, planned to be used as Supplementary card owner)

"currencies": [""],

// mandatory parameter

"holder": {

// mandatory block should contain Client data

"id": "",

// mandatory parameter, existing Client ID

(in order to use existing Business Cardholder data)

(Holder.id should be used from initial client, base Card owner)

Other parameters will be ignored

},

"deliveryAddress": { },

// parameters will be ignored

"supplementary": "true",

// True is mandatory for Supplementary card

Example:

    "businessClient": {

        "registrationNumber": "{{registrationNumber}}",

    },

    "card": {

        "productCode": "{{productCode}}",

        "cardAccount": "{{cardAccount}}",

        "currencies": ["EUR"],

        "holder": {

            "id": "{{id}}",

        },

        "supplementary": "true",

    },

Validations:

- CardOrder will be rejected provided "businessClient.registrationNumber" does not match the "businessClient.registrationNumber" assigned to the holder;

- CardOrder will be rejected if provided "card.currency" does not match the details of the existing "card.cardAccount";

- CardOrder will be rejected if provided "card.holder.id" or "card.cardAccount" could not be found;

- CardOrder will be rejected if provided "card.cardAccount" do not match requested "card.holder.id";