> For the complete documentation index, see [llms.txt](https://docs.iyzico.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.iyzico.com/en/products/physical-pos/terminal-api-integration/vuk-507-services/partial-payment.md).

# Partial Payment

Enables collecting a single sale in multiple parts using different payment methods.

In the partial payment flow, the process is not completed and no fiscal record is created until the **Complete** call is made.

### **Initialize Partial Payment**

## POST /v2/terminal-host/gmu/partial-payment/start

> Starts the partial payment flow where the same sale can be covered by different payment instruments. The returned saleNumber is used in the following steps.<br>

```json
{"openapi":"3.0.3","info":{"title":"Terminal API - GMU Payment and Transaction Services","version":"1.0.0"},"tags":[{"name":"GMU Payment","description":"GMU sale and transaction services"}],"servers":[{"url":"https://sandbox-api.iyzipay.com","description":"Sandbox Environment"},{"url":"https://api.iyzipay.com","description":"Live Environment"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer Token authentication is performed using the access token."}},"parameters":{"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"},"description":"Content type"}},"schemas":{"GmuPaymentRequest":{"type":"object","required":["deviceUniqueId","transactionReferenceId","price","paidPrice","saleAppName","saleAppVersion","saleDocumentType","saleItems","paymentType"],"properties":{"locale":{"type":"string","description":"Language code. Default is TR"},"conversationId":{"type":"string","description":"Request correlation ID. If left empty, a UUID is generated automatically."},"deviceUniqueId":{"type":"string","description":"Unique identifier of the device. Maximum 64 characters"},"transactionReferenceId":{"type":"string","description":"Unique reference ID assigned by the caller for this transaction. It can be used in void and query operations."},"price":{"type":"decimal","description":"Gross amount. Must be positive"},"paidPrice":{"type":"decimal","description":"Final payable amount. Must be positive"},"paymentType":{"type":"string","description":"Payment type. Card, Cash, etc.","enum":["CARD","CASH"]},"currency":{"type":"string","description":"Currency. Default is TRY","enum":["TRY","USD","EUR"]},"installment":{"type":"integer","description":"Installment count. Default is 1"},"saleAppName":{"type":"string","description":"Name of the sale application"},"saleAppVersion":{"type":"string","description":"Version of the sale application"},"saleDocumentType":{"type":"string","description":"Document type. 1 for e-Invoice, 9 for Expense Slip","enum":["1","9"]},"notificationPhone":{"type":"string","description":"Phone number requested for SMS notification"},"notificationEmail":{"type":"string","description":"Email address requested for notification"},"saleItems":{"type":"array","description":"Sale items. At least 1 item is required.","minItems":1,"items":{"$ref":"#/components/schemas/SaleItem"}},"buyerInfo":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BuyerInfo"}],"description":"Must be filled in if the sale is not made to an end consumer."}}},"SaleItem":{"type":"object","required":["name","unitCode","taxGroupCode","itemQuantity","unitPriceAmount","grossPriceAmount","totalPriceAmount"],"properties":{"name":{"type":"string","description":"Product or service name"},"generic":{"type":"boolean","description":"Generic product information"},"unitCode":{"type":"string","description":"Unit code. Example C62 means quantity piece"},"taxGroupCode":{"type":"string","description":"VAT group code"},"itemQuantity":{"type":"integer","description":"Item quantity"},"unitPriceAmount":{"type":"decimal","description":"Unit price. Must be positive"},"grossPriceAmount":{"type":"decimal","description":"Gross price. Must be positive"},"totalPriceAmount":{"type":"decimal","description":"Total price. Must be positive"}}},"BuyerInfo":{"type":"object","properties":{"customerType":{"type":"integer","description":"Customer type. 1 individual, 2 corporate","enum":[1,2]},"firstName":{"type":"string","description":"First name"},"middleName":{"type":"string","description":"Middle name"},"familyName":{"type":"string","description":"Last name"},"companyName":{"type":"string","description":"Company name. Used for corporate customers"},"taxOfficeCode":{"type":"string","description":"Tax office code"},"taxNumber":{"type":"string","description":"Tax number or Turkish identity number"},"country":{"type":"string","description":"Country"},"city":{"type":"string","description":"City"},"district":{"type":"string","description":"District"}}},"GmuPartialPaymentStartResponse":{"type":"object","properties":{"status":{"type":"string","description":"success or failure"},"errorCode":{"type":"string","description":"Error code"},"errorMessage":{"type":"string","description":"Error message"},"conversationId":{"type":"string","description":"Correlation ID"},"systemTime":{"type":"integer","description":"Timestamp epoch ms"},"saleNumber":{"type":"string","description":"Main payment ID representing the partial payment flow. Used in Add Partial Payment and Complete Partial Payment steps."},"remainingPaymentAmount":{"type":"decimal","description":"Remaining unpaid amount"}}}}},"paths":{"/v2/terminal-host/gmu/partial-payment/start":{"post":{"tags":["GMU Payment"],"description":"Starts the partial payment flow where the same sale can be covered by different payment instruments. The returned saleNumber is used in the following steps.\n","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmuPaymentRequest"}}}},"responses":{"200":{"description":"Successful partial payment start result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmuPartialPaymentStartResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmuPartialPaymentStartResponse"}}}}}}}}}
```

### Ödeme İşlemi Ekleme

## POST /v2/terminal-host/gmu/partial-payment/add-payment

> Adds a new payment to an initiated partial payment flow. It can be called multiple times until the remaining amount becomes zero.<br>

```json
{"openapi":"3.0.3","info":{"title":"Terminal API - GMU Payment and Transaction Services","version":"1.0.0"},"tags":[{"name":"GMU Payment","description":"GMU sale and transaction services"}],"servers":[{"url":"https://sandbox-api.iyzipay.com","description":"Sandbox Environment"},{"url":"https://api.iyzipay.com","description":"Live Environment"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer Token authentication is performed using the access token."}},"parameters":{"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"},"description":"Content type"}},"schemas":{"GmuPartialPaymentAddRequest":{"type":"object","required":["saleNumber","price"],"properties":{"locale":{"type":"string","description":"Language code"},"conversationId":{"type":"string","description":"Correlation ID"},"deviceUniqueId":{"type":"string","description":"Device unique ID"},"transactionReferenceId":{"type":"string","description":"Reference ID of this add payment transaction"},"saleNumber":{"type":"string","description":"saleNumber returned from the Start step"},"price":{"type":"decimal","description":"Amount to be paid in this step. Must not exceed the remaining amount"},"installment":{"type":"integer","description":"Installment count. Default is 1"},"currency":{"type":"string","description":"Currency"}}},"GmuPaymentResponse":{"type":"object","properties":{"status":{"type":"string","description":"success or failure"},"errorCode":{"type":"string","description":"Error code. Returns 0 for successful transactions"},"errorMessage":{"type":"string","description":"Error message"},"conversationId":{"type":"string","description":"Correlation ID matching the request"},"systemTime":{"type":"integer","description":"transaction time epoch ms"},"deviceUniqueId":{"type":"string","description":"ID of the device used in the transaction"},"transactionReferenceId":{"type":"string","description":"Reference ID of the caller"},"transactionDateTime":{"type":"string","description":"Date and time when the transaction occurred"},"paymentId":{"type":"string","description":"Generated payment ID. Used in refund and void operations."},"paymentDate":{"type":"integer","description":"Payment date. In YYYYMMDD format"},"price":{"type":"decimal","description":"Transaction amount"},"installment":{"type":"integer","description":"Installment count"},"acquirerId":{"type":"string","description":"Acquirer bank ID"},"bankMerchantId":{"type":"string","description":"Bank merchant number"},"bankTerminalId":{"type":"string","description":"Bank terminal ID"},"issuerId":{"type":"string","description":"Card issuer institution ID"},"currency":{"type":"string","description":"Currency","enum":["TRY","USD","EUR"]},"authCode":{"type":"string","description":"Authorization code"},"binNumber":{"type":"string","description":"BIN number of the card. First 6 digits"},"lastFourDigits":{"type":"string","description":"Last 4 digits of the card"},"hostReference":{"type":"string","description":"Host reference number"},"cardType":{"type":"string","description":"Card type. Example CREDIT or DEBIT"},"batchNo":{"type":"string","description":"Batch number"},"stanNo":{"type":"string","description":"STAN number"},"posEntryModeCode":{"type":"string","description":"POS entry mode code"},"saleItems":{"type":"array","description":"Details of the sale items added to the transaction","items":{"$ref":"#/components/schemas/AddedSaleItem"}},"saleNumber":{"type":"string","description":"Sale number. Used in partial payment add and complete services referenced in items 7 and 8"}}},"AddedSaleItem":{"type":"object","properties":{"name":{"type":"string","description":"Name of the sale item added to the transaction"},"generic":{"type":"boolean","description":"Generic product information"},"unitCode":{"type":"string","description":"Unit code"},"taxGroupCode":{"type":"string","description":"VAT group code"},"itemQuantity":{"type":"integer","description":"Item quantity"},"unitPriceAmount":{"type":"decimal","description":"Unit price"},"grossPriceAmount":{"type":"decimal","description":"Gross price"},"totalPriceAmount":{"type":"decimal","description":"Total price"}}}}},"paths":{"/v2/terminal-host/gmu/partial-payment/add-payment":{"post":{"tags":["GMU Payment"],"description":"Adds a new payment to an initiated partial payment flow. It can be called multiple times until the remaining amount becomes zero.\n","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmuPartialPaymentAddRequest"}}}},"responses":{"200":{"description":"Successful partial payment add result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmuPaymentResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmuPaymentResponse"}}}}}}}}}
```

### Complete Partial Payment

## POST /v2/terminal-host/gmu/partial-payment/complete

> Closes the flow and finalizes the sale after all partial payments are added. Returns the full sale response.<br>

```json
{"openapi":"3.0.3","info":{"title":"Terminal API - GMU Payment and Transaction Services","version":"1.0.0"},"tags":[{"name":"GMU Payment","description":"GMU sale and transaction services"}],"servers":[{"url":"https://sandbox-api.iyzipay.com","description":"Sandbox Environment"},{"url":"https://api.iyzipay.com","description":"Live Environment"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer Token authentication is performed using the access token."}},"parameters":{"ContentTypeHeader":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"},"description":"Content type"}},"schemas":{"GmuPartialPaymentCompleteRequest":{"type":"object","required":["deviceUniqueId","transactionReferenceId","saleNumber"],"properties":{"locale":{"type":"string","description":"Language code"},"conversationId":{"type":"string","description":"Correlation ID"},"deviceUniqueId":{"type":"string","description":"Device unique ID. Maximum 64 characters"},"transactionReferenceId":{"type":"string","description":"Reference ID of this completion transaction"},"saleNumber":{"type":"string","description":"saleNumber returned from the Start Partial Payment step"}}},"GmuPartialPaymentCompleteResponse":{"allOf":[{"$ref":"#/components/schemas/GmuPaymentResponse"},{"type":"object","properties":{"remainingPaymentAmount":{"type":"decimal","description":"Remaining payment amount. It must be 0 when completion is successful"}}}]},"GmuPaymentResponse":{"type":"object","properties":{"status":{"type":"string","description":"success or failure"},"errorCode":{"type":"string","description":"Error code. Returns 0 for successful transactions"},"errorMessage":{"type":"string","description":"Error message"},"conversationId":{"type":"string","description":"Correlation ID matching the request"},"systemTime":{"type":"integer","description":"transaction time epoch ms"},"deviceUniqueId":{"type":"string","description":"ID of the device used in the transaction"},"transactionReferenceId":{"type":"string","description":"Reference ID of the caller"},"transactionDateTime":{"type":"string","description":"Date and time when the transaction occurred"},"paymentId":{"type":"string","description":"Generated payment ID. Used in refund and void operations."},"paymentDate":{"type":"integer","description":"Payment date. In YYYYMMDD format"},"price":{"type":"decimal","description":"Transaction amount"},"installment":{"type":"integer","description":"Installment count"},"acquirerId":{"type":"string","description":"Acquirer bank ID"},"bankMerchantId":{"type":"string","description":"Bank merchant number"},"bankTerminalId":{"type":"string","description":"Bank terminal ID"},"issuerId":{"type":"string","description":"Card issuer institution ID"},"currency":{"type":"string","description":"Currency","enum":["TRY","USD","EUR"]},"authCode":{"type":"string","description":"Authorization code"},"binNumber":{"type":"string","description":"BIN number of the card. First 6 digits"},"lastFourDigits":{"type":"string","description":"Last 4 digits of the card"},"hostReference":{"type":"string","description":"Host reference number"},"cardType":{"type":"string","description":"Card type. Example CREDIT or DEBIT"},"batchNo":{"type":"string","description":"Batch number"},"stanNo":{"type":"string","description":"STAN number"},"posEntryModeCode":{"type":"string","description":"POS entry mode code"},"saleItems":{"type":"array","description":"Details of the sale items added to the transaction","items":{"$ref":"#/components/schemas/AddedSaleItem"}},"saleNumber":{"type":"string","description":"Sale number. Used in partial payment add and complete services referenced in items 7 and 8"}}},"AddedSaleItem":{"type":"object","properties":{"name":{"type":"string","description":"Name of the sale item added to the transaction"},"generic":{"type":"boolean","description":"Generic product information"},"unitCode":{"type":"string","description":"Unit code"},"taxGroupCode":{"type":"string","description":"VAT group code"},"itemQuantity":{"type":"integer","description":"Item quantity"},"unitPriceAmount":{"type":"decimal","description":"Unit price"},"grossPriceAmount":{"type":"decimal","description":"Gross price"},"totalPriceAmount":{"type":"decimal","description":"Total price"}}}}},"paths":{"/v2/terminal-host/gmu/partial-payment/complete":{"post":{"tags":["GMU Payment"],"description":"Closes the flow and finalizes the sale after all partial payments are added. Returns the full sale response.\n","parameters":[{"$ref":"#/components/parameters/ContentTypeHeader"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmuPartialPaymentCompleteRequest"}}}},"responses":{"200":{"description":"Successful partial payment completion result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmuPartialPaymentCompleteResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GmuPartialPaymentCompleteResponse"}}}}}}}}}
```
