Skip to main content

UserPaymentInitiationRequestCreateInput

No description

input UserPaymentInitiationRequestCreateInput {
  amount: MoneyInput!
  beneficiary: BeneficiaryInput!
  payerReference: String!
  beneficiaryReference: String!
  externalReference: String
  payerConstraint: UserPaymentInitiationRequestCreatePayerConstraintInput
  merchant: String
  expireAt: Date
  restrictPayerBank: PayerBankId
}

Fields

`amount` ● `MoneyInput!` non-null input

`beneficiary` ● `BeneficiaryInput!` non-null input

The entity receiving the payment.

`payerReference` ● `String!` non-null scalar

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

`beneficiaryReference` ● `String!` non-null scalar

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

`externalReference` ● `String` scalar

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

`payerConstraint` ● `UserPaymentInitiationRequestCreatePayerConstraintInput` input

Optional input used to further constrain which accounts may be used to initiate the payment

`merchant` ● `String` scalar

The name or unique identifier for the merchant

`expireAt` ● `Date` scalar

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

`restrictPayerBank` ● `PayerBankId` enum

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

Fields