# Payment

Endpoint to retrieve data for payments.

## Finds payments by filtering a specific conference(frame).

> Gets \`Payment\` objects.

```json
{"openapi":"3.1.1","info":{"title":"Converia API","version":"2.15.0"},"tags":[{"name":"Payment","description":"Endpoint to retrieve data for payments."}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"description":"Api key has to be used to authenticate against the server. The token parameter has must be sent in the header","type":"apiKey","name":"token","in":"header"}},"schemas":{"Payment":{"type":"object","description":"Represents the payment entity in Converia.","required":["id","invoice","bookingDate","actualReceiptOfDate","sum","paymentKind","fee","userId","insertTime","internalReference","externalReference","canceledPaymentReferenceId","reasonForCancellation","bankAccountNumber","bankCode","bankReferenceText"],"properties":{"id":{"type":"integer","description":"The primary key of the payment entity in Converia."},"invoice":{"type":"integer","description":"The id of the related invoice."},"bookingDate":{"type":"string","description":"The date when the payment was initiated.","format":"ISO-8601"},"actualReceiptOfDate":{"type":"string","description":"The date when the payment was actually received.","format":"ISO-8601"},"sum":{"type":"number","description":"The total sum of the booking price."},"paymentKind":{"type":"string","enum":["T","FREE","IS","EP","INTERN","BESR","DATATRANS","SAFERPAY","CC","CT_ELV","CT_SOFORT","CONCARDIS","OGONE","PAYPAL","GS","HEIDELPAY","SPARKASSE","OSP_CARD","POSTFINANCE"],"description":"Represents the type of the payment:\n * `T` - Transfer\n * `FREE` - Free participation\n * `IS` - On-site payment\n * `EP` - Credit Card via Easypay\n * `INTERN` - Internal Payment\n * `BESR` - BESR payment slip\n * `DATATRANS` - Datatrans\n * `SAFERPAY` - Saferpay\n * `CC` - Credit Card via CompuTop\n * `CT_ELV` - Computop ELV\n * `CT_SOFORT` - Computop SOFORT\n * `CONCARDIS` - Concardis\n * `OGONE` - Ogone\n * `PAYPAL` - Paypal\n * `GS` - GassenSchmidt\n * `HEIDELPAY` - Heidelpay\n * `SPARKASSE` - InternetKasse\n * `OSP_CARD` - On-site payment with card\n * `POSTFINANCE` - PostFinance"},"fee":{"type":"number","description":"The fee related to the payment."},"userId":{"type":"integer","description":"Id of the backend user who triggert the payment. Fallback to -1 if frontend user has triggert the payment."},"insertTime":{"type":"string","description":"The date when this payment entry was initially inserted in the database.","format":"ISO-8601"},"internalReference":{"type":"string","description":"Internal reference code. This reference code isn't unique."},"externalReference":{"type":"string","description":"External identifier provided by the payment provider."},"canceledPaymentReferenceId":{"type":"integer","description":"Default 0. If greater 0 this entry is a cancellation, which references the corresponding payment entry.","minimum":0},"reasonForCancellation":{"type":"string","description":"The reason for the cancellation."},"bankAccountNumber":{"type":"string","description":"The bank account number","format":"Normal bank account number or IBAN"},"bankCode":{"type":"string","description":"The bank identifier code.","format":"Normal bank code number or BIC"},"bankReferenceText":{"type":"string","description":"The reference text."}}},"ErrorResult":{"type":"object","description":"Result format in an error case.","required":["errors"],"properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}},"Error":{"type":"object","description":"Format of an error.","required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}}}}},"paths":{"/rest-api/v2/frame/{id}/payment/":{"get":{"tags":["Payment"],"description":"Gets `Payment` objects.","summary":"Finds payments by filtering a specific conference(frame).","parameters":[{"schema":{"type":"integer","format":"int64"},"name":"id","in":"path","description":"Id of the conference the payments are loaded for.","required":true},{"schema":{"type":"array","items":{"type":"string","enum":["T","FREE","IS","EP","INTERN","BESR","DATATRANS","SAFERPAY","CC","CT_ELV","CT_SOFORT","CONCARDIS","OGONE","PAYPAL","GS","HEIDELPAY","SPARKASSE","OSP_CARD","POSTFINANCE"]}},"style":"form","explode":false,"name":"payment-kind","in":"query","description":"Filter for specific payment kinds:\n * `T` - Transfer\n * `FREE` - Free participation\n * `IS` - On-site payment\n * `EP` - Credit Card via Easypay\n * `INTERN` - Internal Payment\n * `BESR` - BESR payment slip\n * `DATATRANS` - Datatrans\n * `SAFERPAY` - Saferpay\n * `CC` - Credit Card via CompuTop\n * `CT_ELV` - Computop ELV\n * `CT_SOFORT` - Computop SOFORT\n * `CONCARDIS` - Concardis\n * `OGONE` - Ogone\n * `PAYPAL` - Paypal\n * `GS` - GassenSchmidt\n * `HEIDELPAY` - Heidelpay\n * `SPARKASSE` - InternetKasse\n * `OSP_CARD` - On-site payment with card\n * `POSTFINANCE` - PostFinance","required":false}],"responses":{"200":{"description":"Successful response","headers":{"X-Rate-Limit-Interval":{"schema":{"type":"integer"},"description":"Interval of a time window in seconds"},"X-Rate-Limit-Reset":{"schema":{"type":"integer"},"description":"The remaining window before the credit limit resets in seconds"},"X-Rate-Limit-Remaining":{"schema":{"type":"integer"},"description":"The number of credits left for the time window"},"X-Rate-Limit-Limit":{"schema":{"type":"integer"},"description":"Credit limit per time window"}},"content":{"application/json":{"schema":{"title":"Result Record","type":"object","required":["data"],"properties":{"meta":{"type":"object"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"401":{"description":"Authentication problem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"404":{"description":"No resource found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"429":{"description":"Rate limitation exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}},"500":{"description":"Internal error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResult"}}}}}}}}}
```