Validate Recipient's Details

This API call validates recipient's details.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

accountNumber?string

Client account number

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

This is a composite request. It is used when you need to create a recipient.

entity*

A recipient entity used to represent either a consumer or company

payoutMethod*

Payout Method object represent your recipient's payout instrument. This object can be used in combination with registering recipients or as part of a collection of payments.

clientReference*string

Reference for adding recipient set by client. This reference must be unique, if provided previously validation will returned an issue.

Match^[\sa-zA-Z0-9,\.:'\+\?\-/\x26@]{1,35}$

Length1 <= length <= 35

currency?string

Response Body

`application/json`

curl -X POST "https://example.com/v2/recipients/validate" \  -H "Content-Type: application/json" \  -d '{    "entity": {      "type": "Company"    },    "payoutMethod": {      "type": "BankAccount"    },    "clientReference": "string"  }'

Empty

{  "errors": [    {      "errors": [        "string"      ],      "fieldErrors": [        {          "code": "string",          "message": "string"        }      ],      "fieldName": "string"    }  ],  "failureDateTime": "2019-08-24T14:15:22Z",  "longErrorMsg": "string",  "shortErrorMsg": "string",  "traceErrorId": "string",  "typeOfFailure": "MODEL_VALIDATION"}