Skip to main content


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


id ● ID! non-null scalar

date ● Date! non-null scalar

Date of payment initiation

amount ● Money! non-null scalar

beneficiary ● Beneficiary! non-null union

Details of person/entity who received the payment

status ● PaymentInitiationStatus! non-null union

Contains details relating to the status of the payment

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.

settlement ● Settlement object

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

payerReference ● String scalar

The payment reference that appears on the payers's statement

merchant ● String scalar

The name or unique identifier for the merchant

beneficiaryReference ● String scalar

The payment reference that appears on the beneficiary's statement

externalReference ● String scalar

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

refunds ● [Refund!]! non-null object

Any refunds associated with this PaymentInitiation

expireAt ● Date scalar

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

restrictPayerBank ● PayerBankId enum

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


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.