api.md

LegalEntity

Types:

• PaginationResponse
• LegalEntityListResponse

Methods:

• client.legalEntity.list() -> LegalEntityListResponse

Account

Types:

• Account
• AccountListResponse
• AccountRetrieveBalanceResponse

Methods:

• client.account.retrieve(accountID) -> Account
• client.account.list({ ...params }) -> AccountListResponse
• client.account.retrieveBalance(accountID) -> AccountRetrieveBalanceResponse

VirtualAccount

Types:

• CommissionDetails
• CommissionRule
• Money
• VirtualAccount
• VirtualAccountModel
• VirtualAccountCreateResponse
• VirtualAccountUpdateResponse
• VirtualAccountListResponse

Methods:

• client.virtualAccount.create({ ...params }) -> VirtualAccountCreateResponse
• client.virtualAccount.retrieve(virtualAccountID) -> VirtualAccount
• client.virtualAccount.update(virtualAccountID, { ...params }) -> VirtualAccountUpdateResponse
• client.virtualAccount.list({ ...params }) -> VirtualAccountListResponse

Transaction

Types:

• Transaction
• TransactionListResponse
• TransactionAggregateResponse
• TransactionRetrieveFeeDetailsResponse
• TransactionUpdateNoteResponse

Methods:

• client.transaction.retrieve(transactionID) -> Transaction
• client.transaction.list({ ...params }) -> TransactionListResponse
• client.transaction.aggregate({ ...params }) -> TransactionAggregateResponse
• client.transaction.retrieveFeeDetails(transactionID) -> TransactionRetrieveFeeDetailsResponse
• client.transaction.updateNote(transactionID, { ...params }) -> TransactionUpdateNoteResponse

Transfer

Types:

• TransferCreateVirtualAccountTransferResponse

Methods:

• client.transfer.createVirtualAccountTransfer({ ...params }) -> TransferCreateVirtualAccountTransferResponse

Card

Types:

• Card
• CardGroupUtilization
• CardStatus
• CardListResponse

Methods:

• client.card.create({ ...params }) -> Card
• client.card.retrieve(cardID, { ...params }) -> Card
• client.card.update(cardID, { ...params }) -> Card
• client.card.list({ ...params }) -> CardListResponse
• client.card.getUtilization(cardID) -> CardGroupUtilization

SpendingConstraint

Types:

• PartialSpendingConstraint
• Restriction
• SpendingConstraint

Methods:

• client.card.spendingConstraint.updateFull(cardID, { ...params }) -> SpendingConstraint
• client.card.spendingConstraint.updatePartial(cardID, { ...params }) -> SpendingConstraint

CardGroup

Types:

• CardGroup
• CardGroupListResponse

Methods:

• client.cardGroup.create({ ...params }) -> CardGroup
• client.cardGroup.retrieve(cardGroupID) -> CardGroup
• client.cardGroup.update(cardGroupID, { ...params }) -> CardGroup
• client.cardGroup.list({ ...params }) -> CardGroupListResponse
• client.cardGroup.getUtilization(cardGroupID) -> CardGroupUtilization

SpendingConstraint

Methods:

• client.cardGroup.spendingConstraint.updateFull(cardGroupID, { ...params }) -> SpendingConstraint
• client.cardGroup.spendingConstraint.updatePartial(cardGroupID, { ...params }) -> SpendingConstraint

CardProduct

Types:

• CardProductListResponse

Methods:

• client.cardProduct.list({ ...params }) -> CardProductListResponse

SlashHandle

Types:

• SlashHandleListResponse

Methods:

• client.slashHandle.list({ ...params }) -> SlashHandleListResponse

Pay

Types:

• SlashHandle
• PaySendResponse

Methods:

• client.pay.retrieve() -> SlashHandle
• client.pay.send({ ...params }) -> PaySendResponse

Webhook

Types:

• Webhook
• WebhookListResponse

Methods:

• client.webhook.create({ ...params }) -> Webhook
• client.webhook.update(webhookID, { ...params }) -> Webhook
• client.webhook.list({ ...params }) -> WebhookListResponse

Merchant

Types:

• Merchant
• MerchantListResponse

Methods:

• client.merchant.retrieve(merchantID) -> Merchant
• client.merchant.list({ ...params }) -> MerchantListResponse

MerchantCategory

Types:

• MerchantCategoryListResponse

Methods:

• client.merchantCategory.list({ ...params }) -> MerchantCategoryListResponse

DeveloperAccount

Types:

• DeveloperApplicationData
• DeveloperApplicationModel
• DeveloperApplicationType

Methods:

• client.developerAccount.createApplication(developerAccountID, { ...params }) -> DeveloperApplicationModel

DeveloperApplication

Methods:

• client.developerApplication.retrieve(developerApplicationID) -> DeveloperApplicationModel
• client.developerApplication.update(developerApplicationID, { ...params }) -> DeveloperApplicationModel
• client.developerApplication.createOrRegenerateSecret(developerApplicationID) -> DeveloperApplicationModel

WellKnown

Types:

• WellKnownRetrieveOpenidConfigurationResponse

Methods:

• client.wellKnown.retrieveOpenidConfiguration() -> WellKnownRetrieveOpenidConfigurationResponse

Oauth2

Types:

• Oauth2GetTokenResponse

Methods:

• client.oauth2.getToken({ ...params }) -> Oauth2GetTokenResponse

Userinfo

Types:

• UserInfo

Methods:

• client.oauth2.userinfo.retrieve() -> UserInfo
• client.oauth2.userinfo.submit() -> UserInfo

Fdx

Customers

Types:

• CustomerRetrieveCurrentResponse

Methods:

• client.fdx.customers.retrieveCurrent() -> CustomerRetrieveCurrentResponse

Accounts

Types:

• DepositAccount
• InvestmentAccount
• LineOfCreditAccount
• LoanAccount
• AccountRetrieveResponse
• AccountListResponse
• AccountListTransactionsResponse
• AccountRetrieveContactResponse
• AccountRetrievePaymentNetworksResponse

Methods:

• client.fdx.accounts.retrieve(accountID) -> AccountRetrieveResponse
• client.fdx.accounts.list({ ...params }) -> AccountListResponse
• client.fdx.accounts.listTransactions(accountID, { ...params }) -> AccountListTransactionsResponse
• client.fdx.accounts.retrieveContact(accountID) -> AccountRetrieveContactResponse
• client.fdx.accounts.retrievePaymentNetworks(accountID, { ...params }) -> AccountRetrievePaymentNetworksResponse

Statements

Types:

• StatementListResponse

Methods:

• client.fdx.accounts.statements.list(accountID, { ...params }) -> StatementListResponse
• client.fdx.accounts.statements.retrievePdf(statementID, { ...params }) -> Response

Crypto

Types:

• CryptoCreateOfframpResponse

Methods:

• client.crypto.createOfframp({ ...params }) -> CryptoCreateOfframpResponse