Payantis Platform
v2 - latest
  • v2 - latest
  • v1
v2 - latest
  • v2 - latest
  • v1
v2 - latest
  • v2 - latest
  • v1
  1. Kurum Real-Time API
  • Payantis Platform
    • Payantis Platform
    • API Kullanımı
    • Temel Kavramlar
  • Issuing API
    • Payantis Issuing
    • Adım Adım Issuing API
    • Kural Motoru
    • Hassas Bilgilerin Güvenli İletimi
    • Customer
      • Create Customer
      • Get or Create Customer
      • Get Customer
      • Get Customer List
      • Update Customer
      • Update Customer Segment
      • Upsert Address
      • Upsert Communication
      • Upsert Identification
      • Create Segment
      • Get Segments
      • Update Segment
      • Delete Segment
      • Create User Note
      • Get User Notes
    • Card
      • Create Card
      • Create Noname Card
      • Get Card List
      • Get Card
      • Get Card Details
      • Get Card Policy
      • Get Card Perso Info
      • Get Card Shipment Info
      • Renew Card
      • Detokenize Card
      • Link Noname Card To Customer
      • Unlink Noname Card
      • Update Card Status
      • Update Customer Card Statuses
      • Update Card Policy
      • Update Card Phone Number
      • Update Digital Slip Type
      • Update Auto Renewal Status
      • Get Payantis Public Key
      • Cvv2 - Reset Counters
      • Cvv2 - Verify
      • Cvv2 - Get with Expire Date
      • Pin - Verify
      • Pin - Set
      • Pin - Change
      • Pin - Unblock
      • Pin - Set Random
      • Pin - Send via SMS
      • Creates User Note
      • Get User Notes
    • Product
      • Create Card Art
      • Create Card Bin Range
      • Create Card Product
      • Create Card Product Group
      • Get Card Art List
      • Get Card Bin List
      • Get Card Bin Range List
      • Get Card Product Group List
      • Get Card Product List
      • Get Card Product
      • Update Card Art Name
      • Update Card Bin Range
      • Update Card Product Group
      • Update Card Product
      • Update Card Product Contactless Limit
      • Delete Card Art
      • Delete Card Product Group
      • Delete Card Product
    • Transactions
      • Get Card Transactions
    • Authorization Controls
      • Create Authorization Control
      • Update Authorization Control
      • Link
      • Unlink
      • Get Authorization Controls
      • Get Links
      • Delete Authorization Control
    • Velocity Controls
      • Create Velocity Control
      • Update Velocity Control
      • Get Velocity Control
      • Get Velocity Control List
      • Delete Velocity Control
      • Link
      • Unlink
      • Get Velocity Links
      • Get Card Velocity Limits
      • Card Velocity
      • Get Card Velocity
      • Delete Card Velocity
    • Fees
      • Transaction Fee
        • Create
        • Get List
        • Get
        • Update
        • Delete
        • Link
        • Get Links
        • Unlink
      • Card Issuance Fee
        • Create
        • Update
        • Get
        • Get List
        • Delete
        • Link
        • Get Links
        • Unlink
      • Card Annual Fee
        • Create
        • Get List
        • Update
        • Get
        • Delete
        • Link
        • Get Links
        • Unlink
    • WebHook
      • Register
      • Get Registered Webhooks
      • Unregister
      • Update
    • AuditLog
      • Get Audits
    • Schemas
      • EntityChangeLogResponseDto
      • CardPhysicalDto
      • QueryBuilderFieldDto
      • AddressDto
      • AuthorizationCheckDto
      • AuthorizationCheckLinkDto
      • BaseCardPhysicalInfoDto
      • CompanyInfo
      • CardAccountStatisticInfoDto
      • CardDetokenizeRequestDto
      • CardDetokenizeResponseDto
      • CardPhoneNumberUpdateRequestDto
      • CardPhysicalInfoDto
      • CardPolicyInfoDto
      • CardProductInfoDto
      • CardRenewalRequestDto
      • CardRequestDto
      • CardResponseInfoDto
      • CardStatusInfoDto
      • CardStatusUpdateRequestDto
      • ContactlessLimitDto
      • CreateCardArtDto
      • CreateCardDto
      • CreateCardProductDto
      • CreateCustomerAddressDto
      • CreateCustomerCommunicationDto
      • CreateCustomerDto
      • CreateCustomerIdentificationDto
      • CreateUpdateAuthorizationCheckLinkDto
      • CreateUpdateCardAnnualFeeLinkDto
      • CreateUpdateCardIssuanceFeeLinkDto
      • CreateUpdateCardProductGroupDto
      • CreateUpdateTransactionFeeLinkDto
      • CreateUpdateVelocityCheckLinkDto
      • CreateVelocityCheckDto
      • CustomerInfoDto
      • FindCardResponseDto
      • PinRequestDto
      • TransactionCriteriaDto
      • UpdateCardArtDto
      • UpdateCardAutoRenewalStatusDto
      • UpdateCardProductDto
      • UpdateCardStatusResponseDto
      • UpdateCardStatusAndIssuanceResponseDto
      • UpdateCustomerCardStatusRequestDto
      • UpdateCustomerCardStatusResponseDto
      • UpdateCustomerDto
      • UpdateVelocityCheckDto
      • VelocityAvailableAmountDto
      • VelocityCheckDto
      • VelocityControlsDto
      • VelocityLimitDto
      • VelocityUsedAmountDto
      • BaseCardDto
      • BaseCardProductPhysicalDto
      • BaseLinkDto
      • CardAnnualFeeDto
      • CardAnnualFeeLinkDto
      • CardArtDto
      • CardDeliveryAddressDto
      • CardDeliveryCommunicationDto
      • CardDetailDto
      • CardDto
      • CardInfoDto
      • CardIssuanceFeeDto
      • CardIssuanceFeeLinkDto
      • CardPolicyAddRequestDto
      • CardPolicyDto
      • CardPolicyResponseDto
      • CardProductDetailDto
      • CardProductDto
      • CardProductGroupDto
      • CardProductPhysicalDto
      • CardSummaryDto
      • ChangePinRequestDto
      • CreateAuthorizationCheckDto
      • CreateCardAnnualFeeDto
      • CreateCardIssuanceFeeDto
      • CreateCardPolicyDto
      • CreateCardProductPhysicalDto
      • CreateTransactionFeeDto
      • CreateUpdateCustomerSegmentDto
      • CustomerAddressDto
      • CustomerCommunicationDto
      • CustomerDetailDto
      • CustomerDto
      • CustomerIdentificationDto
      • CustomerSegmentDto
      • CardVelocityRequestDto
      • CardShipmentDetailResponseDto
      • CardShipmentResponseDto
      • Cvv2AndResponseDto
      • IssuanceDetailsDto
      • IssuanceDto
      • IssuanceNewCardDto
      • IssuanceSummaryDto
      • LinkCustomerDtoV2
      • CustomerCardsDto
      • NoNameCardRequestDto
      • TransactionFeeDto
      • TransactionFeeLinkDto
      • UnLinkCustomerDto
      • UpdateAuthorizationCheckDto
      • UpdateCardAnnualFeeDto
      • UpdateCardIssuanceFeeDto
      • UpdateDigitalSlipTypeDto
      • UpdateDigitalSlipTypeResponseDto
      • UpdateTransactionFeeDto
      • UpdatedCardInfo
      • VelocityCheckLinkDto
      • VerifCvv2RequestDto
      • VerifyOrSetPinRequestDto
      • CreateCardBulkResponseDto
      • PublicKeyDto
      • IntegrationKeyExchangeResponseDto
      • TenantWebHookRequestDto
      • CurrencyExchangeRateDto
      • AdditionalAmountDto
      • CreateUserNoteRequestDto
      • NoteResponseDto
      • TaxDto
      • CreateUpdateCurrencyExchangeRateDto
      • TenantWebHookResponseDto
      • UpdateTenantCurrencyConversionDto
      • CardTransactionResponseDto
      • PagedResultDto<EntityChangeLogResponseDto>
      • PagedResultDto<CardProductDetailDto>
      • PagedResultDto<CardProductGroupDto>
      • PagedResultDto<CustomerDto>
      • PagedResultDto<CustomerSegmentDto>
      • PagedResultDto<IssuanceSummaryDto>
      • PagedResultDto<NoteResponseDto>
      • PagedResultDto<CardTransactionResponseDto>
      • VelocityCheckLinkCriteriaDto
      • CardBinDto
      • CardBinRangeDto
      • CreateCardBinDto
      • CreateUpdateCardBinRangeDto
      • UpdateCardBinDto
      • PagedResultDto<CardBinDto>
  • Kurum Finansal Entegrasyon
    • Finansal Entegrasyon
    • Günsonu Dosyaları
    • Settlement Dosyası Alanları
    • Expire Dosyası Alanları
    • Kurum Real-Time API
      • Authenticate
        POST
      • Auth Refresh
        POST
      • Balance Inquiry
        POST
      • Authorization
        POST
      • Reverse
        POST
      • Refund
        POST
      • Notify
        POST
    • Schemas
      • BaseRequestDto
      • RefundRequestDto
      • BalanceInquiryRequestDto
      • BaseResponseDto
      • AuthorizationResponseDto
      • BalanceInquiryResponseDto
      • RefundResponseDto
      • ReversalResponseDto
      • AuthorizationRequestDto
      • AdditionalAmountDto
      • AccountDetailDto
      • OriginalDetailDto
      • ReversalRequestDto
      • BalanceInformationDto
      • NotificationRequestDto
      • NotificationResponseDto
  • Transaction Testing API
    • Transaction Testing
    • Get Card Info
    • Generate Pin Block
    • Extract Clear Pin
    • Process Transaction
    • Void Transaction
    • Refund Transaction
    • Schemas
      • Payantis.SandBox.BaseSimulationResponseDto
      • Payantis.SandBox.DetailedSimulationRefundRequestDto
      • Payantis.SandBox.DetailedSimulationRefundResponseDto
      • Payantis.SandBox.DetailedSimulationRequestDto
      • Payantis.SandBox.DetailedSimulationResponseDto
      • Payantis.SandBox.DetailedSimulationReversalRequestDto
      • Payantis.SandBox.DetailedSimulationReversalResponseDto
      • Payantis.SandBox.Dto.ClearCardInfoDto
      • Payantis.SandBox.Dto.ClearCardInfoRequestDto
      • Payantis.SandBox.Dto.ClearPinRequestDto
      • Payantis.SandBox.Dto.ClearPinResponseDto
      • Payantis.SandBox.Dto.EncryptCardNumberRequestDto
      • Payantis.SandBox.Dto.PinBlockRequestDto
      • Payantis.SandBox.Dto.PinBlockResponseDto
      • Payantis.SandBox.Dto.PinTestRequestDto
      • Payantis.SandBox.Dto.PinTestResponseDto
      • Payantis.SandBox.SimulationRefundRequestDto
      • Payantis.SandBox.SimulationRefundResponseDto
      • Payantis.SandBox.SimulationRequestDto
      • Payantis.SandBox.SimulationResponseDto
      • Payantis.SandBox.SimulationReversalRequestDto
      • Payantis.SandBox.SimulationReversalResponseDto
      • Payantis.SystemParameter.AdditionalAmountCalculationSource
      • Payantis.SystemParameter.AdditionalAmountType
      • Payantis.SystemParameter.ArqcResultCodes
      • Payantis.SystemParameter.CardBrand
      • Payantis.SystemParameter.CardholderActivatedTerminalLevel
      • Payantis.SystemParameter.CardholderPresence
      • Payantis.SystemParameter.CavvResultCode
      • Payantis.SystemParameter.CvcResultCode
      • Payantis.SystemParameter.Dto.AdditionalAmountDto
      • Payantis.SystemParameter.Dto.TaxDto
      • Payantis.SystemParameter.KeyType
      • Payantis.SystemParameter.LmkType
      • Payantis.SystemParameter.PosEntryMode
      • Payantis.SystemParameter.ResponseCodes
      • Payantis.SystemParameter.SLIChannel
      • Payantis.SystemParameter.SLIUcafStatusCode
      • Payantis.SystemParameter.TerminalPinCapability
      • Payantis.SystemParameter.TerminalType
      • Payantis.SystemParameter.TransactionCode
      • Payantis.SystemParameter.TransactionDomain
      • Payantis.SystemParameter.TransactionFlowCode
      • Payantis.SystemParameter.TransactionNetwork
      • Payantis.SystemParameter.TransactionStatus
  • Acquiring API
    • Payantis Acquiring
    • Merchant
      • Create Merchant
      • Update Merchant
      • Delete Merchant
      • Get Merchant
      • List Merchants
      • List Merchant Transactions
      • Get Linked Merchant Transactions
      • Get Merchant Terminals
      • Upsert Merchant Contact
      • Upsert Merchant Identity
      • Upsert Merchant Address
      • Upsert Merchant Velocity
      • Delete Merchant Contact
      • Delete Merchant Identity
      • Delete Merchant Address
      • Delete Merchant Velocity
      • Create Merchant User Note
      • List Merchant User Notes
      • Get Allowable Merchant Status Reasons
      • Get Merchant Transaction QR Data
    • Terminal
      • Create Terminal
      • Update Terminal
      • Delete Terminal
      • Get Terminal
      • List Terminals
      • Change Terminal Allowed Currencies
    • Batch
      • Get Batch
      • List Batches
      • Update Batch Status
    • Restriction
      • Create Restricted BIN
      • Create Restricted Country
      • Create Restricted Card
      • List Restricted BINs
      • List Restricted Countries
      • List Restricted Cards
      • Update Restricted BIN
      • Update Restricted Country
      • Update Restricted Card
      • Delete Restricted BIN
      • Delete Restricted Country
      • Delete Restricted Card
    • Terminal Auth Template
      • Create Authorization Template
      • Get Authorization Template
      • Update Authorization Template
      • Delete Authorization Template
      • List Authorization Templates
    • Terminal EOD Messages
      • Create EOD Message Template
      • Get EOD Message Template
      • Update EOD Message Template
      • Delete EOD Message Template
      • List EOD Message Templates
    • Transaction Details
      • Get Transaction Message Fields
      • Get Transaction Message Fields by IDs
    • Schemas
      • Payantis.Acquiring.Merchant.AuthTemplateResponseDto
      • Payantis.Acquiring.Merchant.BatchDto
      • Payantis.Acquiring.Merchant.ChangeTerminalAllowedCurrenciesDto
      • Payantis.Acquiring.Merchant.CreateAuthTemplateDto
      • Payantis.Acquiring.Merchant.CreateEodMessageTemplateDto
      • Payantis.Acquiring.Merchant.CreateMerchantDto
      • Payantis.Acquiring.Merchant.CreateRestrictedBinDto
      • Payantis.Acquiring.Merchant.CreateRestrictedCardDto
      • Payantis.Acquiring.Merchant.CreateRestrictedCountryDto
      • Payantis.Acquiring.Merchant.CreateTerminalDto
      • Payantis.Acquiring.Merchant.EodMessageTemplateResponseDto
      • Payantis.Acquiring.Merchant.MerchantAddressDto
      • Payantis.Acquiring.Merchant.MerchantContactDto
      • Payantis.Acquiring.Merchant.MerchantDto
      • Payantis.Acquiring.Merchant.MerchantIdentityDto
      • Payantis.Acquiring.Merchant.MerchantVelocityDto
      • Payantis.Acquiring.Merchant.RestrictedBinDto
      • Payantis.Acquiring.Merchant.RestrictedCardDto
      • Payantis.Acquiring.Merchant.RestrictedCountryDto
      • Payantis.Acquiring.Merchant.TerminalDto
      • Payantis.Acquiring.Merchant.TerminalResponseDto
      • Payantis.Acquiring.Merchant.UpdateAuthTemplateDto
      • Payantis.Acquiring.Merchant.UpdateBatchStatusDto
      • Payantis.Acquiring.Merchant.UpdateEodMessageTemplateDto
      • Payantis.Acquiring.Merchant.UpdateMerchantDto
      • Payantis.Acquiring.Merchant.UpdateRestrictedBinDto
      • Payantis.Acquiring.Merchant.UpdateRestrictedCardDto
      • Payantis.Acquiring.Merchant.UpdateRestrictedCountryDto
      • Payantis.Acquiring.Merchant.UpdateTerminalDto
      • Payantis.Acquiring.Merchant.UpsertMerchantAddressDto
      • Payantis.Acquiring.Merchant.UpsertMerchantContactDto
      • Payantis.Acquiring.Merchant.UpsertMerchantIdentityDto
      • Payantis.Acquiring.Merchant.UpsertMerchantVelocityDto
      • Payantis.Framework.EnumDto
      • Payantis.SystemParameter.Dto.Request.CreateUserNoteRequestDto
      • Payantis.SystemParameter.Dto.Response.NoteResponseDto
      • Payantis.Transaction.Acquiring.Backend.MerchantTransactionResponseDto
      • Payantis.Transaction.Acquiring.Oltp.MerchantTransactionQrDataDto
      • Payantis.Transaction.GetMessageFieldsBatchRequestDto
      • Payantis.Transaction.MessageFieldsSummaryDto
      • Volo.Abp.Application.Dtos.PagedResultDto<Payantis.Acquiring.Merchant.AuthTemplateResponseDto>
      • Volo.Abp.Application.Dtos.PagedResultDto<Payantis.Acquiring.Merchant.BatchDto>
      • Volo.Abp.Application.Dtos.PagedResultDto<Payantis.Acquiring.Merchant.EodMessageTemplateResponseDto>
      • Volo.Abp.Application.Dtos.PagedResultDto<Payantis.Acquiring.Merchant.MerchantDto>
      • Volo.Abp.Application.Dtos.PagedResultDto<Payantis.Acquiring.Merchant.RestrictedBinDto>
      • Volo.Abp.Application.Dtos.PagedResultDto<Payantis.Acquiring.Merchant.RestrictedCardDto>
      • Volo.Abp.Application.Dtos.PagedResultDto<Payantis.Acquiring.Merchant.RestrictedCountryDto>
      • Volo.Abp.Application.Dtos.PagedResultDto<Payantis.Acquiring.Merchant.TerminalDto>
      • Volo.Abp.Application.Dtos.PagedResultDto<Payantis.SystemParameter.Dto.Response.NoteResponseDto>
      • Volo.Abp.Application.Dtos.PagedResultDto<Payantis.Transaction.Acquiring.Backend.MerchantTransactionResponseDto>
      • Payantis.Acquiring.Merchant.BatchCurrencySummaryDto
      • Payantis.Acquiring.Merchant.CreateMerchantQrDetailsDto
      • Payantis.Acquiring.Merchant.CreateMerchantContactDto
      • Payantis.Acquiring.Merchant.CreateMerchantIdentityDto
      • Payantis.Acquiring.Merchant.CreateMerchantAddressDto
      • Payantis.Acquiring.Merchant.CreateMerchantVelocityDto
      • Payantis.Acquiring.Merchant.MerchantEcommerceDetailsDto
      • Payantis.Acquiring.Merchant.MerchantQrDetailsDto
      • Payantis.Acquiring.Merchant.MerchantBasicDto
      • Payantis.Acquiring.Merchant.PhysicalTerminalDeviceDto
      • Payantis.Acquiring.Merchant.TerminalInfoDto
      • Payantis.Acquiring.Merchant.EodMessageTemplateDto
      • Payantis.Transaction.GetMessageFieldsRequestDto
  • VPOS API
    • Payantis VPOS
    • Sanal POS Hata Kodları
    • Payment
      • Process 3D Secure Payment
      • Process Non-Secure Payment
    • Schemas
      • Payantis.Vpos.Request.Payment.PaymentNonSecureRequest
      • Payantis.Vpos.Response.Payment.PaymentNonSecureResponse
      • Payantis.Vpos.TxnType
      • Payantis.Vpos.PaymentStatus
      • Payantis.Vpos.Domain.Shared.VposResponseStatus
      • Payantis.Vpos.SecureType
  • Auth API
    • Get Token
    • Refresh Token
  1. Kurum Real-Time API

Refund

POST
refund
Refund endpoint’i, tamamlanmış (takası gelmiş ve settle olmuş) bir kart işleminin, sonradan kısmen veya tamamen iade edilmesi amacıyla kullanılır. Reversal’dan temel farkı; refund işleminin, artık geri alınamaz noktaya gelmiş bir işlemin yeni ve ters yönlü bir finansal hareket olarak ele alınmasıdır.
Payantis Platform, kart ağı veya işyeri tarafından başlatılan bir iade talebini Kurum’a bu endpoint üzerinden iletir. Kurum, kendi muhasebe ve bakiye sistemlerinde iade işlemini işleyerek kart/hesap bakiyesine geri ödeme etkisini uygular.
Refund endpoint’i aşağıdaki fonksiyonları yerine getirir:
1
Orijinal işlemi referans alır
İade talebi, büyük çoğunlukla daha önce gerçekleşmiş bir işlemi referans alır (Referanslı İade). Bu amaçla Payantis, refund isteği içinde orijinal işleme ait bilgileri Kurum’a iletir. Request içindeki OriginalDetail nesnesindeki transactionId alanı orjinal işlemin numarasını belirtir. Eğer iade talebi bağımsız bir işlem ise (Referanssız İade) OriginalDetail nesnesi null olarak iletilir.
2
Finansal iade kaydı oluşturur
Refund işlemi, muhasebe açısından:
Orijinal işlemin iptali değil,
Ona bağlı yeni bir iade işlemi olarak değerlendirilir.
Bu nedenle Kurum, refund tutarı kadar bakiyeyi artıran bir finansal kayıt oluşturur.
3
Kısmi iade senaryolarını destekler
Kurum, refund isteğinde TransactionAmount alanı ile belirtilen tutara göre:
Tam iade
Kısmi iade
senaryolarını yönetebilir.
4
Sonuç kodu üretir
Kurum, iade talebinin sonucunu ResponseCode ile Payantis’e bildirir. Bu kod, Payantis’in kart ağına ve üst sistemlere doğru mesajı iletmesini sağlar.
İade işlemi de bir authorization işlemidir. Bu nedenle iade işleminin sonucunu belirten ResponseCode değerinin authorization işlemi ile aynı olması beklenir.
📌
İade (Refund) İşlemlerinde Bakiye Güncelleme Yaklaşımı
İade (refund) işlemlerinde, kart hamilinin hesabına anlık olarak alacak bakiyesi yansıtılması, operasyonel ve finansal riskler barındırabilir. Özellikle; mükerrer iade talepleri, takas öncesi iptaller, kart ağı kaynaklı geç bildirimler veya uyuşmazlık senaryolarında, anlık bakiye artışı gerçekleşmemiş fonun kart hamiline kullandırılması riskini doğurabilir.
Bu nedenle, iade işlemlerinin finansal etkisinin anlık bakiye güncellemesi yerine, gün sonunda Payantis tarafından Kurum’a iletilecek takas/mutabakat (clearing/settlement) dosyaları üzerinden muhasebeleştirilmesi tavsiye edilmektedir.
Bu yaklaşım ile:
İade tutarları, kart ağı ve Payantis kayıtları ile mutabık şekilde işlenir,
Mükerrer veya hatalı iade riskleri minimize edilir,
Kart hamiline henüz kesinleşmemiş bir alacak kullandırılmamış olur,
Kurum muhasebesi ile Payantis işlem kayıtları arasında tutarlılık sağlanır.
Özetle; refund işlemlerinde hesap bakiyesine doğrudan ve anlık alacak verilmesi yerine, iade tutarlarının takas/mutabakat süreci tamamlandıktan sonra hesaba yansıtılması, güvenli ve sürdürülebilir bir operasyon modeli olarak önerilmektedir.

Request

Body Params application/json

Examples

Responses

🟢200Success
application/json
Bodyapplication/json

Response Response Example
{
    "responseCode": "string",
    "responseDescription": "string",
    "tenantReferenceNo": "string",
    "balanceInformationList": [
        {
            "type": "string",
            "previousBalance": 0,
            "currency": 0,
            "currentBalance": 0
        }
    ],
    "additionalAmounts": [
        {
            "id": "string",
            "additionalAmountType": "TransactionFee",
            "amount": 0,
            "currency": 0
        }
    ],
    "qrData": "string",
    "qrRefNo": "string"
}
Previous
Reverse
Next
Notify
Built with