PayerDeprecated
This section includes information around Stitch products and features that are now deprecated. Deprecated aspects of Stitch's plaform are no longer being supported or improved upon.
If you are currently using a deprecated Stitch product, please consider upgrading to one of our newer and equivalent offerings.
The payer field is a set of inputs supplied when creating an account linking request (also known as a payment authorization request).
This allows us to collect more KYC (Know Your Customer) information that is used to increase the efficacy of fraud related checks.
The following table outlines the possible payer 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 the client platform. |
| name | The full name of the user, including any known segments like initials, first name, middle name and surname. This is required by default. |
| payerCreatedDate | The date that the user account was created/registered with the client in the following format: yyyy-MM-dd platform. |
| phoneNumber | 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. | |
| identityNumber | The national identity document number of the user. |
| passportNumber | The national passport document number of the user. |
| businessRegistrationNumber | The business registration number of the user's business. |
| reference | The reference that will appear on the payer's statement. |
Providing payer information
During payment authorization
An example of a GraphQL mutation to create an account linking request (also known as a payment authorization request) with the appropriate payer inputs is shown below:
During payment initiation
Payer information can also be provided via the payerInformation field on the UserInitiatePayment mutation input. This is recommended to always be populated, using the most up-to-date user information on record, in case of any updates made to this following the initial payment authorization being created.
Please note that:
- The
payerand the following inputs are required by default:name,reference. - All inputs, excluding
reference, have client specific validation configuration. - The validation configuration is determined based on the client's specific needs and associated industry risk profiles.
- High-risk clients may be configured to have more 'payer' inputs being required with stricter validation checks.
- The fields
payerId,name,payerCreatedDate,phoneNumber,email,identityNumber,passportNumber, andbusinessRegistrationNumbereach support the configurable validation options mentioned below.
| 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 |
Testing Payer Input
To test tis process your browser and run all the GraphQL examples in this guide prior to integrating with Stitch, you can use our sandbox and follow the LinkPay integration process guide for a more complete example. Learn more about the sandbox here.