Create a payment link
is currently in development. Feel free to review this section to understand how the feature will work when live.
Create a payment link to accept card payments with the API.
Payment links redirect customers to a Swan-hosted payment page where a customer can choose from the merchant's eligible enabled payment methods. These optimized payment pages are customizable with the merchant's name, logo, and accent color.
Your merchants can create links to share with their customers by email or text message. They could also include a QR code on an invoice, scannable by the customer with their mobile device.
- Merchant profile status:
Enabled
- Card payment method status:
Enabled
Guide​
- Call the
createMerchantPaymentLink
mutation. - Add the
merchantProfileId
. - Payment method (line 6):
- If you only want to allow card payments, add the card
paymentMethodId
. - If you'd like to allow all eligible enabled payment methods, don't provide a value for
paymentMethodId
.
- If you only want to allow card payments, add the card
- Add the
amount
, including both thevalue
andcurrency
. - Include a
label
andreference
if you'd like. - Add the success payload. Include the final
url
in the payload if you'd like (line). - Add rejections (not shown).
If the merchant has both Core and Standard SEPA Direct Debit enabled and you don't provide a value for paymentMethodId
in #3, Core is used by default.
Mutation​
🔎 Open the mutation in API Explorer
mutation PaymentLink {
createMerchantPaymentLink(
input: {
merchantProfileId: "$MERCHANT_PROFILE_ID"
amount: { value: "50", currency: "EUR" }
paymentMethodIds: ""
label: ""
reference: ""
}
) {
... on CreateMerchantPaymentLinkSuccessPayload {
__typename
merchantPaymentLink {
url
}
}
}
}