Release Version 4.14.0 (November 22, 2023)

API Changes

Endpoint

Updated

POST ​/transactoins​/view

New node commissionAmounts for commission amounts was added to the response body:

commissionAmounts.source - an amount that was charged from an source account (wallet), which means OUT or SHARED direction for Commissions in Contract

commissionAmounts.destination- an amount that was charged from the destination account (wallet), which means IN or SHARED direction for Commissions in Contract

Operation can have only one (.source or .destination) set of commissions or have both (.source and .destination), in case of SHARED direction was set in the Contract for this type of operation.

Both, commissionAmounts.source and commissionAmounts.destination can have three types of amount, depends on Operation Type (internal, external) and Commission Direction (IN, OUT, SHERED):

·         total - total amount of the commission that was charged from the user`s wallet (for external operation total=system+provider, for internal operation total=system)

·         system - amount of the commission that was charged by the system (for internal operation total=system)

·         provider - amount of the commission that was charged by the provider (present only for external operation)

{ "internalSourceAmount": 0, (was added in 4.12)  "internalDestinationAmount": 0, (was added in 4.12)  "externalSourceAmount": 0, (was added in 4.12)  "externalDestinationAmount": 0, (was added in 4.12)  "commissionAmount": 20.22 .....,  "commissionAmounts": {    "source" : {      "total": 20.22,      "system": 11.22,      "provider": 9.00  (only for gate oprerations)     },    "destination" : {      "total": 20.15,      "system": 11.15,      "provider": 9.00  (only for gate oprerations)    }  },  .....}

New field commissionAmount was added to the response body.

commissionAmount - the total commission amount, that was charged for operation processing

In all API requests and responses that contains issuerId, sourceIssuer, destinationIssuer, issuer

Due to changes implemented in Release 4.11.0 where Issuer and Currency entities were combined into one (in order to facilitate the work of the business) in release 4.14.0 issuer definition was replaced by the currency definition in the code and in the API. In API all issuer-related fields were replaced by currncy-related.

1.      Filed issuerId was replaced by currencyId

2. Node issuer:

"issuer": {        "id": "string",        "sn": "string",        "currency": "string",        "symbol": "string"

was replaced by node currency:

"currency": {        "id": "string",        "sn": "string",        "code": "string",        "symbol": "string"

field currency.code in currency node has the same meaning as it was issuer.currency in the issuer node: code of the currency, can be any code specified by user or ISO currency code for fiat currency

3.      Fields sourceIssuer and destinationIssuer ware replaced by sourceCurrency and destinationCurrency accordingly.

After the release 4.14.0 is applied, only new names (currency insted issuer) will be supported in all API endpoints.

PATCH /profiles/my/person

PATCH /profiles/{userId}/person

user profile data was extended by field gender.

The set of gender type is possible to setup in the configuration file.

bootstrap:  core:    system:      user-profile:        genders:          - male          - female          - lesbian          - gay          - bisexual          - transgender

request body:

{  "person": {   ....    "gender": "male"  }}

response body:

response body:{    "profile": {        "person": {          ...            "gender": "male"          ...        }    ]}

POST ​/v1​/users​/note

format for the field note was adjusted in the request and response to support value in JSON format

Endpoint

Added

POST /i18n

additional API endpoint for creating and updating separate international properties was added for technical use only (off the Swagger)

{  "key": "",  "values": [    {      "locale": "en",      "value": ""    },    {      "locale": "uk",      "value": ""    },    {      "locale": "ru",      "value": ""    }  ]}

POST /role-groups-is-able-to-create

added new API endpoint to view in the API which roles groups are allowed to be created with the user by provided role groups.

Permission USER_MANAGER is required

request body:

{    "roles": [        "administrator",        "compliance_specialist",        "cfo",        "customer_support",        "merchant",        "individual"    ]}

response body:

{    "records": [        {            "role": "individual",            "isSelfRegistrationAllowed": true,            "creationMethods": [                "CREATE_NEW_ORGANIZATION"            ],            "hasUserManagerPermission": true,            "isAbleToCreateRoles": [                "individual"            ]        },        {            "role": "merchant",            "isSelfRegistrationAllowed": true,            "creationMethods": [                "CREATE_NEW_ORGANIZATION"            ],            "hasUserManagerPermission": false,            "isAbleToCreateRoles": [                "merchant"            ]        },        {            "role": "customer_support",            "isSelfRegistrationAllowed": false,            "creationMethods": [                "ATTACH_MULTIPLE"            ],            "hasUserManagerPermission": false,            "isAbleToCreateRoles": []        },        {            "role": "cfo",            "isSelfRegistrationAllowed": false,            "creationMethods": [                "ATTACH_SINGLE"            ],            "hasUserManagerPermission": true,            "isAbleToCreateRoles": [                "administrator",                "financial_specialist",                "individual",                "cfo"            ]        },        {            "role": "compliance_specialist",            "isSelfRegistrationAllowed": false,            "creationMethods": [                "ATTACH_MULTIPLE"            ],            "hasUserManagerPermission": false,            "isAbleToCreateRoles": []        },        {            "role": "administrator",            "isSelfRegistrationAllowed": false,            "creationMethods": [                "ATTACH_SINGLE"            ],            "hasUserManagerPermission": true,            "isAbleToCreateRoles": [                "administrator",                "individual",                "financial_specialist"            ]        }    ]}

PATCH ​/v1​/contracts​/{contractId}

added API to change the contract name or to activate/deactivate the contract

contractId Internal contract identifier

request body:

{  "name": "New contract name",  "active": true}

response body:

{  "id": "string",  "organizationType": "individual",  "personType": "standart",  "name": "string",  "description": "string",  "active": true,  "global": true}

PATCH /profiles/{userId}

added API to update organization status (user identification status)

All documents should be approved to update to review_required or approved Organization status.

userId User Internal Identifier. UserId is returned in the API response for user registration POST /users or can be taken from the API POST /users/view.
available values for status parameter: pending|review_required|approved|declined

Permission required: ORGANIZATION_STATUS_MANAGER

request body:

{    "status": "review_required"}

response body:

{    "profile": {        "person": {            "namePlain": {                "first": "John",                "last": "Golt",                "middle": "string"            },            "nameIntl": {                "first": "John",                "last": "Golt",                "middle": "string"            },            "description": "SDK.finance engineer"        },        "contact": {            "phoneVerified": false,            "email": "sdk_stage_open_api_test_marqeta_artem_0003@mailinator.com",            "emailVerified": true        },        "type": "base",        "status": "review_required",        "business": {},        "address": {            "country": "UA",            "zipCode": "04209",            "city": "Kyiv",            "street": "Heroiv Dnipra",            "houseNumber": "25"        },        "additional": {            "type": "common",            "sex": "MALE",            "paidInvoicesAmount": 0.0000        },        "security": {            "twoFactorsAuthEnabled": false,            "transactionNotification": {                "phone": false,                "email": false            },            "authorizationNotification": {                "phone": false,                "email": false            }        }    }}

POST /profiles/{userId}

added new API endpoint to send user profile data for verification to third party KYC service provider

userId User Internal Identifier. UserId is returned in the API response for user registration POST /users or can be taken from the API POST /users/view.

Permission required: ORGANIZATION_STATUS_MANAGER

Endpoint

Deprecated/Deleted

POST /cash-desks/report-turnover
PATCH /coins/{serial}/credit-limit
GET /management/filter-templates
POST /management/filter-templates
PUT /management/filter-templates/{filterTemplateId}
DELETE /management/filter-templates/{filterTemplateId}
GET /notification/message/keys
POST /gate/transactions/payment-points

deprecated endpoints was removed