api.md

Shared

Types:

• BulkCustomerImportErrorEntry

Config

Types:

• CustomerInfoFieldName
• PlatformConfig
• PlatformCurrencyConfig

Methods:

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

Customers

Types:

• Customer
• CustomerCreate
• CustomerOneOf
• CustomerUpdate
• CustomerGetKYCLinkResponse

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:

• Address
• BaseWalletInfo
• BeneficiaryVerifiedData
• BrlBeneficiary
• BrlExternalAccountInfo
• BusinessBeneficiary
• DkkBeneficiary
• DkkExternalAccountInfo
• ExternalAccount
• ExternalAccountCreate
• ExternalAccountInfoOneOf
• GbpBeneficiary
• GbpExternalAccountInfo
• HkdBeneficiary
• HkdExternalAccountInfo
• IdrBeneficiary
• IdrExternalAccountInfo
• InrBeneficiary
• InrExternalAccountInfo
• LightningWalletInfo
• MxnBeneficiary
• MxnExternalAccountInfo
• MyrBeneficiary
• MyrExternalAccountInfo
• PhpBeneficiary
• PhpExternalAccountInfo
• PolygonWalletInfo
• SgdBeneficiary
• SgdExternalAccountInfo
• SolanaWalletInfo
• SparkWalletInfo
• ThbBeneficiary
• ThbExternalAccountInfo
• TronWalletInfo
• UsdBeneficiary
• UsdExternalAccountInfo
• VndBeneficiary
• VndExternalAccountInfo

Methods:

• client.customers.externalAccounts.create({ ...params }) -> ExternalAccount
• client.customers.externalAccounts.list({ ...params }) -> ExternalAccountsDefaultPagination

Bulk

Types:

• BulkGetJobStatusResponse
• BulkUploadCsvResponse

Methods:

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

Platform

Types:

• PlatformListInternalAccountsResponse

Methods:

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

ExternalAccounts

Types:

• ExternalAccountListResponse

Methods:

• client.platform.externalAccounts.create({ ...params }) -> ExternalAccount
• client.platform.externalAccounts.list({ ...params }) -> ExternalAccountListResponse

Plaid

Types:

• PlaidCreateLinkTokenResponse

Methods:

• client.plaid.createLinkToken({ ...params }) -> PlaidCreateLinkTokenResponse
• client.plaid.submitPublicToken(plaidLinkToken, { ...params }) -> ExternalAccount

TransferIn

Types:

• Transaction
• TransferInCreateResponse

Methods:

• client.transferIn.create({ ...params }) -> TransferInCreateResponse

TransferOut

Types:

• TransferOutCreateResponse

Methods:

• client.transferOut.create({ ...params }) -> TransferOutCreateResponse

Receiver

Types:

• CounterpartyFieldDefinition
• LookupResponse
• ReceiverLookupExternalAccountResponse
• ReceiverLookupUmaResponse

Methods:

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

Quotes

Types:

• Currency
• OutgoingRateDetails
• PaymentInstructions
• Quote
• QuoteDestinationOneOf

Methods:

• client.quotes.create({ ...params }) -> Quote
• client.quotes.retrieve(quoteID) -> Quote
• client.quotes.list({ ...params }) -> QuotesDefaultPagination
• client.quotes.execute(quoteID) -> Quote

Transactions

Types:

• IncomingTransaction
• OutgoingTransaction
• TransactionSourceOneOf
• TransactionStatus
• TransactionType
• TransactionRetrieveResponse
• TransactionListResponse

Methods:

• client.transactions.retrieve(transactionID) -> TransactionRetrieveResponse
• client.transactions.list({ ...params }) -> TransactionListResponsesDefaultPagination
• 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

Types:

• SandboxSendTestResponse

Methods:

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

Uma

Methods:

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

InternalAccounts

Types:

• InternalAccount

Methods:

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

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:

• IncomingPaymentWebhookEvent
• OutgoingPaymentWebhookEvent
• TestWebhookWebhookEvent
• BulkUploadWebhookEvent
• InvitationClaimedWebhookEvent
• KYCStatusWebhookEvent
• AccountStatusWebhookEvent
• UnwrapWebhookEvent

Methods:

• client.webhooks.unwrap(body) -> void