Payantis Platform
Payantis.
Payantis.
  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 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
      • Create Merchant
      • Get Merchant
      • List Merchants
      • Update Merchant
      • Delete Merchant
      • Upsert Contact
      • Upsert Identity
      • Upsert Address
      • Delete Contact
      • Delete Identity
      • Upsert Address
      • Get Merchant Terminals
      • Create User Note
      • Get User Notes
      • Get Transactions
    • 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

Balance Inquiry

POST
balance-inquiry
Balance Inquiry endpoint’i, bir kartın veya karta bağlı hesabın mevcut bakiyesinin, işlem bağlamı dikkate alınarak Kurum (Core Banking / Wallet / Ledger) sistemleri üzerinden gerçek zamanlı olarak sorgulanması amacıyla kullanılır.
Bu endpoint, bakiye yönetiminin Kurum tarafında yapıldığı durumlarda Payantis’in bakiye bilgisini sorgulayabilmesi için temel bir entegrasyon noktasıdır. Payantis, bu endpointi çağırarak Kurum’dan yetkili ve güncel bakiye bilgisini alır. Kurum, kendi sistemlerindeki bakiye, kısıt ve ürün kurallarını uygulayarak sonucu Payantis’e iletir.

Bakiye Sorgulama İşlemlerinde Ücret#

Bakiye sorgulama işlemlerinde ücret, iki aşamalı bir akış ile yürütülmektedir.
1
Ücret Sorgulama
Kart hamili bakiye sorgulama talebini başlattığında, henüz bakiye bilgisi sorgulanmadan yalnızca uygulanacak bakiye sorgulama ücreti Payantis veya Kurum tarafından hesaplanarak kullanıcıya gösterilir. Ücret kurum tarafından hesaplanıyorsa:
Payantis ücret bilgisini almak için Kurum'un sağladığı Auhtorization endpointini çağırır, bu çağrım sırasında transactionType parametresi FeeInquiry_BalanceInquiry olarak iletilir ve Auhtorization endpointi ücret bilgisini döner
2
Bakiye Sorgulama
Kart hamili ücreti onayladığında, Payantis alınacak ücret bilgisi ile birlikte Balance Inquiry enpointini çağırır. Ücret bilgisi request'teki billingAmount alanında yer alır, ayrıca ücret detayları da additionalAmounts alanında yer alır. Kurum bakiye sorgulama ücretini tahsil eder ve bakiye bilgisini Payantis'a döner. Böylece kart hamili bakiye sorgulama işlemini gerçekleştirmiş olur.

Request

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Response Response Example
{
  "ResponseCode": "00",
  "ResponseDescription": "Approved",
  "TenantReferenceNo": "TENANT12345",
  "Balance": 500.00,
  "Currency": 949,
  "AdditionalAmounts": [
    {
      "Id": "ADDITIONAL1",
      "AdditionalAmountType": "TransactionFee",
      "Amount": 2.00,
      "Currency": 949
    }
  ]
}
Previous
Auth Refresh
Next
Authorization
Built with