Skip to main content

ClientPaymentAuthorizationRequestCreatePayerInput

Details required to identify the authorized user.

input ClientPaymentAuthorizationRequestCreatePayerInput {
  name: String!
  email: EmailAddress
  phoneNumber: String
  reference: String!
  identityNumber: String
  passportNumber: String
  accountNumber: String
  restrictPayerBank: PayerBankId
  payerId: String
  payerCreatedDate: String
  businessRegistrationNumber: String
}

Fields​

ClientPaymentAuthorizationRequestCreatePayerInput.name ● String! non-null scalar​

The name of the user

ClientPaymentAuthorizationRequestCreatePayerInput.email ● EmailAddress scalar​

Email address of the user. Either email or phone number must be supplied.

ClientPaymentAuthorizationRequestCreatePayerInput.phoneNumber ● String scalar​

Phone number of the user. Either email or phone number must be supplied.

ClientPaymentAuthorizationRequestCreatePayerInput.reference ● String! non-null scalar​

The reference will appear on the payer's statement

ClientPaymentAuthorizationRequestCreatePayerInput.identityNumber ● String scalar​

South African Identity number of the user. Either identity number or account number must be provided for CapitecPay

ClientPaymentAuthorizationRequestCreatePayerInput.passportNumber ● String scalar​

Unique government issued identifier for the user

ClientPaymentAuthorizationRequestCreatePayerInput.accountNumber ● String scalar​

Account number of the user making the payment. Either identity number or account number must be provided for CapitecPay

ClientPaymentAuthorizationRequestCreatePayerInput.restrictPayerBank ● PayerBankId enum​

Optional BankId used to restrict the bank a user may pay from.

ClientPaymentAuthorizationRequestCreatePayerInput.payerId ● String scalar​

The client's internal identifier for the user.

ClientPaymentAuthorizationRequestCreatePayerInput.payerCreatedDate ● String scalar​

The date when the user account was created with the client

ClientPaymentAuthorizationRequestCreatePayerInput.businessRegistrationNumber ● String scalar​

The user's business registration