POST/api/v2/banking/payees

Payee Step 1: validate a new payee and send the OTP required by Equals Money.

This endpoint does not create the payee immediately. Equals Money requires recipient OTP approval before creation.

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
Field	Type	Required	Description
userId (query)	unknown	No

Request body

application/json

Request body fields
Field	Type	Required	Description
Name	string	No	Recipient display name. For INDIVIDUAL this is split into FirstName/LastName when those fields are omitted. Recipient display name. Matches required-fields fieldName "name".
PaymentType	COMPANY \| INDIVIDUAL	Yes	Allowed values: COMPANY, INDIVIDUAL.
Currency	string	Yes
AccountNumber	string	No
Iban	string	No	IBAN alias for AccountNumber. If AccountNumber is omitted, Iban is used as the account identifier. Alias for AccountNumber. If AccountNumber is omitted, Iban is used as the account identifier.
Bic	string	No	BIC/SWIFT alias used when required-fields returns bic. BIC/SWIFT alias. Matches required-fields fieldName "bic".
BankCode	string	No	Bank code alias used when required-fields returns bankCode. Bank code alias. Matches required-fields fieldName "bankCode".
BankName	string	No
FirstName	string	No
LastName	string	No
RoutingCodeList	array of RoutingCodeDto	No
routingCodes	array of RoutingCodeDto	No	Dashboard/public API alias for RoutingCodeList.
BankAddress	object	No
PayeeAddress	object	No
Comments	string	No
PaymentMethod	SWIFT \| SEPA.INSTANT \| SEPA.CREDITTRANSFER \| CHAPS \| UKFPS \| ACH \| …	No	Supported values: SWIFT, SEPA.INSTANT, SEPA.CREDITTRANSFER, CHAPS, UKFPS, ACH, WIRETRANSFER, OFF_PLATFORM. Allowed values: SWIFT, SEPA.INSTANT, SEPA.CREDITTRANSFER, CHAPS, UKFPS, ACH, WIRETRANSFER, OFF_PLATFORM.
VerificationMethod	string	No

Responses

202 — Accepted

Response 202 fields
Field	Type	Required
Success	boolean	No
VerificationToken	string	No
Message	string	No
ExpiresAt	string (date-time)	No
RecipientName	string	No
AccountNumberLast4	string	No
VerificationResult	object	No

400 — Bad Request

Response 400 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

401 — Unauthorized

Response 401 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

500 — Internal Server Error

Response 500 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

Example request

curl -X POST "https://{base_url}/api/v2/banking/payees" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"PaymentType":"…","Currency":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.