Payantis Platform
v2 - latest
  • v2 - latest
  • v1
v2 - latest
  • v2 - latest
  • v1
v2 - latest
  • v2 - latest
  • v1
  1. Kurum Finansal Entegrasyon
  • 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
      • Auth Refresh
      • Balance Inquiry
      • Authorization
      • Reverse
      • Refund
      • Notify
    • 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
      POST
    • Generate Pin Block
      POST
    • Extract Clear Pin
      POST
    • Process Transaction
      POST
    • Void Transaction
      POST
    • Refund Transaction
      POST
    • 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 Finansal Entegrasyon

Kurum Real-Time API

Kurum Real-Time API’leri, Payantis Platform ile Kurum’un core banking / cüzdan / muhasebe sistemleri arasında gerçek zamanlı (real-time) entegrasyonu sağlar. Bu API’ler, özellikle bakiye yönetimi ve finansal karar otoritesinin Kurum tarafında olduğu mimariler için tasarlanmıştır.
Payantis, kart ağları (BKM, Visa, Mastercard vb.) ile işlem yönetimini ve yönlendirmeyi üstlenirken; Kurum, bu API’ler aracılığıyla bakiye, limit, kısıt, muhasebe ve müşteri iletişimi gibi kritik işlevleri kendi sistemleri üzerinden yürütür. Böylece finansal kontrol ve müşteri ilişkileri Kurum tarafında kalır, Payantis ise entegrasyon ve işlem orkestrasyonunu sağlar.
Bu API’ler senkron çalışır ve Payantis’in işlem sırasında veya işlem sonrasında anlık karar alabilmesi için kullanılır.

API Kapsamı#

Kurum'un sağladığı Real-Time API’ler aşağıdaki temel fonksiyonları sağlar.
APIBeklenen Fonksiyon
AuthenticateKullanıcı adı ve şifre ile sisteme login olarak token alma
Auth RefreshToken süresi bitiminde refresh ederek token suresi uzatma
Balance InquiryKart işlemleri öncesinde ve sırasında bakiye ve uygunluk kontrolü
Authorizationİşlemler için yetkilendirme (authorization) kararının Kurum tarafından verilmesi
ReverseTeknik nedenlerle hatalı alan ya da yarım kalan veya kart hamili tarafından iptal edilmek istenen işlemler için reversal (iptal) süreçlerinin yürütülmesi
RefundTamamlanmış işlemler için sonradan yapılan refund (iade) yönetimi
NotifyKurumun kendi müşterilerine yönelik bildirimlerin (özellikle kart şifresi (PIN) ) güvenli şekilde gönderilmesi
Bu API’ler sayesinde, Payantis ile Kurum arasında tekil ve tutarlı bir finansal entegrasyon sağlanır.
Kurumun sağlayacağı API'lerde Base Url ve Resource Path'in isimlendirilmesi kurum tarafından belirlenir, Operation Name ise standardtır ve Payantis'in beklediği şekilde oluşturulmalıdır.
Kurum tarafından Login (Authenticate ve Auth Refresh) ve diğer işlemler için 2 ayrı Base Url+Resource Path tanımı verilebilir.

Genel Çalışma Prensibi#

Payantis, kart hamili bir işlem yaptığında işlem ile ilgili temel kontrolleri (güvenlik, yetki, harcama limiti, vb) yapar.
Payantis, bakiye ve kurum politikalarının kontrol edilebilmesi için ilgili real-time API’yi çağırır.
Kurum, kendi iş kuralları ve sistem durumuna göre:
işlemi onaylar veya reddeder,
finansal etkiyi uygular veya geri alır,
gerekli durumlarda müşteriye bildirim gönderir.
Tüm yanıtlar, Payantis’in kart ağları ve üst sistemlerle olan iletişimini yönlendirmesi için standart response code yapısı ile döner.
Bu yapı, yüksek hacimli ve düşük gecikmeli kart işlem akışları için optimize edilmiştir.

Güvenlik ve Sorumluluk Modeli#

Hassas bilgiler (PIN, kart şifresi vb.) Payantis tarafından şifreli (encrypted) olarak Kurum’a iletilir. Şifreleme ve çözme işlemleri için konusunda detaylar bu bölümde anlatılmaktadır.
Bu veriler yalnızca Kurum tarafından, kendi güvenli altyapısı (Anahtar yönetimi vb.) içinde çözülür ve müşteriye iletilir.
Payantis, müşteriyle doğrudan iletişime geçmez; müşteri iletişimi ve yasal sorumluluk Kurum tarafındadır.
Bu yaklaşım, güvenlik, mevzuat ve operasyonel sorumlulukların doğru tarafta kalmasını sağlar.
Previous
Expire Dosyası Alanları
Next
Authenticate
Built with