Skip to main content

Initiate a transaction with French checks

Prerequisites
  • Debtor's account status: any except Closing or Closed
  • Merchant profile status: Enabled
  • Check payment method status: Enabled

Guide​

  1. Confirm you have a project access token or, if you're an account member, a user access token with CanManageAccountMembership permissions.
  2. Call the initiateMerchantPaymentCollection mutation with check, completing all mandatory fields: amount, currency, CMC7, rmlcKey, and merchantProfileId.
  3. You can also include an optional label and reference, which are displayed in your transaction history and to the debtor.

Mutation​

🔎 Open the mutation in API Explorer

Dates

Dates for this mutation use ISO 8601 convention: YYYY-MM-DDTHH-mm-ssZ.

If the date is left empty, the transaction will be executed as soon as possible. If the date indicated is a non-business day, the transaction will be executed on the next business day.

mutation initiateCheck {
  initiateMerchantPaymentCollection(
    input: {
      amount: { value: "500", currency: "EUR" }
      check: {
        merchantProfileId: "$YOUR_MERCHANT_PROFILE_ID"
        cmc7: "3763445075000618908058311038404"
        rlmcKey: "55"
      }
    }
  ) {
    ... on InitiateMerchantPaymentCollectionSuccessPayload {
      __typename
      merchantPaymentCollection {
        id
        statusInfo {
          status
        }
      }
    }
    ... on ValidationRejection {
      __typename
      message
    }
    ... on InternalErrorRejection {
      __typename
      message
    }
    ... on NotFoundRejection {
      id
      message
    }
    ... on ForbiddenRejection {
      __typename
      message
    }
  }
}

Payload​

Note the id for your check payment (line 6) and the status Initiated (line 8).

{
  "data": {
    "initiateMerchantPaymentCollection": {
      "__typename": "InitiateMerchantPaymentCollectionSuccessPayload",
      "merchantPaymentCollection": {
        "id": "spi_b753501f7b0769a9ba5c106087a14881",
        "statusInfo": {
          "status": "Initiated"
        }
      }
    }
  }
}

Next steps​

At this stage, the transaction has been initiated and the following events occur:

  1. Swan:
    1. Confirms that the check amount does not exceed 10 000€.
    2. Verifies that the field formats are consistent with the check provider's specifications.
    3. Creates a checkIn transaction with the status Upcoming. checkIn transactions retain the status Upcoming until the check amount is credited to the Swan settlement account.
  2. Merchant:
    1. Writes their Swan account number on the back of the check.
    2. Signs the back of the check.
    3. Sends the check to Swan's check provider by physical mail within 30 days of the initiateMerchantPaymentCollection mutation call.
  3. Swan's check provider:
    1. Processes the check, after which the status changes to Booked. This can take up to two days.

After a check is Booked, the rolling reserve window starts. After the rolling reserve window, the check amount is added to the account's available balance.

If funds are insufficient for the check deposit, a checkInReturn will appear on your transaction history.