Validate Payee

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint allows you to validate payee information and determine the available payment schemes before creating a payee.

Request Payload:

The request payload is identical to that of the Create Payee endpoint

Response:

  • Success: If the payee data is valid, the response will include:"type": "SUCCESS"
    And a list of supported payment schemes - supportedSchemes for the given payee.
  • Error: If the payee data is invalid, the response will provide detailed information about the validation errors encountered.

Use Case:

By utilizing the Validate Payee endpoint, you can ensure that the payee information is accurate and identify the available payment schemes before attempting to create the payee. This helps prevent errors and streamlines the payee creation process.

Body Params
additionalDetails
object
address
object
required

Address of the Payee as provided on the bank account. Starting from April 7th, once creating Payee the address object will be required

bankDetails
object
required

Bank details of the Payee. The required fields depend on the currency and can be found here.

string
enum
required

3 letter ISO 4217 code of the currency in which the Payee's bank account is held.

Allowed:
string

Id of the End User for who you want to create the Payee.
If not set, the Payee will be created for the Member.

string
required

Full name of the Payee.

string
enum
required
Allowed:
metadata
array of strings
metadata
Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json