Account Payment Refund Payment
Service Description
RefundPayment Service is used to return the payment amount which was collected for the order.
This API is in the cash management category
API Profile |
|
---|---|
Attribute |
Value |
Name | Refund Payment |
Version | V1 |
Synopsis | Refund Payment Service |
Description | Creates UID which represents order information |
Pre-Conditions | HTTP POST method is allowed only in Status Inquiry service. |
Authentication | OAuth 2.0 with Client Credentials |
Before your application can access the API, it must obtain a new access token for each request. The access token can be used only one time.
Endpoint Definition
Refund Payment API’s development live and mock environments routing data.
EndPoint / DEVELOPMENT SANDBOX SERVICE |
|
---|---|
URI | /cashmanagement/v1/refundPayment |
Base URL | https://apis.garantibbva.com.tr |
Technology
Technology Stack / DESIGN TIME |
|
---|---|
Property | Value |
HTTP Call Method | POST |
Response Content Type | application/json |
Request
HTTP POST method is allowed only in Refund Payment service.
Arguments
The list of arguments by the Refund Payment service to be invoked.
Request Fields | Type | Description | Obligation |
---|---|---|---|
OrderID | String | The order/invoice number which is unique. | Mandatory |
RefundRequestID | String | ||
RefundAmount | String |
Sample request
{ "OrderID":"ORDERID00029", "RefundRequestID":"abc", "RefundAmount":"100.00" }
Response
The refund payment service returns the result.
Sample response
"result": { "code": 202, "info": "The request has been received" }, "response":{ "resultCode":"B001", "resultMessage":"İşleminiz tamamlandı" }
Response codes from Status Inquiry 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 |
---|---|
400 |
{ "result": { "code": 400, "info": "Invalid Request" } } |
401 |
{ "result": { "code": 401, "info": "Invalid Credentials" } } |
405 |
{ "result": { "code": 405, "info": "POST Method Not Allowed" } } |
429 |
{ "result": { "code": 429, "info": "API plan limit exceeded" } } |
500 |
{ "result": { "code": 500, "info": "Internal Server Error" } } |
Response Messages
CODE |
RETURN RESPONSE |
---|---|
400 |
{ "result": { "code": 400, "info": "Invalid Request" }, "response":{ "resultCode":"H001", "resultMessage":"Kurum kodu dolu olmalıdır." } } |
400 |
{ "result": { "code": 400, "info": "Invalid Request" }, "response":{ "resultCode":"H011", "resultMessage":"Sipariş/Fatura numarası dolu olmalıdır." } } |
400 |
{ "result": { "code": 400, "info": "Invalid Request" }, "response":{ "resultCode":"H013", "resultMessage":"İade tutarı alanı zorunludur." } } |
400 |
{ "result": { "code": 400, "info": "Invalid Request" }, "response":{ "resultCode":"H014", "resultMessage":"Kurum grup kodu için iade yapılamaz." } } |
400 |
{ "result": { "code": 400, "info": "Invalid Request" }, "response":{ "resultCode":"H008", "resultMessage":"Kurum statüsü uygun değildir." } } |
400 |
{ "result": { "code": 400, "info": "Invalid Request" }, "response":{ "resultCode":"H003", "resultMessage":"Kurum tahsilata kapalıdır." } } |
400 |
{ "result": { "code": 400, "info": "Invalid Request" }, "response":{ "resultCode":"H015", "resultMessage":"Kayıt durumu iptale uygun değil." } } |
400 |
{ "result": { "code": 400, "info": "Invalid Request" }, "response":{ "resultCode":"H016", "resultMessage":"İşlem zaten iade edilmiş." } } |
400 |
{ "result": { "code": 400, "info": "Invalid Request" }, "response":{ "resultCode":"H017", "resultMessage":"İade tutarı hatalı." } } |
400 |
{ "result": { "code": 400, "info": "Invalid Request" }, "response":{ "resultCode":"H018", "resultMessage":"Kurum hesabında bakiye bulunmamaktadır." } } |
-
API URL : https://apis.garantibbva.com.tr
-
-
-