Payment

Retrieves the collection of Payment resources.

get

Retrieves the collection of Payment resources.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

id[between]stringOptional

id[gt]stringOptional

id[gte]stringOptional

id[lt]stringOptional

id[lte]stringOptional

Responses

200

Payment collection

application/ld+jsontext/html

hydra:totalItemsintegerOptional

get

/api/payments

HTTPcURLJavaScriptPython

GET /api/payments HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Payment collection

{
  "hydra:member": [
    {
      "@id": "text",
      "@type": "text",
      "@context": "text",
      "id": 1,
      "amount": 1,
      "internalReference": "text",
      "additionalInfo": "text",
      "externalReference": "text",
      "transactionDate": "2026-03-03T02:47:46.894Z",
      "valueDate": "2026-03-03T02:47:46.894Z",
      "insertDate": "2026-03-03T02:47:46.894Z",
      "uniqueTransactionId": "text",
      "importedAccountNumber": "text",
      "importedBankCode": "text",
      "importedPayerName": "text",
      "userType": "",
      "backendUserId": 1,
      "correctionForPayment": "/entitiy/1",
      "invoice": "/entitiy/1",
      "paymentMethod": "/entitiy/1"
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "text",
    "hydra:template": "text",
    "hydra:variableRepresentation": "text",
    "hydra:mapping": [
      {
        "@type": "text",
        "variable": "text",
        "property": "text",
        "required": true
      }
    ]
  }
}

Retrieves a Payment resource.

get

Retrieves a Payment resource.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Resource identifier

Responses

200

Payment resource

application/ld+jsontext/html

Payment

@idstringRead-onlyOptional

@typestringRead-onlyOptional

@contextone ofRead-onlyOptional

stringOptional

or

idintegerOptional

amountnumberOptional

internalReferencestringOptional

additionalInfostringOptional

externalReferencestringOptional

transactionDatestring · date-timeOptional

valueDatestring · date-time · nullableOptional

insertDatestring · date-timeOptional

uniqueTransactionIdstringOptional

Unique transaction id, only used for some payment methods

importedAccountNumberstringOptional

importedBankCodestringOptional

importedPayerNamestringOptional

userTypestring · enumOptionalPossible values:

backendUserIdintegerOptional

correctionForPaymentstring · iri-reference · nullableOptional

invoicestring · iri-referenceOptional

paymentMethodstring · iri-referenceOptional

404

Resource not found

get

/api/payments/{id}

HTTPcURLJavaScriptPython

GET /api/payments/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "@id": "text",
  "@type": "text",
  "@context": "text",
  "id": 1,
  "amount": 1,
  "internalReference": "text",
  "additionalInfo": "text",
  "externalReference": "text",
  "transactionDate": "2026-03-03T02:47:46.894Z",
  "valueDate": "2026-03-03T02:47:46.894Z",
  "insertDate": "2026-03-03T02:47:46.894Z",
  "uniqueTransactionId": "text",
  "importedAccountNumber": "text",
  "importedBankCode": "text",
  "importedPayerName": "text",
  "userType": "",
  "backendUserId": 1,
  "correctionForPayment": "/entitiy/1",
  "invoice": "/entitiy/1",
  "paymentMethod": "/entitiy/1"
}