API Reference
Platform OverviewDemoContactImprint

Payment Notifications

Settlement created

{
  "notification_type": "settlement.created",
  "paymentTransaction": null,
  "paymentTransactionIdent": null,
  "tenantId": 10000,
  "creditDebitIndicator": "CREDIT",
  "creationDate": null,
  "bookingDate": "2023-09-20T00:01:36.666Z",
  "valueDate": "2023-09-20T00:01:36.666Z",
  "ident": "4e6ce6dd-d79d-4866-9a44-df751c2b0d96",
  "externalIdent": "externalIdent_E2E00001-c84b-474b-be63-230920000136",
  "customerSpecificIdent": null,
  "recipient": "the_recipient",
  "sender": "the_sender",
  "text": "E2E-02 Test --> payment will be 'manually' assigned via API, no need for an ident here",
  "baseAmount": {
    "amount": 500,
    "currency": "EUR"
  },
  "originalAmount": {
    "amount": 500,
    "currency": "EUR"
  },
  "exchangeRate": {
    "originalCurrency": "EUR",
    "targetCurrency": "EUR",
    "value": 1
  },
  "merchantPaymentAccount": {
    "ident": null,
    "paymentProvider": null,
    "paymentProviderName": null,
    "currency": null,
    "country": null
  },
  "settlementReport": {
    "ident": null,
    "statementReference": null,
    "statementCreationDate": "2023-09-20T00:01:16Z",
    "fileName": null
  },
  "settlementLineNumber": 2,
  "settlementIdentifier": null,
  "fees": [],
  "batchItems": [],
  "paymentCategory": {
    "name": "UNCATEGORISED",
    "assignable": false
  },
  "properties": {
    "GVC": "166"
  }
}

Payment intent result

{
  "notification_type" : "paymentintent.result",
  "tenantId" : 1000,
  "paymentIntentIdent" : "2b1444e1-4a92-4da1-8efa-513c5f25b26a",
  "amount" : {
    "amount" : 10.00,
    "currency" : "EUR"
  },
  "referenceKey" : null,
  "referenceType" : "DOCUMENT",
  "referenceIdent" : "22-01234",
  "statementDescriptor" : "[email protected]",
  "merchantPaymentAccountIdent" : "3646967277",
  "businessSegmentIdent" : "34ec0cc8-9b7c-4ff5-a2b3-4d699b221dfe",
  "paymentIntentStatus" : "FAILED",
  "paymentIntentType" : "CHARGING",
  "paymentIntentResponse" : {
    "ident" : "d046c96a-3720-41e6-9212-898c26566620",
    "externalIdent" : "",
    "customerSpecificIdent" : "",
    "status" : "FAILED",
    "statusMessage" : "(403) Stored payment option reference does not belong to customer account.",
    "bookingDate" : "2022-07-26T07:21:04.072Z",
    "valueDate" : "2022-07-26T07:21:04.072Z",
    "creationDate" : "2022-07-26T07:21:04.072Z",
    "baseAmount" : {
      "amount" : 10.00,
      "currency" : "EUR"
    },
    "originalAmount" : {
      "amount" : 10.00,
      "currency" : "EUR"
    },
    "exchangeRate" : 1,
    "categoryName" : "CUSTOMER_PAYMENT",
    "sender" : null,
    "recipient" : "3646967277"
  },
  "paymentTransaction" : null,
  "customerPaymentAccount" : {
    "tenantId" : 1000,
    "ident" : "2f884a14-5a84-4a0f-ac71-179586f5e8fb",
    "debtorIdent" : "UUID_319a5e1f-b81b-45a4-ac10-d616485e6f47",
    "paymentProviderReference" : "abcde",
    "paymentMethodReference" : "12345",
    "paymentMethod" : "CREDIT_CARD",
    "accountHolderName" : null,
    "name" : null
  }
 }

Payment assignment processed

Explanations:

assignmentDebitCreditIndicator: This field has the same value as the Indicator on the actual payment. 

{
  "notification_type" : "paymentAssignment.processed",
  "assignmentIdent" : "cae8a4c0-4865-40d6-bd29-e0fd1791b9e7",
  "tenantId" : {
    "value" : 1000
  },
  "paymentIdent" : "d4bd0430-3ede-4669-a539-cfcac1f809f6",
  "targetType" : "INVOICE",
  "targetId" : 1037125,
  "targetIdent" : "22-1000-01-0001234",
  "targetTotalAmount" : {
    "amount" : 100.00,
    "currency" : "GBP"
  },
  "assignedAmount" : {
    "amount" : 100.00,
    "currency" : "GBP"
  },
  "assignmentOrigin" : "MANUAL",
  "paymentTransaction" : {
    "ident" : "uuid",
    "externalIdent" : "uuid",
    "tenantId" : 105,
    "paymentDescription" : "22-1000-01-0001234",
    "paymentStatus" : "CAPTURED",
    "paymentAccount" : {
      "ident" : "nbx_stripe_sandbox",
      "paymentProvider" : "STRIPE",
      "paymentProviderName" : "NBX-Stripe-Sandbox",
      "currency" : "EUR",
      "country" : "DE"
    },
    "settlementIdent" : null,
    "settlementCustomerSpecificIdent" : null,
    "bookingDate" : "2022-05-18T09:58:25Z",
    "valueDate" : "2022-05-18T09:58:25Z",
    "baseAmount" : {
      "amount" : 40.00,
      "currency" : "EUR"
    },
    "originalAmount" : {
      "amount" : 100.00,
      "currency" : "GBP"
    },
    "exchangeRate" : {
      "originalCurrency" : "GBP",
      "targetCurrency" : "EUR",
      "value" : 2.50000
    },
    "fees" : [ ],
    "statementReferences" : null,
    "category" : "CUSTOMER_PAYMENT",
    "assignmentDebitCreditIndicator": "CREDIT"
  }
}

Payment assignment reversed

Explanations:

assignmentDebitCreditIndicator: This field has the opposite value from the underlying payment. I.e. if it was a CREDIT payment, then the reversal would be DEBIT. 

{
    "notification_type": "paymentAssignment.reversed",
    "assignmentIdent": "cb3b13a0-55ad-11eb-baa5-181deaaf5b90",
    "reversedAssignmentIdent": "171d5894-f065-43b4-a6d9-95d170a14462",
    "tenantId": 47,
    "paymentIdent": "be8c9b32-2da8-11eb-9f5e-181deaaf5b90",
    "targetType": "INVOICE",
    "targetIdent": "711000113131",
    "reversedAmount": {
        "amount": 2.00,
        "currency": "EUR"
    },
    "assignmentOrigin": "MANUAL",
    "assignmentDebitCreditIndicator": "DEBIT"
}