Skip to main content


No description

input CreateMerchantPaymentLinkInput {
merchantProfileId: ID!
amount: AmountInput!
redirectUrl: URL
cancelRedirectUrl: URL
billingAddress: AddressInput
expiresAt: DateTime
requestedExecutionAt: DateTime
sequence: PaymentMandateSequence
externalReference: String
reference: String
label: String
language: Language
customer: CustomerInput
paymentMethodIds: [String!]


CreateMerchantPaymentLinkInput.merchantProfileId ● ID! non-null scalar

The Merchant Profile to link this Payment Link to

CreateMerchantPaymentLinkInput.amount ● AmountInput! non-null input

Amount to be paid to sucessfully complete the payment.

CreateMerchantPaymentLinkInput.redirectUrl ● URL scalar

Merchant Website URL to redirect the user to when the payment is completed.

CreateMerchantPaymentLinkInput.cancelRedirectUrl ● URL scalar

URL to redirect the user to if they cancel their payment

CreateMerchantPaymentLinkInput.billingAddress ● AddressInput input

The customer billing Address These fields should be completed also to pre-fill a SEPA direct debit mandate.

We strongly advice to complete these fields if merchants want to get paid through card payment method, in order to minimize the risk of payment rejection by Visa / Mastercard schemes

CreateMerchantPaymentLinkInput.expiresAt ● DateTime scalar

The date when the payment link expires. If not specified, the default time will be 120 days

CreateMerchantPaymentLinkInput.requestedExecutionAt ● DateTime scalar

A date that reflects the time at which the user asked the transaction to be executed. For card transactions, request execution must occur within 7 days after authorization or the authorization may expire. For SEPA Direct Debit transactions, request execution must occur up to 1 year in the future.

Default value means that the execution will be as soon as possible

CreateMerchantPaymentLinkInput.sequence ● PaymentMandateSequence enum

Controls if the payment mandate created from this payment link is for one-time use or can be reused This is applicable for card and SEPA Direct Debit payment methods only. If not specified, the default value is OneOff.

CreateMerchantPaymentLinkInput.externalReference ● String scalar

Any string that you want to be attached to this payment link. Usually something to help you reference the link in an external system.

CreateMerchantPaymentLinkInput.reference ● String scalar

Optional field intended to provide a way for you to include a reference number or code. The customer will most likely see this value on their bank statement, though we can't know as every banking platform is different.

CreateMerchantPaymentLinkInput.label ● String scalar

Label of the concerned payment collection, which will be displayed on Swan bank statement and on the Swan merchant payment page.

CreateMerchantPaymentLinkInput.language ● Language enum

The language used for the payment page. Default is the browser's language, or English if not available.

CreateMerchantPaymentLinkInput.customer ● CustomerInput input

We will use the information specified here to prefill the payment link fields depending on the payment method the end user chooses. Keep in mind that your end customer will be able to edit these fields.

CreateMerchantPaymentLinkInput.paymentMethodIds ● [String!] list scalar

List of payment methods enabled for this payment link. If the array is empty, Swan will allow all the payment methods that are enabled for the merchant profile (except for Check and Internal Direct Debit) If you want to make payment possible via SEPA Direct Debit, the list should be populated either by a SEPA Direct Debit CORE or B2B.

Member Of

createMerchantPaymentLink mutation