PokepayAPI class

Available extensions

• AccountAPI
• AccountAPI
• BillAPI
• CashtrayAPI
• CheckAPI
• CreditCardAPI
• MessageAPI
• PrivateMoney
• TerminalAPI
• TransactionAPI
• UserAPI

Constructors

PokepayAPI({required String accessToken, required APIEnv env})

Properties

accessToken → String

final

env → APIEnv

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addTerminalPublicKey({required String key}) → Future<ServerKey>

Available on PokepayAPI, provided by the TerminalAPI extension

bankpayTopUp({required String id, required String accountId, required String bankId, required String amount, String? requestId}) → Future<UserTransaction>

Available on PokepayAPI, provided by the UserAPI extension

cancelUserTransaction({required String id}) → Future<NoContent>

Available on PokepayAPI, provided by the TransactionAPI extension

createAccount({String? name, required String privateMoneyId, String? externalId}) → Future<Account>

Available on PokepayAPI, provided by the AccountAPI extension

createAccountCpmToken({required String accountId, required CpmTokenScope scopes, int? expiresIn, Map<String, String>? metadata}) → Future<AccountCpmToken>

Available on PokepayAPI, provided by the AccountAPI extension

createBankPay({required String id, required String callbackUrl, required String privateMoneyId, String? kana}) → Future<BankPayRedirectUrl>

Available on PokepayAPI, provided by the UserAPI extension

createBill({double? amount, String? accountId, String? description, bool isOnetime = false, List<Product>? products}) → Future<Bill>

Available on PokepayAPI, provided by the BillAPI extension

createCashtray({required double amount, String? description, int? expiresIn, List<Product>? products}) → Future<Cashtray>

Available on PokepayAPI, provided by the CashtrayAPI extension

createCheck({double? amount, double? moneyAmount, double? pointAmount, String? accountId, String? description, bool? isOnetime = true, int? usageLimit, DateTime? expiresAt, DateTime? pointExpiresAt, int? pointExpiresInDays}) → Future<Check>

Available on PokepayAPI, provided by the CheckAPI extension

createCreditCard({required String token, bool? isCardholderNameSpecified, required String organizationCode, required String userId}) → Future<CreditCard>

Available on PokepayAPI, provided by the CreditCardAPI extension

createUserTransactionWithBill({required String billId, String? accountId, double? amount, String? couponId, TransactionStrategy strategy = TransactionStrategy.POINT_PREFERRED, String? requestId}) → Future<UserTransaction>

Available on PokepayAPI, provided by the TransactionAPI extension

createUserTransactionWithCashtray({required String cashtrayId, String? accountId, String? couponId, TransactionStrategy strategy = TransactionStrategy.POINT_PREFERRED, String? requestId}) → Future<UserTransaction>

Available on PokepayAPI, provided by the TransactionAPI extension

createUserTransactionWithCheck({required String checkId, String? accountId, String? requestId}) → Future<UserTransaction>

Available on PokepayAPI, provided by the TransactionAPI extension

createUserTransactionWithCpm({required String cpmToken, String? accountId, required double amount, List<Product>? products, String? requestId}) → Future<UserTransaction>

Available on PokepayAPI, provided by the TransactionAPI extension

createUserTransactionWithJwt({required String data, String? accountId, String? couponId, TransactionStrategy strategy = TransactionStrategy.POINT_PREFERRED}) → Future<JwtResult>

Available on PokepayAPI, provided by the TransactionAPI extension

deleteBankPay({required String id, required String bankId}) → Future<NoContent>

Available on PokepayAPI, provided by the UserAPI extension

deleteBill({required String id}) → Future<NoContent>

Available on PokepayAPI, provided by the BillAPI extension

deleteCashtray({required String id}) → Future<NoContent>

Available on PokepayAPI, provided by the CashtrayAPI extension

deleteCheck({required String id}) → Future<NoContent>

Available on PokepayAPI, provided by the CheckAPI extension

deleteCreditCard({String? cardRegisteredAt, String? cardUuid, required String organizationCode, required String userId}) → Future<NoContent>

Available on PokepayAPI, provided by the CreditCardAPI extension

deleteUserEmail({required String id, required String email}) → Future<NoContent>

Available on PokepayAPI, provided by the UserAPI extension

getAccount({required String id}) → Future<Account>

Available on PokepayAPI, provided by the AccountAPI extension

getAccountBalances({required String id, String? before, String? after, int? perPage}) → Future<PaginatedAccountBalances>

Available on PokepayAPI, provided by the AccountAPI extension

getAccountCampaignPointAmounts({required String accountId, required String campaignId}) → Future<AccountCampaignPointAmounts>

Available on PokepayAPI, provided by the AccountAPI extension

getAccountCouponDetail({required String accountId, required String couponId}) → Future<CouponDetail>

Available on PokepayAPI, provided by the AccountAPI extension

getAccountCoupons({required String accountId, bool isAvailable = true, String? before, String? after, int? perPage}) → Future<PaginatedCoupons>

Available on PokepayAPI, provided by the AccountAPI extension

getAccountTopupStats({required String accountId}) → Future<AccountTopupStats>

Available on PokepayAPI, provided by the AccountAPI extension

getAccountTransactions({required String id, String? before, String? after, int? perPage}) → Future<PaginatedTransactions>

Available on PokepayAPI, provided by the AccountAPI extension

getBankPay({required String id, String? privateMoneyId}) → Future<List<BankPay>>

Available on PokepayAPI, provided by the UserAPI extension

getBill({required String id}) → Future<Bill>

Available on PokepayAPI, provided by the BillAPI extension

getCashtray({required String id}) → Future<Cashtray>

Available on PokepayAPI, provided by the CashtrayAPI extension

getCashtrayAttempts({required String id}) → Future<CashtrayAttempts>

Available on PokepayAPI, provided by the CashtrayAPI extension

getCheck({required String id}) → Future<Check>

Available on PokepayAPI, provided by the CheckAPI extension

getCpmToken({required String cpmToken}) → Future<AccountCpmToken>

Available on PokepayAPI, provided by the AccountAPI extension

getCreditCards({required String userId, String? before, String? after, int? perPage, required String organizationCode}) → Future<PaginatedCreditCards>

Available on PokepayAPI, provided by the CreditCardAPI extension

getMessage({required String id}) → Future<Message>

Available on PokepayAPI, provided by the MessageAPI extension

getMessageUnreadCount() → Future<MessageUnreadCount>

Available on PokepayAPI, provided by the MessageAPI extension

getPrivateMoney({required String privateMoneyId}) → Future<PrivateMoney>

Available on PokepayAPI, provided by the PrivateMoney extension

getPrivateMoneyCoupons({required String privateMoneyId, String? before, String? after, int? perPage}) → Future<PaginatedCoupons>

Available on PokepayAPI, provided by the PrivateMoney extension

getTerminal() → Future<Terminal>

Available on PokepayAPI, provided by the TerminalAPI extension

getTransactionByRequestId({required String requestId}) → Future<UserTransactionWithTransfers>

Available on PokepayAPI, provided by the TransactionAPI extension

getUserAccounts({required String id, String? before, String? after, int? perPage}) → Future<PaginatedAccounts>

Available on PokepayAPI, provided by the UserAPI extension

getUserTransaction({required String id}) → Future<UserTransaction>

Available on PokepayAPI, provided by the TransactionAPI extension

getUserTransactions({required String id, String? before, String? after, int? perPage}) → Future<PaginatedTransactions>

Available on PokepayAPI, provided by the UserAPI extension

getUserWithAuthFactors({required String userId}) → Future<UserWithAuthFactors>

Available on PokepayAPI, provided by the UserAPI extension

identifyIndividual({required String accountId, required String signature, required String signingCert, required String expectedHash, String? name, Gender? gender, String? address, String? dateOfBirth}) → Future<IdentificationResult>

Available on PokepayAPI, provided by the AccountAPI extension

listMessages({String? before, String? after, int? perPage}) → Future<PaginatedMessages>

Available on PokepayAPI, provided by the MessageAPI extension

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patchAccountCouponDetail({required String accountId, required String couponId, required bool isReceived}) → Future<CouponDetail>

Available on PokepayAPI, provided by the AccountAPI extension

receiveMessageAttachment({required String id}) → Future<MessageAttachment>

Available on PokepayAPI, provided by the MessageAPI extension

registerUserEmail({required String token}) → Future<NoContent>

Available on PokepayAPI, provided by the UserAPI extension

searchPrivateMoneys({String? name, bool includeExclusive = false, String? before, String? after, int? perPage}) → Future<PaginatedPrivateMoneys>

Available on PokepayAPI, provided by the PrivateMoney extension

sendConfirmationEmail({required String id, required String email}) → Future<NoContent>

Available on PokepayAPI, provided by the UserAPI extension

sendMessage({required String toUserId, double? amount, required String subject, required String body, required User sender, String? fromAccountId}) → Future<Message>

Available on PokepayAPI, provided by the MessageAPI extension

sendToAccount({required String accountId, required double amount, String? receiverTerminalId, String? senderAccountId, String? description}) → Future<UserTransaction>

Available on PokepayAPI, provided by the TransactionAPI extension

sendToUser({required String userId, required double amount, String? receiverTerminalId, String? senderAccountId, String? description}) → Future<UserTransaction>

Available on PokepayAPI, provided by the TransactionAPI extension

TopupWithCreditCardMdkToken({required String userId, required String token, required String accountId, required int amount, required String organizationCode, bool? isCardholderNameSpecified, String? requestId, int? topupQuotaId}) → Future<String>

Available on PokepayAPI, provided by the CreditCardAPI extension

TopupWithCreditCardMembership({required String userId, String? cardRegisteredAt, String? cardUuid, required String accountId, required int amount, bool? deleteCardIfAuthFail, required String organizationCode, String? requestId, int? topupQuotaId}) → Future<String>

Available on PokepayAPI, provided by the CreditCardAPI extension

toString() → String

A string representation of this object.

inherited

updateBill({required String id, double? amount, String? description}) → Future<Bill>

Available on PokepayAPI, provided by the BillAPI extension

updateCashtray({required String id, double? amount, String? description, int? expiresIn}) → Future<Cashtray>

Available on PokepayAPI, provided by the CashtrayAPI extension

updateCheck({required String id, double? amount, String? description, required DateTime expiresAt, required DateTime pointExpiresAt, int? pointExpiresInDays}) → Future<Check>

Available on PokepayAPI, provided by the CheckAPI extension

updateTerminal({required String accountId, required String name, String? pushToken}) → Future<Terminal>

Available on PokepayAPI, provided by the TerminalAPI extension

updateUser({required String id, String? name}) → Future<User>

Available on PokepayAPI, provided by the UserAPI extension

Operators

operator ==(Object other) → bool

The equality operator.

inherited