Weavr 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
Corporates
Corporates are identities representing companies. Once on-boarded, Corporates can create and manage their own instruments via your application.
Consumers
Consumers are identities representing individuals. Once on-boarded, Consumers can create and manage their own instruments via your application.
Setup
Register and manage the lifecycle of users that can access an identity, including authorised users invited by a Corporate or Consumer root user.
/usersList usersGET/usersGet a userGET/users/{user_id}Update a userPATCH/users/{user_id}List linked identitiesGET/identitiesInvite a user to become an authorised userPOST/users/{user_id}/inviteValidate a user's invitePOST/users/{user_id}/invite/validateAccept a user invitationPOST/users/{user_id}/invite/consumeSend an email verification code to a userPOST/users/verification/email/sendVerify email of the authorised userPOST/users/verification/email/verifyDeactivate an authorised userPOST/users/{user_id}/deactivateReactivate an authorised userPOST/users/{user_id}/activateStart signatory verificationPOST/users/kycSign-in
Sign users in using passwords, biometrics, or third-party auth providers.
Step-up challenges
Issue and verify step-up challenges that elevate an existing user token.
Confirmation challenges
Issue and verify confirmation challenges used to authorise lists of resources.
/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}Authentication factors
Manage user authentication factors, including passwords and device-based factors (OTP and push).
/passwords/{user_id}/createUpdate a passwordPOST/passwords/updateValidate a passwordPOST/passwords/validateStart password recoveryPOST/passwords/lost_password/startContinue password recoveryPOST/passwords/lost_password/resumeList user authentication factorsGET/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}Access tokens
Acquire and revoke access tokens.
Authorised signatories
Verify the email of root users who act as authorised signatories of a Corporate or Consumer identity.
/corporates/verification/email/sendVerify email of Corporate root userPOST/corporates/verification/email/verifySend an email verification code to the consumer root userPOST/consumers/verification/email/sendVerify email of Consumer root userPOST/consumers/verification/email/verifyTrusted payees
Manage a list of trusted payees for Outgoing wire transfers and Sends.
Aside from convenience and a reduced chance of making errors when making transactions,
this allows for the introduction an SCA exemption, where the account holder can request
that transactions to TRUSTED payees to be exempted from the requirement to pass
an SCA challenge every time.
/beneficiariesList payeesGET/beneficiariesRemove payeesPOST/beneficiaries/removeGet a payeeGET/beneficiaries/{id}List payee batchesGET/beneficiaries/batchGet a batch of payeesGET/beneficiaries/batch/{id}Send a one-time password to verify a payee batchPOST/beneficiaries/batch/{id}/challenges/otp/{channel}Verify a payee batch using a one-time passwordPOST/beneficiaries/batch/{id}/challenges/otp/{channel}/verifySend a push notification to verify a payee batchPOST/beneficiaries/batch/{id}/challenges/push/{channel}Managed 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 an accountPOST/managed_accountsGet an accountGET/managed_accounts/{id}Update an accountPATCH/managed_accounts/{id}Add an IBAN to an accountPOST/managed_accounts/{id}/ibanGet an account IBANGET/managed_accounts/{id}/ibanBlock an accountPOST/managed_accounts/{id}/blockUnblock an accountPOST/managed_accounts/{id}/unblockGet an account statementGET/deprecated/managed_accounts/{id}/statementGet an account statementGET/managed_accounts/{id}/statementList account transactionsGET/managed_accounts/{id}/transactionsGet an account transactionGET/managed_accounts/{id}/transactions/{transactionId}Remove an 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_cardsCreate a prepaid cardPOST/managed_cards#prepaidCreate a debit cardPOST/managed_cards#debitGet a cardGET/managed_cards/{id}Update a cardPATCH/managed_cards/{id}Block a cardPOST/managed_cards/{id}/blockUnblock a cardPOST/managed_cards/{id}/unblockRemove a cardPOST/managed_cards/{id}/removeGet a card statementGET/deprecated/managed_cards/{id}/statementGet a card statementGET/managed_cards/{id}/statementList card transactionsGET/managed_cards/{id}/transactionsGet a card transactionGET/managed_cards/{id}/transactions/{transactionId}Create a physical cardPOST/managed_cards/{id}/physicalUpgrade a card to physical (bulk)POST/managed_cards/{id}/physical#bulkActivate 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/resetTransfers
The Transfer transaction is used to transfer funds between managed accounts and managed cards belonging to same identity.
Transaction activity
Retrieve the consolidated transaction activity across instruments.
Incoming wire transfers
Incoming wire transfers received from external bank accounts to managed accounts with IBANs.
Outgoing wire transfers
The Outgoing Wire Transfer transaction is used to transfer funds from managed accounts to an external bank account.
/outgoing_wire_transfersList outgoing wire transfersGET/outgoing_wire_transfersGet an outgoing wire transferGET/outgoing_wire_transfers/{id}Update the beneficiary name of an outgoing wire transferPATCH/outgoing_wire_transfers/{id}Get an outgoing wire transfer payment confirmationGET/outgoing_wire_transfers/{id}/payment_confirmationCancel an outgoing wire transferPOST/outgoing_wire_transfers/{id}/cancelConfirm an outgoing wire transferPOST/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}Correspondent bank transfers
Correspondent bank transfers allow financial institutions to initiate wire transfers on behalf of originators (third parties). These transfers comply with travel rule requirements by capturing and transmitting originator information.
/correspondent_bank_transfersList correspondent bank transfersGET/correspondent_bank_transfersGet a correspondent bank transferGET/correspondent_bank_transfers/{id}Cancel a correspondent bank transferPOST/correspondent_bank_transfers/{id}/cancelConfirm a correspondent bank transferPOST/correspondent_bank_transfers/{id}/confirmCard payments
Retrieve card payment activity, including authorisations, settlements, and related events.
Spend controls
Manage spend rules and authorisation forwarding to approve or reject card payments in real time.
/managed_cards/{id}/spend_rulesCreate spend rules for a cardPOST/managed_cards/{id}/spend_rulesUpdate spend rules for a cardPATCH/managed_cards/{id}/spend_rulesDelete all spend rules for a cardDELETE/managed_cards/{id}/spend_rulesApprove or reject card paymentsWebhook/managed_cards/authorisation_requestSends
The Send transaction is used to send funds between managed accounts and managed cards belonging to different identities.
/sendsList sendsGET/sendsGet a sendGET/sends/{id}Cancel a sendPOST/sends/{id}/cancelIssue 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}/verifySend a push notification to verify a sendPOST/sends/{id}/challenges/push/{channel}Fees
Charge and retrieve in-platform fees.
Manage
Manage bulk processes that group together multiple operations to be executed asynchronously.
Linked accounts
Manage external bank accounts linked to an identity.
/linked_accountsList 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}/unblockList linked account verificationsGET/linked_accounts/{id}/verificationsSystem Managed Cards
Manage cards created and controlled by the platform.
Roles
Retrieve the roles available to users of an identity.