Payantis Platform
Payantis.
Payantis.
  1. Kurum Real-Time API
  • Payantis Platform
    • Payantis Platform
    • API Kullanımı
    • Temel Kavramlar
    • Kural Motoru
  • Issuing API
    • Payantis Issuing
    • Adım Adım Issuing API
    • 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
      • 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
    • 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 a Transaction Fee
        • This API is used to link transaction fee.
        • This API is used to fetch linked transaction fee list.
        • Unlink a Transaction Fee
      • Card Issuance Fee
        • Creates a new Card Issuance Fee
        • Updates a Card Issuance Fee
        • Get a Card Issuance Fee detail
        • /api/v1/issuing/fee-management/card-issuance
        • Delete a Card Issuance Fee
        • This API is used to link card issuance fee.
        • This API is used to fetch linked card issuance fee list.
        • Unlink a card issuance Fee
      • Card Annual Fee
        • Creates a new Card Annual Fee
        • /api/v1/issuing/fee-management/card-annual
        • Updates a Card Annual Fee
        • Get a Card Annual Fee detail
        • Delete a Card Annual Fee
        • This API is used to link card annual fee.
        • This API is used to fetch linked card annual fee list.
        • Unlink a card annual Fee
    • WebHook
      • Register
      • Get Registered Webhooks
      • Unregister
      • Update
    • Authorization Controls
      • Create Authorization Control
      • Update Authorization Control
      • Link
      • Unlink
      • Get Authorization Controls
      • Get Links
      • Delete Authorization Control
    • AuditLog
      • Get Card Audits
      • Get Product Audits
      • Get Policy Audits
    • Schemas
      • AuditLogCardListItemDto
      • CardPhysicalDto
      • AuditLogPolicyListItemDto
      • AuditLogProductListItemDto
      • 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
      • CardParentDto
      • 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
      • LinkCustomerDto
      • 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<AuditLogCardListItemDto>
      • PagedResultDto<AuditLogPolicyListItemDto>
      • PagedResultDto<AuditLogProductListItemDto>
      • 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
      • AdditionalAmountDto
      • BalanceInquiryRequestDto
      • AccountDetailDto
      • AuthorizationRequestDto
      • OriginalDetailDto
      • RefundRequestDto
      • ReversalRequestDto
      • BaseResponseDto
      • BalanceInformationDto
      • AuthorizationResponseDto
      • BalanceInquiryResponseDto
      • RefundResponseDto
      • ReversalResponseDto
      • 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
    • Merchant
      • /api/v1/acquiring/merchant
      • /api/v1/acquiring/merchant
      • /api/v1/acquiring/merchant/list
      • /api/v1/acquiring/merchant/{code}
      • /api/v1/acquiring/merchant/{code}
      • /api/v1/acquiring/merchant/contacts/upsert
      • /api/v1/acquiring/merchant/identities/upsert
      • /api/v1/acquiring/merchant/addresses/upsert
      • /api/v1/acquiring/merchant/contact/delete
      • /api/v1/acquiring/merchant/identity/delete
      • /api/v1/acquiring/merchant/address/delete
      • /api/v1/acquiring/merchant/get-terminals
      • /api/v1/acquiring/merchant/user-note
      • /api/v1/acquiring/merchant/user-note
    • MerchantTransaction
      • /api/v1/acquiring-transaction/merchant-transaction
    • Terminal
      • /api/v1/acquiring/terminal
      • /api/v1/acquiring/terminal
      • /api/v1/acquiring/terminal/list
      • /api/v1/acquiring/terminal/{terminalCode}
      • /api/v1/acquiring/terminal/{terminalCode}
      • /api/v1/acquiring/terminal/change-terminal-allowed-currencies
    • AuthTemplate
      • /api/v1/acquiring/auth-template
      • /api/v1/acquiring/auth-template/{authTemplateCode}
      • /api/v1/acquiring/auth-template/{authTemplateCode}
      • /api/v1/acquiring/auth-template/{authTemplateCode}
      • /api/v1/acquiring/auth-template/list
    • Batch
      • /api/v1/acquiring/batch
      • /api/v1/acquiring/batch/list
      • /api/v1/acquiring/batch/update-batch-status
    • EodMessageTemplate
      • /api/v1/acquiring/eod-message-template
      • /api/v1/acquiring/eod-message-template/{eodTemplateCode}
      • /api/v1/acquiring/eod-message-template/{eodTemplateCode}
      • /api/v1/acquiring/eod-message-template/{eodTemplateCode}
      • /api/v1/acquiring/eod-message-template/list
    • Schemas
      • Payantis.Acquiring.Merchant.AuthTemplateResponseDto
      • Payantis.Acquiring.Merchant.BatchCurrencySummaryDto
      • Payantis.Acquiring.Merchant.BatchDto
      • Payantis.Acquiring.Merchant.ChangeTerminalAllowedCurrenciesDto
      • Payantis.Acquiring.Merchant.CreateAuthTemplateDto
      • Payantis.Acquiring.Merchant.CreateEodMessageTemplateDto
      • Payantis.Acquiring.Merchant.CreateMerchantAddressDto
      • Payantis.Acquiring.Merchant.CreateMerchantContactDto
      • Payantis.Acquiring.Merchant.CreateMerchantDto
      • Payantis.Acquiring.Merchant.CreateMerchantIdentityDto
      • Payantis.Acquiring.Merchant.CreateTerminalDto
      • Payantis.Acquiring.Merchant.EodMessageTemplateDto
      • Payantis.Acquiring.Merchant.EodMessageTemplateResponseDto
      • Payantis.Acquiring.Merchant.MerchantAddressDto
      • Payantis.Acquiring.Merchant.MerchantBasicDto
      • Payantis.Acquiring.Merchant.MerchantContactDto
      • Payantis.Acquiring.Merchant.MerchantDto
      • Payantis.Acquiring.Merchant.MerchantEcommerceDetailsDto
      • Payantis.Acquiring.Merchant.MerchantIdentityDto
      • Payantis.Acquiring.Merchant.MerchantQrDetailsDto
      • Payantis.Acquiring.Merchant.PhysicalTerminalDeviceDto
      • Payantis.Acquiring.Merchant.TerminalDto
      • Payantis.Acquiring.Merchant.TerminalInfoDto
      • Payantis.Acquiring.Merchant.TerminalResponseDto
      • Payantis.Acquiring.Merchant.UpdateAuthTemplateDto
      • Payantis.Acquiring.Merchant.UpdateBatchStatusDto
      • Payantis.Acquiring.Merchant.UpdateEodMessageTemplateDto
      • Payantis.Acquiring.Merchant.UpdateMerchantDto
      • Payantis.Acquiring.Merchant.UpdateTerminalDto
      • Payantis.Acquiring.Merchant.UpsertMerchantAddressDto
      • Payantis.Acquiring.Merchant.UpsertMerchantContactDto
      • Payantis.Acquiring.Merchant.UpsertMerchantIdentityDto
      • Payantis.SystemParameter.Dto.AdditionalAmountDto
      • Payantis.SystemParameter.Dto.Request.CreateNoteEntityTypeDto
      • Payantis.SystemParameter.Dto.Response.NoteResponseDto
      • Payantis.SystemParameter.Dto.TaxDto
      • Payantis.Transaction.Acquiring.Backend.MerchantTransactionResponseDto
      • Payantis.Transaction.Issuing.Backend.CardTransactionResponseDto
      • 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.TerminalDto>
      • Volo.Abp.Application.Dtos.PagedResultDto<Payantis.SystemParameter.Dto.Response.NoteResponseDto>
      • Volo.Abp.Application.Dtos.PagedResultDto<Payantis.Transaction.Acquiring.Backend.MerchantTransactionResponseDto>
      • Volo.Abp.Application.Dtos.PagedResultDto<Payantis.Transaction.Issuing.Backend.CardTransactionResponseDto>
  • Auth API
    • Get Token
    • Refresh Token
Payantis.
Payantis.
  1. Kurum Real-Time API

Authorization

POST
/api/v1/authorization
Payantis Platform üzerinde gerçekleşen bir kart işleminin finansal olarak onaylanıp onaylanmayacağına karar verilmesi amacıyla kullanılır. Bu endpoint, bakiye ve hesap yönetiminin Kurum (Core Banking / Wallet / Ledger sistemi) tarafında tutulduğu durumda çağrılır.
Payantis, karttan gelen bir işlemi (POS, ATM, E-Commerce, QR vb.) değerlendirirken, işlemin nihai kararını verebilmek için Kurum’a bu endpoint üzerinden danışır. Kurum, kendi sistemlerindeki bakiye, limit, kısıt, ürün ve güvenlik kurallarını uygulayarak işlemi onaylar (approve) veya reddeder (decline).
Bu nedenle Authorization endpoint’i, Payantis ile Kurum arasındaki entegrasyonda en kritik karar noktasıdır.
Authorization endpoint’inden şu şekilde çalışması beklenir:
1
İşlem bağlamını alır
Payantis tarafından iletilen bilgiler sayesinde işlem;
hangi kart/token için üzerinden,
hangi tutarda ve para biriminde,
hangi kanal ve terminal türünde,
hangi ağ (BKM, Visa, Mastercard vb.)
gerçekleşiyor bilgileriyle Kurum’a iletilir.
2
Bakiye ve hesap uygunluğunu değerlendirir
Kurum, kartın bağlı olduğu hesapta:
yeterli bakiye olup olmadığını,
hesabın/kartın blokeli, kapalı veya kısıtlı olup olmadığını,
ürün bazlı kural ihlali bulunup bulunmadığını
kontrol eder.
3
Limit ve kural kontrollerini uygular (varsa)
İşlem tutarı, işlem sayısı, kanal bazlı limitler veya Kurum’un tanımladığı diğer kurallar değerlendirilir. Gerekirse işlem limit aşıldı gerekçesiyle reddedilebilir.
4
Ek tutarları hesaplayabilir
Kurum isterse;
işlem ücreti,
komisyon veya benzeri kalemleri
AdditionalAmounts üzerinden hesaplayarak Payantis’e geri dönebilir.
5
Sonuç üretir
Tüm değerlendirmeler sonucunda Kurum:
işlemi onaylar veya
belirli bir gerekçe ile reddeder
Bu karar, ResponseCode alanı ile Payantis’e iletilir. Payantis de bu koda göre işlemi kart ağına ve üst sistemlere yansıtır.
📌
Sonuç kodlarının şu şekilde olması beklenir:
00 veya 0: İşlem başarılı, onay.
05: Hesap uygun statüde değil, blokeli, kapalı vb, red.
51: Hesap bakiyesi yetersiz, red.
57: İşleme izin verilmiyor, red.
61: İşlem limitleri aşıldı, red.
62: Hesap bu işlem için kısıtlanmış, red.
96: Beklenmedik sistem hatası, red.
💡
Authorization endpoint’ine gönderilen parametreler, yalnızca teknik veri değil; iş kararını etkileyen bağlamsal bilgilerdir:
İşlem Anahtarları
CorrelationId ve TransactionId, işlemin izlenmesi ve sonradan mutabakat/audit yapılabilmesi için kullanılır.
Kart ve Hesap Bağlantısı
TokenId, işlemin hangi kart/hesap için yapıldığını belirtir ve Kurum’un kendi sistemindeki karşılığı bulmasını sağlar.
Finansal Alanlar
TransactionAmount, TransactionCurrency, BillingAmount, BillingCurrency gibi alanlar, bakiye ve muhasebe etkisini belirler.
İşlem Bağlamı
TerminalType, TransactionNetwork, PosEntryMode, TransactionDomain gibi alanlar, işlemin nerede ve nasıl gerçekleştiğini gösterir ve Kurum’un kural setlerini doğru uygulamasını sağlar.
Güvenlik ve Doğrulama
SecurityLevelIndicator ve CvmType, işlemin risk seviyesini belirlemede kullanılır.
QR ve Hesap Bazlı İşlemler
QrData, QrRefNo ve AccountDetail, özellikle QR veya hesap bazlı ödeme senaryolarında kullanılır.
💡
BKM regülasyonları kapsamında KYS (Karekod Yönetim Sistemi) bağlantısının kurulması ve yönetilmesi Kurumun sorumluluğundadır. QRData, Acquirer tarafından üretilen ve işlem öncesinde Kuruma iletilmiş olan bir QR verisidir.
Bu nedenle QR işlemlerinde, ilgili QR’ın kullanılabilirliğinin (geçerlilik, durum, süre vb.) kontrolü Kurum tarafından yapılmalıdır. İşlem başarıyla tamamlandıktan sonra QR “kullanılmış” olarak işaretlenmeli ve tekrar kullanımına izin verilmemelidir.
Ayrıca QR ile gerçekleştirilen bir işleme ilişkin Reversal mesajı gelmesi durumunda, QR’ın kullanım durumu Kurum tarafından uygun şekilde geri alınmalı ve statüsü güncellenmelidir.

Request

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

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
Balance Inquiry
Next
Reverse
Built with