Skip to main content

PaymentInitiation

Details of the authorized payment initiation.

type PaymentInitiation implements Node {
  id: ID!
  date: Date!
  amount: Money!
  beneficiary: Beneficiary!
  status: PaymentInitiationStatus!
  paymentConfirmation: PaymentConfirmation
  settlement: Settlement
  payerReference: String
  merchant: String
  beneficiaryReference: String
  externalReference: String
  refunds: [Refund!]!
  expireAt: Date
  restrictPayerBank: PayerBankId
}

Fields​

PaymentInitiation.id ● ID! non-null scalar​

PaymentInitiation.date ● Date! non-null scalar​

Date of payment initiation

PaymentInitiation.amount ● Money! non-null scalar​

PaymentInitiation.beneficiary ● Beneficiary! non-null union​

Details of person/entity who received the payment

PaymentInitiation.status ● PaymentInitiationStatus! non-null union​

Contains details relating to the status of the payment

PaymentInitiation.paymentConfirmation ● PaymentConfirmation union​

This field indicates the state of the payment relative to the Stitch intermediary account. If your client is not configured with an intermediary account, this field will remain null.

PaymentInitiation.settlement ● Settlement object​

A settlement represents a payout made to a client bank account.

PaymentInitiation.payerReference ● String scalar​

The payment reference that appears on the payers's statement

PaymentInitiation.merchant ● String scalar​

The name or unique identifier for the merchant

PaymentInitiation.beneficiaryReference ● String scalar​

The payment reference that appears on the beneficiary's statement

PaymentInitiation.externalReference ● String scalar​

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

PaymentInitiation.refunds ● [Refund!]! non-null object​

Any refunds associated with this PaymentInitiation

PaymentInitiation.expireAt ● Date scalar​

Optional Date (ISO 8601) field used to set an expiry on a payment

PaymentInitiation.restrictPayerBank ● PayerBankId enum​

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

Interfaces​

Node interface​

An abstract datatype that has a locally unique identifier, allowing a given node to be later queried by id using the node(id: ID!) query.