# Payment

## Retrieves the collection of Payment resources.

> Retrieves the collection of Payment resources.

```json
{"openapi":"3.0.0","info":{"title":"Converia API","version":"3.5.0"},"servers":[{"url":"/","description":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Payment.PaymentDTO.jsonld-payment.read_translation":{"type":"object","description":"Payment","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"id":{"type":"integer"},"amount":{"type":"number"},"internalReference":{"type":"string"},"additionalInfo":{"type":"string"},"externalReference":{"type":"string"},"transactionDate":{"type":"string","format":"date-time"},"valueDate":{"type":"string","format":"date-time","nullable":true},"insertDate":{"type":"string","format":"date-time"},"uniqueTransactionId":{"description":"Unique transaction id, only used for some payment methods","type":"string"},"importedAccountNumber":{"type":"string"},"importedBankCode":{"type":"string"},"importedPayerName":{"type":"string"},"userType":{"$ref":"#/components/schemas/PaymentUserType","type":"string"},"backendUserId":{"type":"integer"},"correctionForPayment":{"type":"string","format":"iri-reference","nullable":true},"invoice":{"type":"string","format":"iri-reference"},"paymentMethod":{"type":"string","format":"iri-reference"}}},"PaymentUserType":{"type":"string","enum":["","frontend","backend"]},"Payment.PaymentDTO-payment.read_translation":{"type":"object","description":"Payment","properties":{"id":{"type":"integer"},"amount":{"type":"number"},"internalReference":{"type":"string"},"additionalInfo":{"type":"string"},"externalReference":{"type":"string"},"transactionDate":{"type":"string","format":"date-time"},"valueDate":{"type":"string","format":"date-time","nullable":true},"insertDate":{"type":"string","format":"date-time"},"uniqueTransactionId":{"description":"Unique transaction id, only used for some payment methods","type":"string"},"importedAccountNumber":{"type":"string"},"importedBankCode":{"type":"string"},"importedPayerName":{"type":"string"},"userType":{"$ref":"#/components/schemas/PaymentUserType","type":"string"},"backendUserId":{"type":"integer"},"correctionForPayment":{"type":"string","format":"iri-reference","nullable":true},"invoice":{"type":"string","format":"iri-reference"},"paymentMethod":{"type":"string","format":"iri-reference"}}}}},"paths":{"/api/payments":{"get":{"operationId":"getPaymentCollection","tags":["Payment"],"responses":{"200":{"description":"Payment collection","content":{"application/ld+json":{"schema":{"type":"object","properties":{"hydra:member":{"type":"array","items":{"$ref":"#/components/schemas/Payment.PaymentDTO.jsonld-payment.read_translation"}},"hydra:totalItems":{"type":"integer","minimum":0},"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}}},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":"string","nullable":true},"required":{"type":"boolean"}}}}}}},"required":["hydra:member"]}},"text/html":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Payment.PaymentDTO-payment.read_translation"}}}}}},"summary":"Retrieves the collection of Payment resources.","description":"Retrieves the collection of Payment resources.","parameters":[{"name":"id[between]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[gt]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[gte]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[lt]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[lte]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false}],"deprecated":false}}}}
```

## Retrieves a Payment resource.

> Retrieves a Payment resource.

```json
{"openapi":"3.0.0","info":{"title":"Converia API","version":"3.5.0"},"servers":[{"url":"/","description":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Payment.PaymentDTO.jsonld-payment.read_translation":{"type":"object","description":"Payment","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"id":{"type":"integer"},"amount":{"type":"number"},"internalReference":{"type":"string"},"additionalInfo":{"type":"string"},"externalReference":{"type":"string"},"transactionDate":{"type":"string","format":"date-time"},"valueDate":{"type":"string","format":"date-time","nullable":true},"insertDate":{"type":"string","format":"date-time"},"uniqueTransactionId":{"description":"Unique transaction id, only used for some payment methods","type":"string"},"importedAccountNumber":{"type":"string"},"importedBankCode":{"type":"string"},"importedPayerName":{"type":"string"},"userType":{"$ref":"#/components/schemas/PaymentUserType","type":"string"},"backendUserId":{"type":"integer"},"correctionForPayment":{"type":"string","format":"iri-reference","nullable":true},"invoice":{"type":"string","format":"iri-reference"},"paymentMethod":{"type":"string","format":"iri-reference"}}},"PaymentUserType":{"type":"string","enum":["","frontend","backend"]},"Payment.PaymentDTO-payment.read_translation":{"type":"object","description":"Payment","properties":{"id":{"type":"integer"},"amount":{"type":"number"},"internalReference":{"type":"string"},"additionalInfo":{"type":"string"},"externalReference":{"type":"string"},"transactionDate":{"type":"string","format":"date-time"},"valueDate":{"type":"string","format":"date-time","nullable":true},"insertDate":{"type":"string","format":"date-time"},"uniqueTransactionId":{"description":"Unique transaction id, only used for some payment methods","type":"string"},"importedAccountNumber":{"type":"string"},"importedBankCode":{"type":"string"},"importedPayerName":{"type":"string"},"userType":{"$ref":"#/components/schemas/PaymentUserType","type":"string"},"backendUserId":{"type":"integer"},"correctionForPayment":{"type":"string","format":"iri-reference","nullable":true},"invoice":{"type":"string","format":"iri-reference"},"paymentMethod":{"type":"string","format":"iri-reference"}}}}},"paths":{"/api/payments/{id}":{"get":{"operationId":"getPaymentItem","tags":["Payment"],"responses":{"200":{"description":"Payment resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Payment.PaymentDTO.jsonld-payment.read_translation"}},"text/html":{"schema":{"$ref":"#/components/schemas/Payment.PaymentDTO-payment.read_translation"}}}},"404":{"description":"Resource not found"}},"summary":"Retrieves a Payment resource.","description":"Retrieves a Payment resource.","parameters":[{"name":"id","in":"path","description":"Resource identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false}}}}
```