API Reference Craftgate v1.0.42
modules
Modules
Elixir client for Craftgate, the one-stop shop payment gateway
Represents an adapter that can be used to interact with a group of related endpoints.
Provides capabilities to retrieve file-based reports such as daily transaction reports
Provides capabilities to retrieve potentially fraudulent transactions and marking them as safe, or managing fraud values for the fraud rules
Provides capabilities to retrieve information about BIN numbers and per-installment prices based on installment count
Provides capabilities to conduct CRUD operations on buyers and submerchants
Provides capabilities to manage and list products available for the pay-by-link feature
Provides capabilities to conduct payments, manage stored cards
Provides capabilities to search for payments, retrieve payment details, retrieve payment transaction records, etc.
Provides capabilities to initiate settlement operations like creating instant wallet settlements
Provides capabilities to retrieve information about settlement operations like searching for payout completed or bounced transactions
Provides capabilities to manage member wallets, search for wallet transactions, and send or receive remittance
Represents a set of configuration options for Craftgate
Allows modules to declare enumerations of certain values, with serialization/deserialization support.
Represents an error that was returned by Craftgate API
The module responsible for sending requests to Craftgate API
Elixir equivalent of the Java enum io.craftgate.model.AccountOwner
Elixir equivalent of the Java enum io.craftgate.model.AdditionalAction
Elixir equivalent of the Java enum io.craftgate.model.ApmAdditionalAction
Elixir equivalent of the Java enum io.craftgate.model.ApmType
Elixir equivalent of the Java enum io.craftgate.model.ApprovalStatus
Elixir equivalent of the Java enum io.craftgate.model.BounceStatus
Elixir equivalent of the Java enum io.craftgate.model.CardAssociation
Elixir equivalent of the Java enum io.craftgate.model.CardExpiryStatus
Elixir equivalent of the Java enum io.craftgate.model.CardType
Elixir equivalent of the Java enum io.craftgate.model.Currency
Elixir equivalent of the Java enum io.craftgate.model.FileStatus
Elixir equivalent of the Java enum io.craftgate.model.FraudAction
Elixir equivalent of the Java enum io.craftgate.model.FraudCheckStatus
Elixir equivalent of the Java data class io.craftgate.model.FraudValue
Elixir equivalent of the Java data class io.craftgate.model.Loyalty
Elixir equivalent of the Java enum io.craftgate.model.LoyaltyType
Elixir equivalent of the Java enum io.craftgate.model.MemberType
Elixir equivalent of the Java enum io.craftgate.model.MerchantType
Elixir equivalent of the Java enum io.craftgate.model.PaymentGroup
Elixir equivalent of the Java enum io.craftgate.model.PaymentMethod
Elixir equivalent of the Java enum io.craftgate.model.PaymentPhase
Elixir equivalent of the Java enum io.craftgate.model.PaymentProvider
Elixir equivalent of the Java enum io.craftgate.model.PaymentRefundStatus
Elixir equivalent of the Java enum io.craftgate.model.PaymentSource
Elixir equivalent of the Java enum io.craftgate.model.PaymentStatus
Elixir equivalent of the Java enum io.craftgate.model.PaymentType
Elixir equivalent of the Java enum io.craftgate.model.PayoutAccountType
Elixir equivalent of the Java enum io.craftgate.model.PosApmPaymentProvider
Elixir equivalent of the Java enum io.craftgate.model.RefundDestinationType
Elixir equivalent of the Java enum io.craftgate.model.RefundStatus
Elixir equivalent of the Java enum io.craftgate.model.RefundType
Elixir equivalent of the Java enum io.craftgate.model.RemittanceReasonType
Elixir equivalent of the Java enum io.craftgate.model.RemittanceType
Elixir equivalent of the Java enum io.craftgate.model.ReportFileType
Elixir equivalent of the Java data class io.craftgate.model.Reward
Elixir equivalent of the Java enum io.craftgate.model.SettlementEarningsDestination
Elixir equivalent of the Java enum io.craftgate.model.SettlementResultStatus
Elixir equivalent of the Java enum io.craftgate.model.SettlementSource
Elixir equivalent of the Java enum io.craftgate.model.SettlementType
Elixir equivalent of the Java enum io.craftgate.model.Status
Elixir equivalent of the Java enum io.craftgate.model.TransactionPayoutStatus
Elixir equivalent of the Java enum io.craftgate.model.TransactionStatus
Elixir equivalent of the Java enum io.craftgate.model.WalletTransactionRefundCardTransactionType
Elixir equivalent of the Java enum io.craftgate.model.WalletTransactionType
Elixir equivalent of the Java data class io.craftgate.model.WebhookData
Elixir equivalent of the Java enum io.craftgate.model.WebhookEventType
Elixir equivalent of the Java enum io.craftgate.model.WebhookStatus
Elixir equivalent of the Java data class io.craftgate.request.ApprovePaymentTransactionsRequest
Elixir equivalent of the Java data class io.craftgate.request.CheckMasterpassUserRequest
Elixir equivalent of the Java data class io.craftgate.request.CompleteApmPaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.CompletePosApmPaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.CompleteThreeDSPaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.CreateApmPaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.CreateDepositPaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.CreateFundTransferDepositPaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.CreateInstantWalletSettlementRequest
Elixir equivalent of the Java data class io.craftgate.request.CreateMemberRequest
Elixir equivalent of the Java data class io.craftgate.request.CreatePaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.CreatePayoutAccountRequest
Elixir equivalent of the Java data class io.craftgate.request.CreateProductRequest
Elixir equivalent of the Java data class io.craftgate.request.CreateRemittanceRequest
Elixir equivalent of the Java data class io.craftgate.request.CreateWalletRequest
Elixir equivalent of the Java data class io.craftgate.request.CreateWithdrawRequest
Elixir equivalent of the Java data class io.craftgate.request.DeleteStoredCardRequest
Elixir equivalent of the Java data class io.craftgate.request.DisapprovePaymentTransactionsRequest
Elixir equivalent of the Java data class io.craftgate.request.dto.Card
Elixir equivalent of the Java data class io.craftgate.request.dto.CustomInstallment
Elixir equivalent of the Java data class io.craftgate.request.dto.FraudCheckParameters
Elixir equivalent of the Java data class io.craftgate.request.dto.FraudPaymentData
Elixir equivalent of the Java data class io.craftgate.request.dto.GarantiPayInstallment
Elixir equivalent of the Java data class io.craftgate.request.dto.PaymentItem
Elixir equivalent of the Java data class io.craftgate.request.dto.PosApmInstallment
Elixir equivalent of the Java data class io.craftgate.request.FraudValueListRequest
Elixir equivalent of the Java data class io.craftgate.request.InitApmDepositPaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.InitApmPaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.InitCheckoutPaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.InitGarantiPayPaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.InitPosApmPaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.InitThreeDSPaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.PostAuthPaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.RefundPaymentRequest
Elixir equivalent of the Java data class io.craftgate.request.RefundPaymentTransactionRequest
Elixir equivalent of the Java data class io.craftgate.request.RefundWalletTransactionToCardRequest
Elixir equivalent of the Java data class io.craftgate.request.ResetMerchantMemberWalletBalanceRequest
Elixir equivalent of the Java data class io.craftgate.request.RetrieveDailyTransactionReportRequest
Elixir equivalent of the Java data class io.craftgate.request.RetrieveLoyaltiesRequest
Elixir equivalent of the Java data class io.craftgate.request.SearchFraudChecksRequest
Elixir equivalent of the Java data class io.craftgate.request.SearchInstallmentsRequest
Elixir equivalent of the Java data class io.craftgate.request.SearchMembersRequest
Elixir equivalent of the Java data class io.craftgate.request.SearchPaymentRefundsRequest
Elixir equivalent of the Java data class io.craftgate.request.SearchPaymentTransactionRefundsRequest
Elixir equivalent of the Java data class io.craftgate.request.SearchPaymentsRequest
Elixir equivalent of the Java data class io.craftgate.request.SearchPayoutAccountRequest
Elixir equivalent of the Java data class io.craftgate.request.SearchPayoutBouncedTransactionsRequest
Elixir equivalent of the Java data class io.craftgate.request.SearchPayoutCompletedTransactionsRequest
Elixir equivalent of the Java data class io.craftgate.request.SearchPayoutRowsRequest
Elixir equivalent of the Java data class io.craftgate.request.SearchProductsRequest
Elixir equivalent of the Java data class io.craftgate.request.SearchStoredCardsRequest
Elixir equivalent of the Java data class io.craftgate.request.SearchWalletTransactionsRequest
Elixir equivalent of the Java data class io.craftgate.request.SearchWithdrawsRequest
Elixir equivalent of the Java data class io.craftgate.request.StoreCardRequest
Elixir equivalent of the Java data class io.craftgate.request.UpdateCardRequest
Elixir equivalent of the Java data class io.craftgate.request.UpdateFraudCheckRequest
Elixir equivalent of the Java data class io.craftgate.request.UpdateMemberRequest
Elixir equivalent of the Java data class io.craftgate.request.UpdatePaymentTransactionRequest
Elixir equivalent of the Java data class io.craftgate.request.UpdatePayoutAccountRequest
Elixir equivalent of the Java data class io.craftgate.request.UpdateProductRequest
Elixir equivalent of the Java data class io.craftgate.request.UpdateWalletRequest
Elixir equivalent of the Java data class io.craftgate.response.ApmDepositPaymentResponse
Elixir equivalent of the Java data class io.craftgate.response.ApmPaymentCompleteResponse
Elixir equivalent of the Java data class io.craftgate.response.ApmPaymentInitResponse
Elixir equivalent of the Java data class io.craftgate.response.BinNumberResponse
Elixir equivalent of the Java data class io.craftgate.response.CheckMasterpassUserResponse
Elixir equivalent of the Java data class io.craftgate.response.CompletePosApmPaymentResponse
Elixir equivalent of the Java data class io.craftgate.response.DepositPaymentResponse
Elixir equivalent of the Java data class io.craftgate.response.dto.FraudCheck
Elixir equivalent of the Java data class io.craftgate.response.dto.Installment
Elixir equivalent of the Java data class io.craftgate.response.dto.InstallmentPrice
Elixir equivalent of the Java data class io.craftgate.response.dto.MerchantPos
Elixir equivalent of the Java data class io.craftgate.response.dto.PaymentError
Elixir equivalent of the Java data class io.craftgate.response.dto.PaymentTransaction
Elixir equivalent of the Java data class io.craftgate.response.dto.PaymentTransactionApproval
Elixir equivalent of the Java data class io.craftgate.response.dto.Payout
Elixir equivalent of the Java data class io.craftgate.response.dto.PayoutBouncedTransaction
Elixir equivalent of the Java data class io.craftgate.response.dto.PayoutCompletedTransaction
Elixir equivalent of the Java data class io.craftgate.response.dto.PayoutDetailTransaction
Elixir equivalent of the Java data class io.craftgate.response.dto.PayoutRow
Elixir equivalent of the Java data class io.craftgate.response.dto.PayoutStatus
Elixir equivalent of the Java data class io.craftgate.response.dto.ReportingPaymentTransaction
Elixir equivalent of the Java data class io.craftgate.response.dto.WalletTransaction
Elixir equivalent of the Java data class io.craftgate.response.FraudAllValueListsResponse
Elixir equivalent of the Java data class io.craftgate.response.FraudCheckListResponse
Elixir equivalent of the Java data class io.craftgate.response.FraudValueListResponse
Elixir equivalent of the Java data class io.craftgate.response.FundTransferDepositPaymentResponse
Elixir equivalent of the Java data class io.craftgate.response.InitCheckoutPaymentResponse
Elixir equivalent of the Java data class io.craftgate.response.InitGarantiPayPaymentResponse
Elixir equivalent of the Java data class io.craftgate.response.InitPosApmPaymentResponse
Elixir equivalent of the Java data class io.craftgate.response.InitThreeDSPaymentResponse
Elixir equivalent of the Java data class io.craftgate.response.InstallmentListResponse
Elixir equivalent of the Java data class io.craftgate.response.MemberListResponse
Elixir equivalent of the Java data class io.craftgate.response.MemberResponse
Elixir equivalent of the Java data class io.craftgate.response.PaymentRefundResponse
Elixir equivalent of the Java data class io.craftgate.response.PaymentResponse
Elixir equivalent of the Java data class io.craftgate.response.PaymentTransactionApprovalListResponse
Elixir equivalent of the Java data class io.craftgate.response.PaymentTransactionRefundResponse
Elixir equivalent of the Java data class io.craftgate.response.PaymentTransactionResponse
Elixir equivalent of the Java data class io.craftgate.response.PayoutAccountListResponse
Elixir equivalent of the Java data class io.craftgate.response.PayoutAccountResponse
Elixir equivalent of the Java data class io.craftgate.response.PayoutBouncedTransactionListResponse
Elixir equivalent of the Java data class io.craftgate.response.PayoutCompletedTransactionListResponse
Elixir equivalent of the Java data class io.craftgate.response.PayoutDetailResponse
Elixir equivalent of the Java data class io.craftgate.response.PayoutRowListResponse
Elixir equivalent of the Java data class io.craftgate.response.ProductListResponse
Elixir equivalent of the Java data class io.craftgate.response.ProductResponse
Elixir equivalent of the Java data class io.craftgate.response.RefundWalletTransactionListResponse
Elixir equivalent of the Java data class io.craftgate.response.RefundWalletTransactionResponse
Elixir equivalent of the Java data class io.craftgate.response.RemittanceResponse
Elixir equivalent of the Java data class io.craftgate.response.ReportingPaymentListResponse
Elixir equivalent of the Java data class io.craftgate.response.ReportingPaymentRefundListResponse
Elixir equivalent of the Java data class io.craftgate.response.ReportingPaymentRefundResponse
Elixir equivalent of the Java data class io.craftgate.response.ReportingPaymentResponse
Elixir equivalent of the Java data class io.craftgate.response.ReportingPaymentTransactionListResponse
Elixir equivalent of the Java data class io.craftgate.response.ReportingPaymentTransactionRefundListResponse
Elixir equivalent of the Java data class io.craftgate.response.ReportingPaymentTransactionRefundResponse
Elixir equivalent of the Java data class io.craftgate.response.RetrieveLoyaltiesResponse
Elixir equivalent of the Java data class io.craftgate.response.SettlementResponse
Elixir equivalent of the Java data class io.craftgate.response.StoredCardListResponse
Elixir equivalent of the Java data class io.craftgate.response.StoredCardResponse
Elixir equivalent of the Java data class io.craftgate.response.WalletResponse
Elixir equivalent of the Java data class io.craftgate.response.WalletTransactionListResponse
Elixir equivalent of the Java data class io.craftgate.response.WalletTransactionRefundableAmountResponse
Elixir equivalent of the Java data class io.craftgate.response.WalletTransactionResponse
Elixir equivalent of the Java data class io.craftgate.response.WithdrawListResponse
Elixir equivalent of the Java data class io.craftgate.response.WithdrawResponse
The module that contains macros to declare typed structs that can be serialized and deserialized easily and in a recursive fashion, and has the necessary typespecs declared for developer assistance and compile-time type checking for Dialyzer.
mix-tasks
Mix Tasks
Creates a payment using the credentials at Mix.TaskHelper.set_sample_config/0