Skip to main content

ClientPaymentInitiationRequestCreateInput

All of the data required to create a payment request.

input ClientPaymentInitiationRequestCreateInput {
  amount: MoneyInput!
  merchantId: String
  beneficiary: BeneficiaryInput
  payerReference: String!
  payerInformation: PayerInformationInput
  beneficiaryReference: String!
  externalReference: String
  expireAt: Date
  merchant: String
  iframeAllowlist: [String]
  restrictPayerBank: PayerBankId
  merchantDetails: MerchantDetailsInput
  paymentMethods: PaymentMethodsInput
  metadata: Json
}

Fields​

ClientPaymentInitiationRequestCreateInput.amount ● MoneyInput! non-null input​

ClientPaymentInitiationRequestCreateInput.merchantId ● String scalar​

Optional merchant identifier of the entity receiving the payment based on merchant specific configuration. Either beneficiary or merchantId must be specified.

ClientPaymentInitiationRequestCreateInput.beneficiary ● BeneficiaryInput input​

Optional entity receiving the payment. Either beneficiary or merchantId must be specified.

ClientPaymentInitiationRequestCreateInput.payerReference ● String! non-null scalar​

The payment reference that will appear on the payers's statement. Must be 12 characters or less.

ClientPaymentInitiationRequestCreateInput.payerInformation ● PayerInformationInput input​

Optional payer KYC information. Client config will drive which fields are required if any.

ClientPaymentInitiationRequestCreateInput.beneficiaryReference ● String! non-null scalar​

The payment reference that will appear on the beneficiary's statement. Must be 20 characters or less.

ClientPaymentInitiationRequestCreateInput.externalReference ● String scalar​

Optional reference field that will be present with the redirect query parameters when the payment is completed.

ClientPaymentInitiationRequestCreateInput.expireAt ● Date scalar​

Optional Date (ISO 8061) input used to set an expiry on a payment

ClientPaymentInitiationRequestCreateInput.merchant ● String scalar​

The name or unique identifier for the merchant

ClientPaymentInitiationRequestCreateInput.iframeAllowlist ● [String] list scalar​

List of domains permitted to iframe the safelink page that gets served to the user

ClientPaymentInitiationRequestCreateInput.restrictPayerBank ● PayerBankId enum​

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

ClientPaymentInitiationRequestCreateInput.merchantDetails ● MerchantDetailsInput input​

Optional details specifying the merchant who is issuing the transaction

ClientPaymentInitiationRequestCreateInput.paymentMethods ● PaymentMethodsInput input​

Optional field to configure payment methods.

ClientPaymentInitiationRequestCreateInput.metadata ● Json scalar​

Optional metadata to be associated with the payment initiation request