Payee API

Confirmation Of Payee (Source Bank to Nexus)
GET /v1/payee/
Request
Attribute
Type
Condition
Description
Destination Country ID
String
Mandatory
Two-letter country code for Destination Country
Destination Bank Identifier
String
Mandatory
Required for routing purposes
Destination Bank Account Number
String
Mandatory
Used for validation purposes
Destination Bank Account Holder Expected Name
String
Conditional
Expected Name to be matched if Comparison model is used
Response
Attribute
Type
Condition
Description
CoP Type
String
Mandatory
Model of CoP used in this result. Comparison, Nickname or RealName
CoP Match Status
String
Conditional
If Comparison model used, shows result: Full Match, Close Match, None
Destination Bank Account Holder Name
String
Conditional
Unmasked full name, for sanctions checking purposes, not to be disclosed to end-customer. Availability of this field may be dependent on local regulation.
Destination Bank Account Display Name
String
Conditional
Name to be displayed to the end-customer if Nickname or RealName model is used. May contain full official name, partially masked name or nickname.
Sub Process: Confirmation of Payee (Destination Nexus Gateway to Destination IPS / Destination Bank)
This step is triggered by Nexus as it responds to the Confirmation of Payee request above The Confirmation of Payee request will follow local standards, as configured by Nexus, as this is a request from the Nexus Gateway to the Destination IPS or Destination Bank. However, as a minimum, the Destination IPS or Destination Bank must return the following information to the Nexus Gateway:
Response – Minimum Fields
Field
Condition
CoP Match
Mandatory if Comparison Model used
Destination Bank Account Holder Name
Mandatory if Real Name is used
Destination Bank Account Display Name
Mandatory if Nickname is used or real name cannot be shown to end user due to privacy rules

Last modified 1yr ago

Attribute	Type	Condition	Description
Destination Country ID	String	Mandatory	Two-letter country code for Destination Country
Destination Bank Identifier	String	Mandatory	Required for routing purposes
Destination Bank Account Number	String	Mandatory	Used for validation purposes
Destination Bank Account Holder Expected Name	String	Conditional	Expected Name to be matched if Comparison model is used

Field	Condition
CoP Match	Mandatory if Comparison Model used
Destination Bank Account Holder Name	Mandatory if Real Name is used
Destination Bank Account Display Name	Mandatory if Nickname is used or real name cannot be shown to end user due to privacy rules