Skip to main content

InitiateMerchantPaymentCollectionInput

No description

input InitiateMerchantPaymentCollectionInput {
  amount: AmountInput!
  label: String
  reference: String
  externalReference: String
  internalDirectDebit: InternalDirectDebitPaymentCollectionInput
  idempotencyKey: String
}

Fields​

InitiateMerchantPaymentCollectionInput.amount ● AmountInput! non-null input​

Amount of the concerned payment collection. For check deposit, the amount should not exceed 10 000€.

InitiateMerchantPaymentCollectionInput.label ● String scalar​

Label of the concerned payment collection, which will be displayed on Swan bank statement - For checks transaction, if empty, default label will be set as "Check N° [1st part of CMC7 - 7 char.]

InitiateMerchantPaymentCollectionInput.reference ● String scalar​

end-to-end reference of the concerned payment collection

InitiateMerchantPaymentCollectionInput.externalReference ● String scalar​

external reference (JSON) that can be used by the Swan merchant for reconciliation purposes

InitiateMerchantPaymentCollectionInput.internalDirectDebit ● InternalDirectDebitPaymentCollectionInput input​

Internal direct debit type of payment collection

InitiateMerchantPaymentCollectionInput.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​

initiateMerchantPaymentCollection mutation