Check the status of your first Direct Debit request

This guide walks you through the process of checking the status of a direct debit collection in the sandbox environment. It follows on from the guide to Create your first Direct Debit Collection.

Before You Start

Ensure you have the following:

• A payment ID from a previously created direct debit collection
• Valid authentication token (Bearer token)
• Access to the sandbox environment

Step-by-Step Guide

Step 1: Prepare Your Request

1. Base URL:
   Use the appropriate environment URL:

   • Sandbox: https://sepaexpress-sand-fx.azurewebsites.net
   • Production: https://sepaexpress-prod-fx.azurewebsites.net

2. Endpoint:
   GET /api/services/v2/Payments/{paymentId}

3. Required Headers:

Accept: application/json
Content-Type: application/json
Authorization: Bearer {your-access-token}

Step 2: Make the Status Request

curl --location --request GET 'https://sepaexpress-sand-fx.azurewebsites.net/api/services/v2/Payments/{paymentId}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {your-access-token}'

Replace {paymentId} with the ID you received when creating the payment.

Step 3: Process the Response

A successful response (200 OK) will look like this:

{
      "payment": {
          "id": "b0109fa3a03aa48bb0691d007a04b2cc",
          "merchantId": "ed2a8e8a87f2e7a6093a8969b3874d65",
          "connectorId": "6f1cebbb863ffe22d4f73ac2aebedaf3",
          "customerId": "b51191d7a45296d61e4c645b2113638b",
          "bankAccountId": "e209fc86d8e9eec3dbb7a8f54dba5e8b",
          "mandateId": "ffe1af72ba4dc9599bfad042cae9407e",
          "createdAt": "2020-03-12T08:19:05.0049479",
          "state": "paid",
          "currencyCode": "EUR",
          "amount": 1,
          "reference": "150e7aa92784e0df56363f0f1bf7211c",
          "softDescriptor": "SEPA Direct Debit End2End-Ref: 150e7aa92784e0df56363f0f1bf7211c Mandate-Ref: e0c2a3058798aa82f44f6e610cfd6615",
          "refundCount": 0,
          "refundAmount": 0,
          "submitAfter": "2020-03-12T08:19:05.0049479"
      }
  }

Next steps: reporting

A range of reporting options is available to help you monitor and reconcile your payments. We recommend starting with:

1. Reconciliation Report – View all payments booked to your account and affecting your balance. Read more about the Reconciliation report.
2. Rejection Reports – Track API and scheme rejections to quickly identify issues. Learn how to handle SEPA Direct Debit Rejections.
3. Webhooks – Receive real-time notifications for processed payments. Read more about Webhooks.

These reports and notifications help you stay on top of your account activity and ensure smooth operations.