Payer Information
The payerInformation field is a set of inputs on a Payment Request, that allow us to collect more KYC (Know Your Customer) information. This set of information is used to increase the efficacy of fraud related checks.
The following table outlines the possible payerInformation inputs:
| Input | Description |
|---|---|
| payerId | A unique internal identifier/reference for the user. This value is expected to be stable and that it will ordinarily remain the same over the lifespan of a user doing business with you. This field is also required for saving bank accounts or cards per user. |
| fullName | A full name of the user, including any known segments like initials, first name, middle name and surname. |
| accountCreatedDate | A date that the user account was created/registered with the client in the following format: yyyy-MM-dd. |
| mobileNumber | A valid mobile number that can be used to verify the users contact detail and/or for communication with the user. In case the user is a business, this could be the mobile number of a designated/authorized contact person associated with the business. |
| A valid email address that can be used to verify the users contact detail and/or for communication with the user. In case the user is a business, this could be the email address of a designated/authorized contact person associated with the business. | |
| identifyingDocument | The national identity document or passport of the user. This includes the number and issuing country of the document. |
| businessRegistration | The business registration details of the user. It includes the business registration number and country of registration. |
An example of a GraphQL request to create a payment initiation request with the additional payer information (payerInformation) is shown below:
Please note that:
- The
payerInformationand its inputs are optional by default, and have client specific validation configuration. - Validation is determined based on specific client and associated industry risk profiles, with high risk clients having more payer information inputs set to being required.
- Each of the payer information fields supports the following configurable validation options:
| Option | Description |
|---|---|
| IsRequired | Whether the input is required or not |
| MinLength | The minimum character length for the input (this only applies to string/text inputs) |
| MaxLength | The maximum character length for the input (this only applies to string/text inputs) |
| Pattern | A regular expression pattern to be used to test validity of the input |
Retrieving payment requests with associated Payer Information
Payer Information can be included in any queries for payment requests via the Client node on the Stitch API. Please see Pagination
for more information about the query parameters.
Note that this request needs a client token with the client_paymentrequest scope.
Testing Payer Information
To test this process on your browser and run all the GraphQL examples in this guide prior to integrating with Stitch, you can use our sandbox. Learn more about the sandbox here.