Create a payment link

Create a payment link to accept card payments with the API.

Prerequisites

• Merchant profile status: Enabled
• Card payment method status: Enabled
• Account member permission: canManageAccountMembership

Guide

1. Call the createMerchantPaymentLink mutation (line 2).
2. Add the merchantProfileId (line 4).
3. Add the amount, including both the value and currency (line 5).
4. Add your card paymentMethodId (line 6).
5. Include a label and reference if you'd like (lines 7-8). Note that the label might appear on the payer's card statement.
6. Add the success payload (line 11). Include the final url in the payload if you'd like (line 14).
7. Add rejections (not shown).

Mutation

Open in API Explorer

mutation PaymentLink {
  createMerchantPaymentLink(
    input: {
      merchantProfileId: "$MERCHANT_PROFILE_ID"
      amount: { value: "50", currency: "EUR" }
      paymentMethodIds: "$PAYMENT_METHOD_ID"
      label: "Your custom label"
      reference: "YourReference"
    }
  ) {
    ... on CreateMerchantPaymentLinkSuccessPayload {
      __typename
      merchantPaymentLink {
        url
      }
    }
  }
}

Payload

Notice the payment link to share with the merchant's customer in the success payload (line 6).

{
  "data": {
    "createMerchantPaymentLink": {
      "__typename": "CreateMerchantPaymentLinkSuccessPayload",
      "merchantPaymentLink": {
        "url": "https://payment.sandbox.swan.io/$MERCHANT_PAYMENT_ID?lang=en"
      }
    }
  }
}