Fetch inbound transactions using TXN ID:

GET /responder/pay.uk/v2.0/confirmation-payee/name-verification/{id}

This API is used to fetch detailed information of the inbound transaction history using transaction ID.

Request Headers

Attribute	Type	Condition	Description
authorization	String	Mandatory	An authorisation token as per https://tools.ietf.org/html/rfc6750

Request parameter

Attribute	Type	Condition	Description
Id	UUID	Mandatory	Unique Id sent by the requester for every request in UUID4 format for cross reference purpose.

Response Body

Attribute	Type	Condition	Description
id	String	Mandatory	A unique id is generated for every inbound transaction
RequestTimeReceived	String	Mandatory	This shows the request received time by the responder
RequestSchemeName	String	Mandatory	Specifies the account identification scheme name
RequestAccountType	String	Mandatory	Defines the Payee account type as Personal or Business
RequestIdentification	String	Mandatory	This field identifies the Payee account number format with values like IBAN or SCAN
RequestSecondaryIdentification	String	Optional	Secondary reference for the account
RequestName	String	Mandatory	Name of the Payee account
RequestOrgId	String	Mandatory	This field contains the name of the Requester Bank's Organization’s ID
PayeeAccountRestrictedCode	String	Conditional	The responder results that are sent to the requestor, typically in case of requested payee account has Name check restrictions. Eg. OPTO, ACNS, CASS
PayeeAccountType	String	Mandatory	Identities the Payee account type as Personal or Business
ResponseTimeSent	String	Mandatory	This shows the response time sent back to the requester
ResponseMatched	String	Mandatory	The Payee name matching results from the responder, the values will be True or false
ResponseReasonCode	String	Conditional	The responder results that are sent to the requestor, typically in case of NO_MATCH or PARTIAL_MATCH or UNABLE_TO_MATCH results. E.g. MBAM, OPTO, ACNS, etc.
RequestedOrgName	String	Mandatory	This field contains the name of the Requester Bank's Organization’s Name
IsPayeeAccountFound	Boolean	Mandatory	Based on the requestors bank account details are present in responder's database. The values will be True or false
IsPayeeAccountRestricted	Boolean	Mandatory	If the requesting payee account has any name check restrictions, based on that it has values like True or false

Response Codes

Status Code	Description
200	Verification is pending
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
406	Not Acceptable
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable

Response:

{
  "result": {
    "Id": "SXFY1777358",
    "RequestTimeReceived": "2024-10-22T08:02:26.633939Z",
    "RequestSchemeName": "SortCodeAccountNumber",
    "RequestAccountType": "Personal",
    "RequestIdentification": "10000022456709",
    "RequestName": ",,Micael Nicholas",
    "RequestOrgId": "N9QOI4uiKOeUp8qa66",
    "PayeeAccountType": "Personal",
    "ResponseTimeSent": "2024-10-22T08:02:26.934885Z",
    "ResponseMatched": true,
    "RequestedOrgName": "Banfico Ltd",
    "IsPayeeAccountFound": true,
    "IsPayeeAccountRestricted": false
  },
  "links": {}
}