Skip to main content

CreditTransferInput

Credit transfer

input CreditTransferInput {
  amount: AmountInput!
  externalReference: String
  label: String
  labelType: LabelType
  categoryPurpose: CategoryPurpose
  mode: CreditTransferMode
  reference: String
  requestedExecutionAt: DateTime
  sepaBeneficiary: SepaBeneficiaryInput
  beneficiaryVerificationToken: String
  swanAccountBeneficiary: SwanAccountBeneficiaryInput
  trustedBeneficiaryId: ID
}

Fields​

CreditTransferInput.amount ● AmountInput! non-null input​

amount of the transfer

CreditTransferInput.externalReference ● String scalar​

an arbitrary identifier that you can define to easily identify this transaction later

CreditTransferInput.label ● String scalar​

label (max 140 characters)

CreditTransferInput.labelType ● LabelType enum​

labelType (default: unstructured)

CreditTransferInput.categoryPurpose ● CategoryPurpose enum​

** COMING SOON** categoryPurpose - Purpose of the payment transaction

CreditTransferInput.mode ● CreditTransferMode enum​

if the transfer will execute as instant and fallbacked to a regular one if an error happend during the instant transfer

CreditTransferInput.reference ● String scalar​

reference assigned by the initiating party, to unambiguously identify the transaction. This reference is passed on, unchanged, throughout the entire end-to-end chain (regex [a-zA-Z0-9-?.+,/':() ]{1,35} and cannot begin nor end with /. Also, // is not allowed)

CreditTransferInput.requestedExecutionAt ● DateTime scalar​

requested date at which the credit transfer will try to be executed, if null the credit transfer is executed right away

CreditTransferInput.sepaBeneficiary ● SepaBeneficiaryInput input​

if the transfer will credit a new SEPA beneficiary

CreditTransferInput.beneficiaryVerificationToken ● String scalar​

If the transfer will credit a SEPA beneficiary, Swan account, or a trusted beneficiary and where beneficiary verification was prepared using the 'verifyBeneficiary' mutation. Mandatory for bulk SEPA credit transfers, unless the account opts out of Verification of Payee.

CreditTransferInput.swanAccountBeneficiary ● SwanAccountBeneficiaryInput input​

if the transfer will credit a new swan account beneficiary

CreditTransferInput.trustedBeneficiaryId ● ID scalar​

if the transfer will credit an existing beneficiary

Member Of​

InitiateCreditTransfersInput input