Request Internal Direct Debit

Before you can accept payments with Internal Direct Debit, you need to request and be approved for the payment method. You can request several payment methods with the same API call.

Payment method review

All new merchant payment methods are reviewed by Swan. Swan might contact you for more information before accepting or rejecting the payment method.

Guide

1. Confirm you have a project access token, or, if you're an account member, a user access token with CanManageAccountMembership user rights.
2. Call the requestMerchantPaymentMethods mutation. You can request a payment method regardless of the status of the merchant profile.
3. Set internalDirectDebitStandard/internalDirectDebitB2b activate to true.
4. The new merchant payment method is created with the status PendingReview and the version number 1.
5. Swan reviews the new merchant payment method and updates the status.

Webhook notification

Go to your Dashboard > Developers > Webhooks to subscribe to the MerchantProfile.updated webhook and receive a notification when the status of your request changes.

Mutation

🔎 Open the mutation in API Explorer

mutation RequestInternalDirectDebit {
  requestMerchantPaymentMethods(
    input: {
      merchantProfileId: "$YOUR _MERCHANT_PROFILE_ID"
      internalDirectDebitB2B: { activate: true }
      internalDirectDebitStandard: { activate: true }
    }
  ) {
    ... on RequestMerchantPaymentMethodsSuccessPayload {
      __typename
      merchantProfile {
        merchantPaymentMethods {
          ... on InternalDirectDebitB2BMerchantPaymentMethod {
            id
            methodId
            rollingReserve {
              percentage
              rollingDays
            }
            type
            statusInfo {
              status
            }
          }
          ... on InternalDirectDebitStandardMerchantPaymentMethod {
            id
            methodId
            rollingReserve {
              percentage
              rollingDays
            }
            type
            statusInfo {
              status
            }
          }
        }
      }
    }
    ... on ForbiddenRejection {
      __typename
      message
    }
    ... on NotFoundRejection {
      id
      message
    }
    ... on InternalErrorRejection {
      __typename
      message
    }
  }
}

Payload

The payload confirms that both InternalDirectDebitStandard and InternalDirectDebitB2b were requested successfully with the payment method status PendingReview.

{
  "data": {
    "requestMerchantPaymentMethods": {
      "__typename": "RequestMerchantPaymentMethodsSuccessPayload",
      "merchantProfile": {
        "merchantPaymentMethods": [
          {
            "id": "592cbd22-8c5c-49a4-a095-4d1d667005e5",
            "methodId": "$PAYMENT_METHOD_ID",
            "rollingReserve": {
              "percentage": "100",
              "rollingDays": "5"
          },
            "type": "InternalDirectDebitStandard",
            "statusInfo": {
              "status": "PendingReview"
            }
          },
          {
            "id": "6aa0baf5-7825-4269-8bdf-163b39a52d55",
            "methodId": "$PAYMENT_METHOD_ID",
            "rollingReserve": {
              "percentage": "100",
              "rollingDays": "5"
          },
            "type": "InternalDirectDebitB2b",
            "statusInfo": {
              "status": "PendingReview"
            }
          }
        ]
      }
    }
  }
}