Trusted payees

Send a one-time password to verify a payee batch

Starts verification of a payee batch by sending a one-time password to a device belonging to the logged-in user.

Use this after adding or removing payees, passing the operationBatchId from that response as id. Only start this when the batch state is PENDING_CHALLENGE.

The device must have been enrolled beforehand through /authentication_factors/otp/{channel}. To send a push notification instead of a one-time password, use the push variant.

Confirm the code with Verify a payee batch to apply the batch.

:::note On sandbox, no text message is sent and the one-time password is always 123456. :::

post/beneficiaries/batch/{id}/challenges/otp/{channel}

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/beneficiaries/batch/{id}/challenges/otp/{channel}
  • Auth: HTTP bearer and API key in header api-key

Path parameters

idstring required
Example:123456789

The unique identifier of the payee batch.

channel'SMS' required
  • SMS: The one-time-password is sent as a text message

The unique identifier for the channel.

Response

Success - No Content.

Changes

No recorded changes to this operation across all 1 revision of this API.