Implementation Notes
The method which calculates price offer
Factoring Price Offer Calculator
Service Description
Garanti BBVA Factoring Price Offer Calculator API helps you give an online price offer to customers for cheques.
|
API Profile |
|
|---|---|
|
Attribute |
Value |
| Name | Factoring Price Offer Calculator |
| Version | V1 |
| Synopsis | Factoring Price Offer Calculator API |
| Description | Online price offer for cheques |
| Pre-Conditions | HTTP POST method is allowed only in Factoring Price Offer Calculator API |
| Authentication | API Key or OAuth 2.0 with Client Credentials |
Before your application can access the API, it must obtain a new an access token for each request. The access token can be used only one time.
Endpoint Definition
Factoring Price Offer Calculator API’s development live and mock environments routing data
|
EndPoint / DEVELOPMENT SANDBOX SERVICE |
|
|---|---|
| URI | /factoringservices/v1/priceoffercalc |
| Base URL | https://apis.garantibbva.com.tr:443 |
Technology
|
Technology Stack / DESIGN TIME |
|
|---|---|
| Property | Value |
| HTTP Call Method | POST |
| Response Content Type | application/json; charset=utf-8 |
Request
HTTP POST method is allowed only in Factoring Price Offer Calculator API.
https://apis.garantibbva.com.tr:443/factoringservices/v1/priceoffercalc
Arguments
The list of arguments by the Factoring Price Offer service to be invoked
| Request Fields | Type | Description | Obligation |
|---|---|---|---|
| currencyCode | String | The currency code of the cheque | Mandatory |
| amount | Number | The amount of the cheque | Mandatory |
| dueDate | Number |
The due date of the cheque Format: YYYYMMDD YYYY:Year, MM:Month, DD:Day |
Mandatory |
| chequeBankCode | Number | The bank code of the cheque | Mandatory |
Sample request
{
"currencyCode": "TL",
"amount": 70000,
"dueDate": 20201210,
"chqBankCode": 62
}
Response
The Factoring Price Offer Calculator API is return the price offer details according to request parameters
Arguments
The list of response parameters
|
Response Fields |
Type |
Description |
|---|---|---|
| currencyCode | String | It is the currency code of the price offer |
| totalSecAmount | Number | It is the total assignment amount of price offer |
| netPaymentAmount | Number | It is the net payment amount of price offer |
| factPriceAmount | Number | It is the factoring price amount of price offer |
| totalExpenseAmount |
Number |
It is the total expense amount of price offer |
| bittAmount | Number | It is the bitt amount of price offer |
| resultCode | String | It is the result code of the request |
| resultMessage | String | It is the result message of the request |
Sample response
{
"result": {
"code": 200,
"info": "OK"
},
"response": {
"currencyCode": "TL",
"totalSecAmount": 70000,
"netPaymentAmount": 69317.85,
"factPriceAmount": 530.67,
"totalExpenseAmount": 119,
"bittAmount": 32.48,
"resultCode": "WS-11",
"resultMessage": "İşlem tamamlandı."
}
}
Return Codes & Error Handling
Response codes from The Factoring Price Offer Calculator service request
|
Code |
Description |
Type |
|---|---|---|
| 200 | OK | SUCCESS |
| 405 | {http.method} Method Not Allowed | CALL METHOD ERROR |
| 400 | Invalid Request | MISSING PARAMETERS |
| 401 | Invalid Credentials | UNAUTHORIZED |
| 429 | API plan limit exceeded | RATE LIMITING |
| 500 | Internal Server Error | SYSTEM ERROR |
Return Messages
|
CODE |
RETURN RESPONSE |
|---|---|
| 401 |
{
"result": {
"code": 401,
"info": "Invalid Credentials"
}
}
|
| 405 |
{
"result": {
"code": 405,
"info": "GET Method Not Allowed"
}
}
|
| 400 |
{
"result": {
"code": 400,
"info": "Invalid Request"
}
}
|
| 429 |
{
"result": {
"code": 429,
"info": "API plan limit exceeded"
}
}
|
| 500 |
{
"result": {
"code": 500,
"info": "Internal Server Error"
}
}
|
-
API URL : https://apis.garantibbva.com.tr
-
-
-