524 lines (387 loc) · 32.1 KB

Shared

Types:

Config

Types:

Methods:

client.config.retrieve() -> PlatformConfig
client.config.update({ ...params }) -> PlatformConfig

Customers

Types:

Methods:

client.customers.create({ ...params }) -> CustomerOneOf
client.customers.retrieve(customerID) -> CustomerOneOf
client.customers.update(customerID, { ...params }) -> CustomerOneOf
client.customers.list({ ...params }) -> CustomerOneovesDefaultPagination
client.customers.delete(customerID) -> CustomerOneOf
client.customers.getKYCLink({ ...params }) -> CustomerGetKYCLinkResponse
client.customers.listInternalAccounts({ ...params }) -> InternalAccountsDefaultPagination

ExternalAccounts

Types:

Methods:

client.customers.externalAccounts.create({ ...params }) -> ExternalAccount
client.customers.externalAccounts.retrieve(externalAccountID) -> ExternalAccount
client.customers.externalAccounts.list({ ...params }) -> ExternalAccountsDefaultPagination
client.customers.externalAccounts.delete(externalAccountID) -> void

Bulk

Types:

Methods:

client.customers.bulk.getJobStatus(jobID) -> BulkGetJobStatusResponse
client.customers.bulk.uploadCsv({ ...params }) -> BulkUploadCsvResponse

Platform

Types:

PlatformListInternalAccountsResponse

Methods:

client.platform.listInternalAccounts({ ...params }) -> PlatformListInternalAccountsResponse

ExternalAccounts

Types:

Methods:

client.platform.externalAccounts.create({ ...params }) -> ExternalAccount
client.platform.externalAccounts.retrieve(externalAccountID) -> ExternalAccount
client.platform.externalAccounts.list({ ...params }) -> ExternalAccountListResponse
client.platform.externalAccounts.delete(externalAccountID) -> void

TransferIn

Types:

Methods:

client.transferIn.create({ ...params }) -> Transaction

TransferOut

Methods:

client.transferOut.create({ ...params }) -> Transaction

Receiver

Types:

Methods:

client.receiver.lookupExternalAccount(accountID, { ...params }) -> ReceiverLookupExternalAccountResponse
client.receiver.lookupUma(receiverUmaAddress, { ...params }) -> ReceiverLookupUmaResponse

Quotes

Types:

Methods:

client.quotes.create({ ...params }) -> Quote
client.quotes.retrieve(quoteID) -> Quote
client.quotes.execute(quoteID, { ...params }) -> Quote

Transactions

Types:

Methods:

client.transactions.retrieve(transactionID) -> Transaction
client.transactions.list({ ...params }) -> TransactionsDefaultPagination
client.transactions.approve(transactionID, { ...params }) -> IncomingTransaction
client.transactions.reject(transactionID, { ...params }) -> IncomingTransaction

Invitations

Types:

CurrencyAmount
UmaInvitation

Methods:

client.invitations.create({ ...params }) -> UmaInvitation
client.invitations.retrieve(invitationCode) -> UmaInvitation
client.invitations.cancel(invitationCode) -> UmaInvitation
client.invitations.claim(invitationCode, { ...params }) -> UmaInvitation

Sandbox

Methods:

client.sandbox.sendFunds({ ...params }) -> OutgoingTransaction

Uma

Methods:

client.sandbox.uma.receivePayment({ ...params }) -> IncomingTransaction

InternalAccounts

Types:

InternalAccount

Methods:

client.sandbox.internalAccounts.fund(accountID, { ...params }) -> InternalAccount

Webhooks

Types:

WebhookSendTestResponse

Methods:

client.sandbox.webhooks.sendTest() -> WebhookSendTestResponse

UmaProviders

Types:

UmaProviderListResponse

Methods:

client.umaProviders.list({ ...params }) -> UmaProviderListResponsesDefaultPagination

Tokens

Types:

APIToken
Permission

Methods:

client.tokens.create({ ...params }) -> APIToken
client.tokens.retrieve(tokenID) -> APIToken
client.tokens.list({ ...params }) -> APITokensDefaultPagination
client.tokens.delete(tokenID) -> void

ExchangeRates

Types:

ExchangeRateListResponse

Methods:

client.exchangeRates.list({ ...params }) -> ExchangeRateListResponse

Webhooks

Types:

Methods:

client.webhooks.unwrap(body) -> void

Crypto

Types:

CryptoEstimateWithdrawalFeeResponse

Methods:

client.crypto.estimateWithdrawalFee({ ...params }) -> CryptoEstimateWithdrawalFeeResponse

BeneficialOwners

Types:

Methods:

client.beneficialOwners.create({ ...params }) -> BeneficialOwnerCreateResponse
client.beneficialOwners.retrieve(beneficialOwnerID) -> BeneficialOwnerRetrieveResponse
client.beneficialOwners.update(beneficialOwnerID, { ...params }) -> BeneficialOwnerUpdateResponse
client.beneficialOwners.list({ ...params }) -> BeneficialOwnerListResponsesDefaultPagination

Documents

Types:

Methods:

client.documents.retrieve(documentID) -> DocumentRetrieveResponse
client.documents.list({ ...params }) -> DocumentListResponsesDefaultPagination
client.documents.delete(documentID) -> void
client.documents.replace(documentID, { ...params }) -> DocumentReplaceResponse
client.documents.upload({ ...params }) -> DocumentUploadResponse

Verifications

Types:

Methods:

client.verifications.retrieve(verificationID) -> VerificationRetrieveResponse
client.verifications.list({ ...params }) -> VerificationListResponsesDefaultPagination
client.verifications.submit({ ...params }) -> VerificationSubmitResponse

Discoveries

Types:

DiscoveryListResponse

Methods:

client.discoveries.list({ ...params }) -> DiscoveryListResponse

Auth

Credentials

Types:

Methods:

client.auth.credentials.create({ ...params }) -> AuthMethod
client.auth.credentials.list({ ...params }) -> CredentialListResponse
client.auth.credentials.resendChallenge(id, { ...params }) -> CredentialResendChallengeResponse
client.auth.credentials.revoke(id, { ...params }) -> CredentialRevokeResponse
client.auth.credentials.verify(id, { ...params }) -> CredentialVerifyResponse

Sessions

Types:

Methods:

client.auth.sessions.list({ ...params }) -> SessionListResponse
client.auth.sessions.revoke(id, { ...params }) -> SessionRevokeResponse

InternalAccounts

Types:

InternalAccountExportResponse

Methods:

client.internalAccounts.export(id, { ...params }) -> InternalAccountExportResponse