Cards API
  1. Actions
Cards API
  • Introduction
  • API Usage Instructions
  • Platform URL's
  • API Specification
  • Authentication
  • Steps to Generate a Secure Signature
  • Callback Parameters and Template
  • Merchant
    • Information
      GET
    • Program Details
      GET
  • Cards
    • KYC Requirements
    • Apply Card
      • Apply
      • Binding
    • Information
      • CardDetails
      • PinDetails
      • CardBalance
      • Single Card Transactions
      • All Cards Transactions
      • Countries
      • Towns
    • Top Up
      • Estimate Card TopUp Fee
      • TopUp
      • TopUp Status
    • Actions
      • Freeze
        POST
      • UnFreeze
        POST
      • Cancellation
        POST
      • SetPin
        POST
  • Webhooks
    • Callback notification
    • Kycstatus result callback notification
    • Createcard result callback notification
    • Recharge callback notification
    • Operation callback notification
    • Consume result callback notification
    • Fee callback notification
    • Refund callback notification
    • Bank card 3DS verification
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
    • Schemas
      • DigitalBank.CardsService.HyperPay.BindingRespDto
      • DigitalBank.CardsService.HyperPay.CardDetailResDto
      • DigitalBank.CardsService.HyperPay.customercards
      • DigitalBank.CardsService.Mesta.Address
      • DigitalBank.CardsService.Mesta.AddressesDto
      • DigitalBank.CardsService.Mesta.BeneficiaryEditDto
      • DigitalBank.CardsService.Mesta.DataDto
      • DigitalBank.CardsService.Mesta.DepositWalletAddress
      • DigitalBank.CardsService.Mesta.ExtendInfo
      • DigitalBank.CardsService.Mesta.Identity
      • DigitalBank.CardsService.Mesta.JsonListViewModel
      • DigitalBank.CardsService.Mesta.KycKybDto
      • DigitalBank.CardsService.Mesta.PaymentInfo
      • DigitalBank.CardsService.Mesta.SenderIdentityViewDto
      • DigitalBank.CardsService.Mesta.SenderViewDto
      • DigitalBank.CardsService.Mesta.UpdateSenderAddressesDto
      • DigitalBank.CardsService.Mesta.UpdateSenderDto
      • DigitalBank.CardsService.Mesta.WalletAddressResponseDto
      • DigitalBank.CardsService.Models.ApplyCard
      • DigitalBank.CardsService.Models.BalanceViewModel
      • DigitalBank.CardsService.Models.BindCard
      • DigitalBank.CardsService.Models.CountriesDto
      • DigitalBank.CardsService.Models.CustomerInformation
      • DigitalBank.CardsService.Models.KYC
      • DigitalBank.CardsService.Models.ProgramViewModel
      • DigitalBank.CardsService.Models.RechargeRequest
      • DigitalBank.CardsService.Models.RechargeResponse
      • DigitalBank.CardsService.Models.TownsDto
      • DigitalBank.CardsService.Payments.CreateBeneficiariesDto
      • DigitalBank.CardsService.Payments.CreateOrderDto
      • DigitalBank.CardsService.Payments.CreateQuoteDto
      • DigitalBank.CardsService.Payments.CreateSendersDto
      • DigitalBank.CardsService.Payments.PaymentReponseDto
      • DigitalBank.CardsService.Payments.QuoteReponseDto
      • DigitalBank.CardsService.Payments.UpdateWebhookDto
      • DigitalBank.CardsService.ProviderModels.EstimateTopupResponce
      • DigitalBank.CardsService.Samples.CardCancelReqDto
      • DigitalBank.CardsService.Samples.CardDetailRespDto
      • DigitalBank.CardsService.Samples.CardOperationResDto
      • DigitalBank.CardsService.Samples.CardReqDto
      • DigitalBank.CardsService.Samples.CardResponseDto
      • DigitalBank.CardsService.Samples.CardTopUpReqDto
      • DigitalBank.CardsService.Samples.CardTopUpResponseDto
      • DigitalBank.CardsService.Samples.EstimateCardTopUpFee
      • DigitalBank.CardsService.Samples.ReqAllTransactionsDto
      • DigitalBank.CardsService.Samples.ReqTransactionsDto
      • DigitalBank.CardsService.Samples.TransactionsDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ApplicationAuthConfigurationDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ApplicationConfigurationDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ApplicationFeatureConfigurationDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ApplicationGlobalFeatureConfigurationDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ApplicationLocalizationConfigurationDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ApplicationLocalizationDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ApplicationLocalizationResourceDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ApplicationSettingConfigurationDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ClockDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.CurrentCultureDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.CurrentUserDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.DateTimeFormatDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.IanaTimeZone
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.EntityExtensionDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.ExtensionEnumDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.ExtensionEnumFieldDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.ExtensionPropertyApiCreateDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.ExtensionPropertyApiDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.ExtensionPropertyApiGetDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.ExtensionPropertyApiUpdateDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.ExtensionPropertyAttributeDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.ExtensionPropertyDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.ExtensionPropertyUiDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.ExtensionPropertyUiFormDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.ExtensionPropertyUiLookupDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.ExtensionPropertyUiTableDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.LocalizableStringDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.ModuleExtensionDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.ObjectExtending.ObjectExtensionsDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.TimeZone
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.TimingDto
      • Volo.Abp.AspNetCore.Mvc.ApplicationConfigurations.WindowsTimeZone
      • Volo.Abp.AspNetCore.Mvc.MultiTenancy.CurrentTenantDto
      • Volo.Abp.AspNetCore.Mvc.MultiTenancy.MultiTenancyInfoDto
      • Volo.Abp.Http.Modeling.ActionApiDescriptionModel
      • Volo.Abp.Http.Modeling.ApplicationApiDescriptionModel
      • Volo.Abp.Http.Modeling.ControllerApiDescriptionModel
      • Volo.Abp.Http.Modeling.ControllerInterfaceApiDescriptionModel
      • Volo.Abp.Http.Modeling.InterfaceMethodApiDescriptionModel
      • Volo.Abp.Http.Modeling.MethodParameterApiDescriptionModel
      • Volo.Abp.Http.Modeling.ModuleApiDescriptionModel
      • Volo.Abp.Http.Modeling.ParameterApiDescriptionModel
      • Volo.Abp.Http.Modeling.PropertyApiDescriptionModel
      • Volo.Abp.Http.Modeling.ReturnValueApiDescriptionModel
      • Volo.Abp.Http.Modeling.TypeApiDescriptionModel
      • Volo.Abp.Http.RemoteServiceErrorInfo
      • Volo.Abp.Http.RemoteServiceErrorResponse
      • Volo.Abp.Http.RemoteServiceValidationErrorInfo
      • Volo.Abp.Localization.LanguageInfo
      • Volo.Abp.NameValue
  1. Actions

Freeze

POST
CardFreeze
Note
User signature photo Encoded into base64 format. It cannot be larger than 2M and supports the formats .png, .jpeg, and .jpg. It is only required when the card type represented by the bank card is needPhotoForOperateCard=true. See the parameter needPhotoForOperateCard in the interface /MerchantInformation/Merchant.

Request

Header Params

Body Params application/json

Example
{
    "cardId": "81e38cea-9ea7-4f84-819f-16a40ba1f466",
    "signImage": "signimage"
}

Responses

🟢200OK
text/plain
Success
Body

Example
{
    "taskId": "c9f691d9-178f-4f11-9040-9a81a513525a",
    "status": "Success",
    "remarks": "CardInProgress"
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
🔴501501
Modified at 2025-02-14 12:23:16
Previous
TopUp Status
Next
UnFreeze
Built with