Weavr Multi Product API
Weavr Multi API provides a simple and flexible way to issue cards and accounts to your customers.
By integrating Weavr Multi API in your application you can embed banking capabilities within your app and provide a seamless experience for your customers.
Authentication
Each request to the Multi API must include an api-key that represents your account. You can obtain an API Key by registering for a Multi account here.
Almost all endpoints require a secondary authentication token auth_token that represents the user for whom the request is being executed.
Contact: Weavr
Access
Manage authentication for your users.
Passwords
Manage your users' passwords.
Authorised Users
Corporate and Consumer identities can invite authorised users to access their account. Once on-boarded, authorised users can create and manage instruments and transactions on behalf of the identity they are on-boarded with.
In case of Corporate Identities, authorised users are typically employees who have access to company's banking products such as cards and bank accounts.
In case of Consumer Identities, authorised users are typically children/teens whose parents want them to have access to banking products such as cards and bank accounts.
Note that the /users GET endpoints return all users including root users. However, modification operations (create, update, activate, deactivate) on /users endpoints only apply to authorised users. To modify root user details, use the respective /consumers or /corporates endpoints.
/usersGet all usersGET/usersGet a userGET/users/{user_id}Update a userPATCH/users/{user_id}Activate a userPOST/users/{user_id}/activateDeactivate a userPOST/users/{user_id}/deactivateSend a user invitePOST/users/{user_id}/inviteValidate a user invitePOST/users/{user_id}/invite/validateConsume a user invitePOST/users/{user_id}/invite/consumeSend an email verification code to the authorised userPOST/users/verification/email/sendVerify email of the authorised userPOST/users/verification/email/verifyStart KYC for the userPOST/users/kycCorporates
Corporates are identities representing companies. Once on-boarded, Corporates can create and manage their own instruments via your application.
/corporatesGet a corporateGET/corporatesUpdate a corporatePATCH/corporatesSend an email verification code to the root userPOST/corporates/verification/email/sendVerify email of the root userPOST/corporates/verification/email/verifyStart KYB for a corporatePOST/corporates/kybGet KYB for a corporateGET/corporates/kybCharge fee to a corporatePOST/corporates/fees/chargeConsumers
Consumers are identities representing individuals. Once on-boarded, Consumers can create and manage their own instruments via your application.
/consumersGet a consumerGET/consumersUpdate a consumerPATCH/consumersSend an email verification code to the root userPOST/consumers/verification/email/sendVerify email of the root userPOST/consumers/verification/email/verifyStart KYC for a consumerPOST/consumers/kycGet KYC for a consumerGET/consumers/kycCharge fee to a consumerPOST/consumers/fees/chargeManaged Accounts
Managed Accounts are a type of financial instrument offered by Weavr.
They hold funds for their owner, and can be upgraded to IBANs so as to receive and send funds to instruments outside of the Weavr Platform, via Wire Transfers.
Managed accounts can also be used as source and destination instruments in the transfer and send transactions.
/managed_accountsCreate a managed accountPOST/managed_accountsGet a managed accountGET/managed_accounts/{id}Update a managed accountPATCH/managed_accounts/{id}Upgrade a managed account with IBANPOST/managed_accounts/{id}/ibanGet a managed account IBANGET/managed_accounts/{id}/ibanBlock a managed accountPOST/managed_accounts/{id}/blockUnblock a managed accountPOST/managed_accounts/{id}/unblockGet a managed account statementGET/managed_accounts/{id}/statementRemove a managed accountPOST/managed_accounts/{id}/removeManaged Cards
Managed Cards are a type of financial instrument offered by Weavr.
You can create virtual or physical cards that are issued to the consumer or corporate identity.
A card created in prepaid mode has its own balance, whereas a card created in debit mode does not have its own balance but taps into the balance of its parent managed account.
/managed_cardsGet all managed cardsGET/managed_cardsGet a managed cardGET/managed_cards/{id}Update a managed cardPATCH/managed_cards/{id}Block a managed cardPOST/managed_cards/{id}/blockUnblock a managed cardPOST/managed_cards/{id}/unblockRemove a managed cardPOST/managed_cards/{id}/removeGet a managed card statementGET/managed_cards/{id}/statementAssign a managed cardPOST/managed_cards/assignGet all spend rules for a managed cardGET/managed_cards/{id}/spend_rulesCreate spend rules for a managed cardPOST/managed_cards/{id}/spend_rulesUpdate spend rules for a managed cardPATCH/managed_cards/{id}/spend_rulesDelete all spend rules for a managed cardDELETE/managed_cards/{id}/spend_rulesUpgrade a card to physicalPOST/managed_cards/{id}/physicalActivate a physical cardPOST/managed_cards/{id}/physical/activateGet PIN for a physical cardGET/managed_cards/{id}/physical/pinUnblock PIN for a physical cardPATCH/managed_cards/{id}/physical/pin/unblockReplace a damaged physical cardPOST/managed_cards/{id}/physical/replace_damagedReport a physical card as lostPOST/managed_cards/{id}/physical/report_lostReport a physical card as stolenPOST/managed_cards/{id}/physical/report_stolenReplace a lost or stolen physical cardPOST/managed_cards/{id}/physical/replace_lost_stolenReset contactless limit for a physical cardPOST/managed_cards/{id}/physical/contactless_limit/resetAuthorisation ForwardingWebhook/managed_cards/authorisation_requestLinked Accounts
Linked Accounts are external bank accounts that users connect to their profiles within the Weavr Platform.
These accounts allow users to link their existing bank accounts, held at external financial institutions, to the Weavr Platform, enabling secure and efficient transfer of funds between their own accounts.
Linked Accounts are designed to streamline the process of moving money between a user’s various bank accounts, providing a convenient and integrated way to manage personal finances across different financial institutions.
/linked_accountsGet all linked accountsGET/linked_accountsGet a linked accountGET/linked_accounts/{id}Update a linked accountPATCH/linked_accounts/{id}Remove a linked accountPOST/linked_accounts/{id}/removeBlock a linked accountPOST/linked_accounts/{id}/blockUnblock a linked accountPOST/linked_accounts/{id}/unblockGet linked account verificationsGET/linked_accounts/{id}/verificationsSends
The Send transaction is used to send funds between managed accounts and managed cards belonging to different identities.
/sendsGet all send transactionsGET/sendsCreate a bulk of send transactionsPOST/sends/bulk/createCancel send transactionsPOST/sends/bulk/cancelGet a send transactionGET/sends/{id}Issue a one-time password that can be used to verify a sendPOST/sends/{id}/challenges/otp/{channel}Verify a send using a one-time passwordPOST/sends/{id}/challenges/otp/{channel}/verifyIssue a push notification that can be used to verify Send transactionPOST/sends/{id}/challenges/push/{channel}Transfers
The Transfer transaction is used to transfer funds between managed accounts and managed cards belonging to same identity.
Outgoing Wire Transfers
The Outgoing Wire Transfer transaction is used to transfer funds from managed accounts to an external bank account.
/outgoing_wire_transfersGet all outgoing wire transfer transactionsGET/outgoing_wire_transfersCreate a bulk of outgoing wire transfer transactionsPOST/outgoing_wire_transfers/bulk/createCancel outgoing wire transfer transactionsPOST/outgoing_wire_transfers/bulk/cancelGet an outgoing wire transfer transactionGET/outgoing_wire_transfers/{id}Cancel an outgoing wire transfer transactionPOST/outgoing_wire_transfers/{id}/cancelConfirm an outgoing wire transfer transactionPOST/outgoing_wire_transfers/{id}/confirmIssue a one-time password that can be used to verify an outgoing wire transferPOST/outgoing_wire_transfers/{id}/challenges/otp/{channel}Verify an outgoing wire transfer using a one-time passwordPOST/outgoing_wire_transfers/{id}/challenges/otp/{channel}/verifyIssue a push notification that can be used to verify an outgoing wire transferPOST/outgoing_wire_transfers/{id}/challenges/push/{channel}Step-up Challenges
Authentication Factors
/authentication_factorsEnrol a user device for authentication using one-time passwordsPOST/authentication_factors/otp/{channel}Verify enrolment of a user device for authentication using one-time passwordsPOST/authentication_factors/otp/{channel}/verifyEnrol a user device for authentication using push notificationsPOST/authentication_factors/push/{channel}Unlink a user device for authentication using push notificationsDELETE/authentication_factors/push/{channel}Confirmation Challenges
/challenges/otp/{channel}Verify a list of resources using a one-time passwordPOST/challenges/{scaChallengeId}/otp/{channel}/verifyIssue a push notification that can be used to verify a list of resourcesPOST/challenges/push/{channel}Manage
/bulksGet bulk processGET/bulks/{bulk_id}Get all operations in a bulkGET/bulks/{bulk_id}/operationsExecute bulk processPOST/bulks/{bulk_id}/executePause bulk processPOST/bulks/{bulk_id}/pauseResume bulk processPOST/bulks/{bulk_id}/resumeCancel bulk processPOST/bulks/{bulk_id}/cancelBeneficiaries
/beneficiariesGet all beneficiariesGET/beneficiariesRemove beneficiariesPOST/beneficiaries/removeGet a beneficiaryGET/beneficiaries/{id}Get all beneficiary batchesGET/beneficiaries/batchGet a beneficiary batchGET/beneficiaries/batch/{id}Issue a one-time password to verify a beneficiary batchPOST/beneficiaries/batch/{id}/challenges/otp/{channel}Verify a beneficiary batch using a one-time passwordPOST/beneficiaries/batch/{id}/challenges/otp/{channel}/verifyIssue a push notification that can be used to verify a beneficiary batchPOST/beneficiaries/batch/{id}/challenges/push/{channel}Operations
/bulks/usersSend user invites in bulkPOST/bulks/users/_user_id_/inviteBlock cards in bulkPOST/bulks/managed_cards/_id_/blockUnblock cards in bulkPOST/bulks/managed_cards/_id_/unblockRemove cards in bulkPOST/bulks/managed_cards/_id_/removeUpdate spend rules for a managed card in bulkPATCH/bulks/managed_cards/_id_/spend_rulesCreate transfer transactions in bulkPOST/bulks/transfersCreate send transactions in bulkPOST/bulks/sendsCreate an outgoing wire transfer in bulkPOST/bulks/outgoing_wire_transfers