Skip to main content

InitiateFundingRequestInput

Input to initiate a funding request

input InitiateFundingRequestInput {
  fundingSourceId: ID!
  amount: AmountInput!
  reference: String
  label: String
  consentRedirectUrl: String!
  requestedExecutionAt: DateTime
  isInstant: Boolean
  idempotencyKey: String
}

Fields​

InitiateFundingRequestInput.fundingSourceId ● ID! non-null scalar​

ID of the funding source to be used to fund the concerned account

InitiateFundingRequestInput.amount ● AmountInput! non-null input​

Amount of the requested funding, i.e. amount that will credit the concerned Swan account and debit the external funding source.

InitiateFundingRequestInput.reference ● String scalar​

Reference of the funding request that will be shown on the account holder statement and on the debtor account used.

InitiateFundingRequestInput.label ● String scalar​

Label of the funding request that will be shown on the account holder statement and on the debtor account used Always starts with 'Partner Name' truncated at 19 characters followed by a space. If empty, default label is "Partner Name - Account Holder Name".

InitiateFundingRequestInput.consentRedirectUrl ● String! non-null scalar​

Url to which the authorized account member must be redirected once the consent has been finalized.

InitiateFundingRequestInput.requestedExecutionAt ● DateTime scalar​

When the funding request should be executed. If null, it will be executed as soon as possible. It is not possible to define this value when the option isInstant is set to true.

InitiateFundingRequestInput.isInstant ● Boolean scalar​

SOON TO BE DEPRECATED If true the funds should be available immediately. If false or null, the funds will be available after the resolution of the credit transaction.

InitiateFundingRequestInput.idempotencyKey ● String scalar​

A unique key used to ensure this operation executes only once, regardless of how many times it’s submitted. If you provide the same idempotencyKey within a 24-hour period, the API will return the result of the original request rather than executing the operation again. Use UUID v4 format recommended.

Member Of​

initiateFundingRequest mutation