Ana içeriğe atla
POST
Collect one payment against several transactions

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Yol Parametreleri

id
integer
gerekli

The customer identifier

Gövde

application/json
transaction_ids
integer[]
gerekli

The customer's transactions to settle. Each must be a debt (remaining_debit above 0, not a purchase invoice) and all must share one currency.

Required array length: 1 - 200 elements

A transaction of this customer.

amount
number
gerekli

Collected amount, in the transactions' currency; at most their outstanding total.

Gerekli aralık: x >= 0.01
payment_method
enum<string>
gerekli

The payment method used for this collection.

Mevcut seçenekler:
bank_account,
cash,
transfer_cash,
other,
clinic_credit_card,
credit_card,
private_insurance,
sgk
account_id
integer | null

Account the money goes into (optional); must use the transactions' currency.

exchange_rate
number | null

Exchange rate to the base currency. Defaults to the latest TCMB selling rate; ignored for the base currency.

transaction_date
string<date-time> | null

When the money was collected. Defaults to now; a naive value is read in the tenant timezone.

description
string | null

The description.

Maximum string length: 65535
invoice_number
string | null

The invoice number the collection belongs to.

Maximum string length: 255

Yanıt

The response is of type object.