Preparation Response

When the payee's bank account is from a SEPA country, the response contains the result of the Verification of Payee (VoP) check.

note

Set your response timeout to 30 seconds for the Preparation Request.

Successful response parameters

HTTP status: 200 OK Content-Type: application/json

Name	Format	Description
sessionId	string	Unique payment session identifier used to execute the payment
verificationOfPayee	object	An object outlining the verification of payee results
verificationOfPayee.matchedName	string	Returns only when the result is CLOSE_MATCH. Returned value includes the full names of the payee returned by VoP.
verificationOfPayee.result	string	Result of the Verification of Payee (VoP) check: MATCH – names matched; NO_MATCH – names not matched; CLOSE_MATCH – names close matched; NOT_AVAILABLE – service not available

Error response parameters

HTTP status: 4XX Content-Type: application/json

Name	Format	Description
code	string	General purpose error code in which area the problem originated
message	string	Descriptive message showing in more details the problem
parameter	string (optional)	Parameter which failed validation

Example preparation response for SEPA bank accounts (success)

200 OK
Content-Type: application/json

{
  "sessionId": "15a938b30bca81849984280caf2f5b32",
  "verificationOfPayee": {
    "matchedName": "Fname Lname",
    "result": "CLOSE_MATCH"
  }
}

Example preparation response for non-SEPA bank accounts (success)

200 OK
Content-Type: application/json

{
  "sessionId": "641580f284b29ac98836524d5d2e443a"
}

Example preparation response (error)

400 Bad Request
Content-Type: application/json

{
  "code": "MISSING_PARAMETER",
  "parameter": "iban",
  "message": "Missing iban parameter."
}

Preparation response error messages

Code	Error message	Description
MISSING_PARAMETER	Missing <parameter_name> parameter.	Missing required payout field parameter. Example: Missing instrument_type parameter.
INVALID_PARAMETER	<parameter_name> is invalid.	Invalid parameter. Example: amount is invalid.
NOT_MATCHING_PAYMENT_INSTRUMENT_COUNTRY	Not matching payment instrument country.	Instrument country doesn't match the country from IBAN
SWIFT_NOT_MATCH_WITH_IBAN	swift does not match bank associated with IBAN	SWIFT code does not match bank associated with IBAN
UNSUPPORTED_BANK	Unsupported bank	Used payment instruments are not supported for payouts
INVALID_PARAMETER	<parameter_name> field with length=<parameter_length> exceeds the <parameter_max_length> character limit	The parameter exceeds the specified length.
INVALID_PARAMETER	<parameter_name>=<parameter_value> has invalid format	The parameter is in invalid format. Example: bank_code=00243 has invalid format
ALREADY_PAID	Already paid	When a given payment, identified by the parameter transaction_id, was already completed, and a second attempt is made with the already paid transaction_id.
COUNTRY_NOT_SUPPORTED_FOR_PAYOUTS	Payout to requested country is not supported	When the payout attempt is for a payment instrument from a country not supported by the system.
BAD_REQUEST	IP not allowed	When the request is from a not whitelisted IP address. How to whitelist your IP, please check Whitelist IP addresses
BAD_REQUEST	The initial payout transaction is not confirmed	The used token belongs to a payout that is not confirmed/settled.
GENERAL_ERROR	General Error	An error occurred during session initiation.
GENERAL_ERROR	Token does not belong to merchant	This token is associated with a different merchant and cannot be used for your transactions to ensure security and proper authorization.
GENERAL_ERROR	Token does not belong to payee	This token is linked to a specific beneficiary and cannot be used to make payments to a different beneficiary.
GENERAL_ERROR	The initial payout transaction does not belong to merchant	The initial payout transaction associated with this token does not belong to the given merchant, ensuring transactions are tied to the correct merchant.

If errors persist, please contact your dedicated relationship manager or merchant services.