payment-management-channels

Endpoint is used to verify the correctness of the receiver's data, designate the payment channel, calculate payment fees and verify whether the transaction amount is within the limit.

Create a GET request

WARNING

Request header with Authorization parameter is obliged for all requests sent to ZEN.COM API. Authorization value is the apiKey parameter which is generated and provided by ZEN.COM to the Client. This key is unique to each Customer and should not be shared or used by third parties.

Create a GET request.

Query parameters

Parameter	Description	Type	Required
`amount`	payment amount	number ($double)	yes
`currency`	currency amount	string (ISO 4217 standard)	yes
`accountNumber`	receiver's account number	string	yes
`bic`	bic	string	no
`routingCode`	routing code	string	no
`routingCodeType`	routing code type	enum `SORT_CODE`	no
`receiverType`	receiver type	enum `INDIVIDUAL` / `BUSINESS`	yes

💡

Example of JSON

Send the request

Send the GET request to:

test environment: https://api-services.zen-test.com/payments/v1.0/precalculation

production environment: https://api-services.zen.com/payments/v1.0/precalculation

Receive the ZEN.COM response

Receive the ZEN.COM response.

Parameters

Parameter	Description	Type	Nullable
`code`	a code indicating whether the data in the service was sent correctly and passed validation	enum `OK` - data correct / `BIC_REQUIRED` - bic code required / `BIC_OR_ROUTING_CODE_REQUIRED` - bic or routingCode required / `NO_CHANNELS_AVAILABLE` - no channels available for the entered data / `CURRENCY_REQUIRED` - required currency / `INVALID_ACCOUNT_NUMBER_EXCEPTION` - account number in iban format required / `INVALID_ACCOUNT_NUMBER` - incorrect account number / `MISSING_BENEFICIARY_DATA` - missing receiver's address	no
`chargeTypesData.fees.amount.value`	payment fee amount	number ($double)	no
`chargeTypesData.fees.amount.currency`	payment fee currency	string (ISO 4217 standard)	no
`chargeTypesData.fees.name`	fee name	enum `STANDARD_FEE` / `ADDITIONAL_FEE`	yes
`chargeTypesData.name`	charge type	enum `SHA` / `OUT` / `LOCAL` / `STANDARD` / `INSTANT`	no
`chargeTypesData.channel`	payment channel	enum `SWIFT` / `SEPA` / `LOCAL`	no
`chargeTypesData.singleTransactionLimit.amountInEurCurrency.value`	limit amount in EUR	number ($double)	yes
`chargeTypesData.singleTransactionLimit.amountInEurCurrency.currency`	currency	string (ISO 4217 standard)	yes
`chargeTypesData.singleTransactionLimit.amountInTransactionCurrency.value`	limit amount in payment currency	number ($double)	yes
`chargeTypesData.singleTransactionLimit.amountInTransactionCurrency.currency`	currency	string (ISO 4217 standard)	yes
`chargeTypesData.singleTransactionLimit.limitExceeded`	information whether the single transaction limit has been exceeded	boolean	yes
`periodicLimit.limitExceeded`	information whether the periodic limit has been exceeded`	boolean	yes
`periodicLimit.remainingAmountInEurCurrency.value`	amount of the remaining periodic limit in EUR	number ($double)	yes
`periodicLimit.remainingAmountInEurCurrency.currency`	currency	string (ISO 4217 standard)	yes
`periodicLimit.remainingAmountInTransactionCurrency.value`	the amount of the remaining periodic limit in the payment currency	number ($double)	yes
`periodicLimit.remainingAmountInTransactionCurrency.currency`	currency	string (ISO 4217 standard)	yes
`periodicLimit.period`	the value in days indicates the period of time for which the limit is granted		yes

💡

Example response

{
   "code":"OK",
   "chargeTypesData":[
      {
         "fees":[
            {
               "amount":{
                  "value":"57.86",
                  "currency":"USD"
               },
               "name":"STANDARD_FEE"
            }
         ],
         "name":"OUR",
         "channel":"SWIFT",
         "singleTransactionLimit":{
            "amountInEurCurrency":{
               "value":"1000.00",
               "currency":"EUR"
            },
            "amountInTransactionCurrency":{
               "value":"1157.11",
               "currency":"USD"
            },
            "limitExceeded":false
         }
      },
      {
         "fees":[
            {
               "amount":{
                  "value":"5.79",
                  "currency":"USD"
               },
               "name":"STANDARD_FEE"
            }
         ],
         "name":"SHA",
         "channel":"SWIFT",
         "singleTransactionLimit":{
            "amountInEurCurrency":{
               "value":"1000.00",
               "currency":"EUR"
            },
            "amountInTransactionCurrency":{
               "value":"1157.11",
               "currency":"USD"
            },
            "limitExceeded":false
         }
      }
   ],
   "periodicLimit":{
      "limitExceeded":false,
      "remainingAmountInEurCurrency":{
         "value":"10000.00",
         "currency":"EUR"
      },
      "remainingAmountInTransactionCurrency":{
         "value":"11571.17",
         "currency":"USD"
      },
      "period":1
   }
}

Errors

HTTP code	Business code	Description
400	`VALIDATION_ERROR`	the data has not been validated
403	`FORBIDDEN`	no access to the resource
404	`ACCOUNT_NOT_FOUND`	no account with the specified accountId was found
500	`INTERNAL_SERVER_ERROR`	server error, please contact ZEN

💡

Example error response

{
   "error":{
      "code":"INTERNAL_SERVER_ERROR",
      "message":"Unexpected error. Contact ZEN"
   }
}

Calculation of available channels, fees and payment limits