Cari Tahsilat İşlemi
Müşteri/Cari için tahsilat işlemi gerçekleştirilir.
Endpoint
POST /kolaybi/v1/associates/{id}/transactions/proceed
Parametreler
Parametre | Tip | Açıklama |
---|---|---|
id | integer | Tahsilat işlemi yapılacak carinin ID değeri |
Request Body
Alan | Tip | Zorunlu | Açıklama |
---|---|---|---|
amount | number | Evet | Tahsilat tutarı |
currency | string | Evet | Para birimi |
gateway_id | integer | Evet | Tahsilat hesabı ID'si |
gateway_type | string | Hayır | Tahsilat hesabı türü (Vault/Associate) |
exchange_rate | number | Hayır | Döviz kuru |
project_ids | array | Hayır | Proje ID'leri listesi |
description | string | Hayır | Açıklama |
Örnekler
- cURL
- JavaScript
- PHP
- Python
- C#
curl -X POST "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates/123/transactions/proceed" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Channel: YOUR_CHANNEL" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "amount=1000¤cy=TRY&gateway_id=1&description=Tahsilat açıklaması"
async function createAssociateProceed(associateId, proceedData) {
const formData = new URLSearchParams();
Object.keys(proceedData).forEach((key) => {
formData.append(key, proceedData[key]);
});
const response = await fetch(
`https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates/${associateId}/transactions/proceed`,
{
method: "POST",
headers: {
Authorization: `Bearer ${accessToken}`,
Channel: channel,
"Content-Type": "application/x-www-form-urlencoded",
},
body: formData,
}
);
return await response.json();
}
// Kullanım
const proceed = await createAssociateProceed(123, {
amount: 1000,
currency: "TRY",
gateway_id: 1,
description: "Tahsilat açıklaması",
});
function createAssociateProceed($associateId, $proceedData) {
$url = "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates/{$associateId}/transactions/proceed";
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => $url,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => http_build_query($proceedData),
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $accessToken,
'Channel: ' . $channel,
'Content-Type: application/x-www-form-urlencoded'
],
CURLOPT_RETURNTRANSFER => true
]);
$response = curl_exec($ch);
curl_close($ch);
return json_decode($response, true);
}
// Kullanım
$proceed = createAssociateProceed(123, [
'amount' => 1000,
'currency' => 'TRY',
'gateway_id' => 1,
'description' => 'Tahsilat açıklaması'
]);
import requests
def create_associate_proceed(associate_id, proceed_data):
url = f'https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates/{associate_id}/transactions/proceed'
headers = {
'Authorization': f'Bearer {access_token}',
'Channel': channel,
'Content-Type': 'application/x-www-form-urlencoded'
}
response = requests.post(url, data=proceed_data, headers=headers)
return response.json()
# Kullanım
proceed = create_associate_proceed(123, {
'amount': 1000,
'currency': 'TRY',
'gateway_id': 1,
'description': 'Tahsilat açıklaması'
})
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
using Newtonsoft.Json;
async Task<dynamic> CreateAssociateProceedAsync(int associateId, Dictionary<string, string> proceedData)
{
using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post,
$"https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/associates/{associateId}/transactions/proceed")
{
Content = new FormUrlEncodedContent(proceedData)
};
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);
request.Headers.Add("Channel", channel);
var response = await client.SendAsync(request);
var content = await response.Content.ReadAsStringAsync();
return JsonConvert.DeserializeObject<dynamic>(content);
}
// Kullanım
var proceed = await CreateAssociateProceedAsync(123, new Dictionary<string, string>
{
{ "amount", "1000" },
{ "currency", "TRY" },
{ "gateway_id", "1" },
{ "description", "Tahsilat açıklaması" }
});
Yanıt
{
"data": {
"transaction_status": "Tamamlandı",
"transaction_type": "Tahsilat",
"payment_method": "Nakit",
"issue_date": "2024-01-15 14:30:00",
"amount": 1000,
"currency": "TRY"
}
}
Yanıt Alanları
Alan | Tip | Açıklama |
---|---|---|
transaction_status | string | İşlem durumu |
transaction_type | string | İşlem tipi |
payment_method | string | Ödeme metodu |
issue_date | string | İşlem tarihi |
amount | number | İşlem tutarı |
currency | string | Para birimi |