get-conversion-rate-classes-CLASS_ID.rst (1772B)
1 .. http:get:: /conversion-rate-classes/{CLASS_ID} 2 3 Get an existing conversion rate class. 4 5 Only available to the administrator. 6 7 Since protocol **v9**. 8 9 **Response:** 10 11 :http:statuscode:`200 OK`: 12 Response is a `ConversionRateClass`. 13 :http:statuscode:`401 Unauthorized`: 14 Invalid or missing credentials. 15 :http:statuscode:`403 Forbidden`: 16 Missing rights. 17 :http:statuscode:`404 Not Found`: 18 The conversion rate class was not found. 19 :http:statuscode:`501 Not implemented`: 20 This server does not support conversion, client should check config response. 21 22 **Details:** 23 24 .. ts:def:: ConversionRateClassResponse 25 26 interface ConversionRateClass { 27 // The name of this class 28 name: string; 29 30 // A description of the class 31 description?: string; 32 33 // Class unique ID 34 conversion_rate_class_id: Integer; 35 36 // Number of users affected to this class 37 num_users: Integer; 38 39 // Minimum fiat amount authorised for cashin before conversion 40 cashin_min_amount?: Amount; 41 42 // Exchange rate to buy regional currency from fiat 43 cashin_ratio?: DecimalNumber; 44 45 // Regional amount fee to subtract after applying the cashin ratio. 46 cashin_fee?: Amount; 47 48 // Rounding mode used during cashin conversion 49 cashin_rounding_mode?: "zero" | "up" | "nearest"; 50 51 // Minimum regional amount authorised for cashout before conversion 52 cashout_min_amount?: Amount; 53 54 // Exchange rate to sell regional currency for fiat 55 cashout_ratio?: DecimalNumber; 56 57 // Fiat amount fee to subtract after applying the cashout ratio. 58 cashout_fee?: Amount; 59 60 // Rounding mode used during cashout conversion 61 cashout_rounding_mode?: "zero" | "up" | "nearest"; 62 }