Check the status of your first direct debit request

Now that you have submitted your first payment, naturally, you will want to keep track of its current status. Each entity, in this example a payment, changes its state several times during its lifetime. These statuses are very useful and provide a good way to keep track of all the processes you initiate when using our API.

Possible Status received back from API:

//Standard response for successful HTTP requets.
{
"webhook": {
"id": "stringstringstringstringstringst",
"createdAt": "2019-08-24T14:15:22Z",
"state": "string",
"url": "string",
"secret": "string",
"additionalHeaders": [],
"configuration": {},
"memo": "string",
"internalNote": "string"
}
}

//The request could not be understood by the server, usually due to malformed syntax.
{
"error": {
"id": "stringstringstringstringstringst",
"code": 0,
"message": "string",
"reasonCode": "string",
"cause": "string",
"trigger": "string",
"token": "string",
"description": "string",
"action": "string",
"bestPractice": "string",
"details": []
}
}

//The client did not provide a valid authentication HTTP header or the user making the request has been disabled.
{
"error": {
"id": "stringstringstringstringstringst",
"code": 0,
"message": "string",
"reasonCode": "string",
"cause": "string",
"trigger": "string",
"token": "string",
"description": "string",
"action": "string",
"bestPractice": "string",
"details": []
}
}

//The requested resource was not found
{
"error": {
"id": "stringstringstringstringstringst",
"code": 0,
"message": "string",
"reasonCode": "string",
"cause": "string",
"trigger": "string",
"token": "string",
"description": "string",
"action": "string",
"bestPractice": "string",
"details": []
}
}

//A rate limit has been reached
{
"error": {
"id": "stringstringstringstringstringst",
"code": 0,
"message": "string",
"reasonCode": "string",
"cause": "string",
"trigger": "string",
"token": "string",
"description": "string",
"action": "string",
"bestPractice": "string",
"details": []
}
}

Append the paymentId you received inside the “create payment” response to the following URL to view the status of the newly created payment:

/api/services/v2/Payments/{id}

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 {{token}}'

Response:

{
      "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"
      }
  }

Thank you for following along our quickstart tutorial. To find out more about our API, keep reading our documentation and/or get in touch with our Client Services team for further information.