Suppliers Overview

BuyersBuyerA business entity in the Payment Run solution that can be provided with financial services to perform embedded payment runs. Buyers are onboarded through a KYB process and can create payment runs to pay their suppliers. They have roles such as Admin, Controller, and Creator. can store a list of trusted supplierSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. details to be used when creating a payment runPayment RunA list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution..

Note: SupplierSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. details include information about the business or individual’s bank account that needs to be trusted before being able to create a Payment RunPayment RunA list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution..

When using suppliersSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers., your customers may be allowed to skip Strong Customer Authentication when executing a Payment Run, thus reducing the number of approval steps required.

Create Suppliers

To create a supplierSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. for a buyerBuyerA business entity in the Payment Run solution that can be provided with financial services to perform embedded payment runs. Buyers are onboarded through a KYB process and can create payment runs to pay their suppliers. They have roles such as Admin, Controller, and Creator., an end-user belonging to the buyerBuyerA business entity in the Payment Run solution that can be provided with financial services to perform embedded payment runs. Buyers are onboarded through a KYB process and can create payment runs to pay their suppliers. They have roles such as Admin, Controller, and Creator. must be logged in. You require your API key and an active end-user authentication token to create a supplierSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers.. Read more about authentication in the [authentication guide].

tip

Setting the trustLevel of a supplierSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. to TRUSTED enables the end-user to skip Strong Customer Authentication for transactions to that supplierSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers..

POST/beneficiariesTry it

Request

{
  "tag": "customer-123",
  "beneficiaries": [
    {
      "trustLevel": "TRUSTED",
      "externalRefs": [
        "string"
      ],
      "group": "Suppliers",
      "beneficiaryInformation": {
        "businessName": "Acme Ltd"
      },
      "beneficiaryDetails": {
        "instrument": {
          "id": "123456789",
          "type": "managed_accounts"
        }
      }
    }
  ]
}

Response

{
  "operationBatchId": {
    "batchId": "123456789",
    "operation": "CREATE"
  },
  "tag": "customer-123",
  "state": "INITIALISED"
}

info

SuppliersSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. belong to the buyerBuyerA business entity in the Payment Run solution that can be provided with financial services to perform embedded payment runs. Buyers are onboarded through a KYB process and can create payment runs to pay their suppliers. They have roles such as Admin, Controller, and Creator. managing them and cannot be shared with other buyersBuyerA business entity in the Payment Run solution that can be provided with financial services to perform embedded payment runs. Buyers are onboarded through a KYB process and can create payment runs to pay their suppliers. They have roles such as Admin, Controller, and Creator..

Verify Suppliers

Before the submitted suppliersSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. can be added to the list, the logged-in user must verify the details by completing a challenge.

tip

A challenge is required when removing suppliersSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. from the list as well.

Send a Challenge

You can trigger the suppliersSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. verification process by calling the suppliersSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers.' challenge API. The user is requested to perform a two-factor authentication based on the channel provided in the request.

You can check your enabled authentication channels for suppliersSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. via the Innovator Portal by navigating to Identities ProfileProfileA template defining the configuration for one type of object - corporate identity, consumer identity, managed account, managed card, transfer, or outgoing wire transfer. When you create one of these objects you reference its Profile ID, which tells Weavr which limits, currencies, supported countries, branding, and fees to apply. Your programme ships with one or more Profile IDs per supported object type. → Authentication tab → Payment Verification.

info

Currently, we support SMS as possible authentication channels. More authentication channels are planned for the future.

You can start an SCASCA (Strong Customer Authentication). Strong Customer Authentication - a two-factor authentication solution required by PSD2 regulations for when end-users are accessing their payment account sensitive information or initiating transactions. SCA requires at least two of the following: something you know (password), something you have (device), or something you are (biometrics). challenge via SMS by requesting the One Time Password API endpoint. A text message containing an OTP code is sent to the logged-in end-users' registered mobile phone.

POST/beneficiaries/batch/{id}/challenges/otp/{channel}Try it

Response

{
  "code": "NOT_FOUND",
  "message": "The requested resource could not be found."
}

Complete the Challenge

SMS is the selected channel, then you must build a page in your application where the user can enter the verification code that they received in the text message which you will need to submit to via the challenge verify API.

POST/beneficiaries/batch/{id}/challenges/otp/{channel}/verifyTry it

Request

{
  "verificationCode": "654321"
}

Response

{
  "code": "NOT_FOUND",
  "message": "The requested resource could not be found."
}

Once confirmed, the suppliersSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. are automatically added to the identity's suppliersSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. list. You receive a webhook for the batch of suppliersSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. that includes all the suppliersSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. in the list with its outcome.

Remove suppliers

To remove a supplierSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. for a buyerBuyerA business entity in the Payment Run solution that can be provided with financial services to perform embedded payment runs. Buyers are onboarded through a KYB process and can create payment runs to pay their suppliers. They have roles such as Admin, Controller, and Creator., an end-user belonging to the buyerBuyerA business entity in the Payment Run solution that can be provided with financial services to perform embedded payment runs. Buyers are onboarded through a KYB process and can create payment runs to pay their suppliers. They have roles such as Admin, Controller, and Creator. must be logged in. You require your API key and an active end-user authentication token to remove a supplierSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers.. Read more about authentication in the [authentication guide]

POST/beneficiaries/removeTry it

Request

{
  "beneficiaryIds": [
    "string"
  ]
}

Response

{
  "operationBatchId": {
    "batchId": "123456789",
    "operation": "CREATE"
  },
  "tag": "customer-123",
  "state": "INITIALISED"
}

SCA is required to remove Suppliers

The logged-in user must complete an SCASCA (Strong Customer Authentication). Strong Customer Authentication - a two-factor authentication solution required by PSD2 regulations for when end-users are accessing their payment account sensitive information or initiating transactions. SCA requires at least two of the following: something you know (password), something you have (device), or something you are (biometrics). challenge to remove suppliersSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers..

Using Suppliers with Payment Run

When submitting a Payment RunPayment RunA list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution., your customers must choose a supplierSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers. with every payment. This can be done by providing a supplierId in the destination parameter.

If the Payment RunPayment RunA list of payments created by Buyers to settle their outstanding financial obligations with their suppliers. Payment runs are typically managed by the accounts payable function within a business on a periodic basis and go through stages of creation, authorisation, funding, and execution. was eligible to skip Strong Customer Authentication because the destination is a trusted supplierSupplierA trusted business or individual that receives payments from Buyers through payment runs. Suppliers can be stored in a trusted supplier list, and when marked as trusted, may allow Buyers to skip Strong Customer Authentication when executing payment runs to those suppliers., then it is executed automatically and the challengeExemptionReason is set to TRUSTED_SUPPLIER.