MOmollie
Verify Payee API

Verify Payee

Changed on

🚧 Beta feature

This feature is currently in beta testing, and the final specification may still change.

Perform a Verification of Payee (VoP) check. This allows you to verify the account holder name against the records held by the receiving bank before initiating a transfer.

The verification result indicates whether the provided name matches, closely matches, or does not match the name on file at the receiving bank. This helps prevent misdirected payments.

Simulating verification scenarios in test mode

In test mode, you can simulate various verification outcomes by adjusting the creditor name in the creditorBankAccount.accountHolderName property. This allows you to test all possible Verification of Payee results without needing special properties. The names are case insensitive.

Account holder nameScenarioVerification resultSuggested name
John Close MatchName closely matches the bank recordsclose-matchJohn Match
John No MatchName does not match the bank recordsno-match—
John UnavailableVerification is not availablenot-available—
Any other nameDefault: name matches the bank recordsmatch—
post/v2/business-accounts/payee-verifications

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/business-accounts/payee-verifications
  • Auth
    HTTP bearer

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Request body

testmodeboolean nullable

Whether to create the entity in test mode or live mode.

Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode to true.

Example request

{
  "creditorBankAccount": {
    "accountHolderName": "Jan Jansen",
    "format": "iban",
    "accountNumber": "NL02ABNA0123456789"
  }
}

Response

The verification result object.

resourcestring required

Indicates the response contains a payee verification object. Will always contain the string business-account-payee-verification for this endpoint.

mode'live' | 'test' required

Whether this entity was created in live mode or in test mode.

createdAtstring required

The entity's date and time of creation, in ISO 8601 format.

Example response

{
  "resource": "business-account-payee-verification",
  "mode": "live",
  "creditorBankAccount": {
    "accountHolderName": "Jan Jansen",
    "format": "iban",
    "accountNumber": "NL02ABNA0123456789"
  },
  "verificationResult": {
    "outcome": "matched",
    "accountHolderName": "Jan Jansen"
  },
  "createdAt": "2024-03-20T09:13:37+00:00"
}

Changes

  • ef4b5a97b56aRevision changes
    • info

      the endpoint scheme security advancedAccessToken was added to the API

    • info

      the endpoint scheme security organizationAccessToken was removed from the API

  • ec6fca28a732Revision changes
    • info

      api tag Verify Payee API added

    • info

      api tag Verify Payees API removed