{"swagger":"2.0","info":{"description":"Payment API v2 documentation","title":"Payment API v2 documentation"},"host":"localhost","basePath":"/","tags":[{"name":"Account","description":"Account Controller"},{"name":"Bulk Scanning Report","description":"Bulk Scanning Report Controller"},{"name":"Card Payment","description":"Card Payment Controller"},{"name":"Case","description":"Case Controller"},{"name":"Credit Account Payment","description":"Credit Account Payment Controller"},{"name":"Fees","description":"Fees Controller"},{"name":"Maintenance Jobs","description":"Maintenance Jobs Controller"},{"name":"Pay By Account","description":"PBA Controller"},{"name":"Payment","description":"Payment Controller"},{"name":"Payment Record","description":"Payment Record Controller"},{"name":"Payment Reference Data","description":"Payment Reference Data Controller"},{"name":"Payment Report","description":"Payment Report Controller"},{"name":"Payment group","description":"Payment Group Controller"},{"name":"PaymentAllocation","description":"Payment Allocation Controller"},{"name":"PaymentApportion","description":"Fee Pay Apportion Controller"},{"name":"Remissions","description":"Remission Controller"},{"name":"Replay Credit Account Payment","description":"Replay Credit Account Payment Controller"}],"paths":{"/accounts/{accountNumber}":{"get":{"tags":["Account"],"summary":"Get the account status and available balance for a PBA account number","description":"Get the account status and available balance for a PBA account number","operationId":"getAccountsUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"accountNumber","in":"path","description":"Account Number","required":true,"type":"string"}],"responses":{"200":{"description":"Account details retrieved","schema":{"$ref":"#/definitions/AccountDto"}},"404":{"description":"Account not found"},"503":{"description":"Failed to connect with Liberata"}},"deprecated":false}},"/card-payments":{"post":{"tags":["Card Payment"],"summary":"Create card payment","description":"Create card payment","operationId":"createCardPaymentUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"in":"body","name":"request","description":"Request","required":true,"schema":{"$ref":"#/definitions/CardPaymentRequest"}},{"name":"return-url","in":"header","description":"Return URL","required":true,"type":"string"},{"name":"service-callback-url","in":"header","description":"Service Callback Url","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PaymentDto"}},"201":{"description":"Payment created","schema":{"$ref":"#/definitions/PaymentDto"}},"400":{"description":"Payment creation failed"},"422":{"description":"Invalid or missing attribute"}},"deprecated":false}},"/card-payments/{reference}":{"get":{"tags":["Card Payment"],"summary":"Get card payment details by payment reference","description":"Get payment details for supplied payment reference","operationId":"retrieveUsingGET_1","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"reference","in":"path","description":"Payment Reference","required":true,"type":"string"}],"responses":{"200":{"description":"Payment retrieved","schema":{"$ref":"#/definitions/PaymentDto"}},"403":{"description":"Payment info forbidden"},"404":{"description":"Payment not found"}},"deprecated":false}},"/card-payments/{reference}/cancel":{"post":{"tags":["Card Payment"],"summary":"Cancel payment for supplied payment reference","description":"Cancel payment for supplied payment reference","operationId":"cancelPaymentUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"reference","in":"path","description":"Payment Reference","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseEntity"}},"204":{"description":"Cancellation of payment successful","schema":{"$ref":"#/definitions/ResponseEntity"}},"400":{"description":"Cancellation of payment failed"},"401":{"description":"Credentials are required to access this resource"},"403":{"description":"Forbidden-Access Denied"},"404":{"description":"Payment Not found"},"500":{"description":"Downstream system error"}},"deprecated":false}},"/card-payments/{reference}/details":{"get":{"tags":["Card Payment"],"summary":"Get card payment details with card details by payment reference","description":"Get payment details with card details for supplied payment reference","operationId":"retrieveWithCardDetailsUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"reference","in":"path","description":"Payment Reference","required":true,"type":"string"}],"responses":{"200":{"description":"Payment card details retrieved","schema":{"$ref":"#/definitions/CardDetails"}},"404":{"description":"Payment card details not found"}},"deprecated":false}},"/card-payments/{reference}/statuses":{"get":{"tags":["Card Payment"],"summary":"Get card payment statuses by payment reference","description":"Get payment statuses for supplied payment reference","operationId":"retrievePaymentStatusUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"reference","in":"path","description":"Payment Reference","required":true,"type":"string"}],"responses":{"200":{"description":"Payment retrieved","schema":{"$ref":"#/definitions/PaymentDto"}},"404":{"description":"Payment not found"}},"deprecated":false}},"/cases/{case}/payments":{"get":{"tags":["Case"],"summary":"Get payments for a case","description":"Get payments for a case","operationId":"retrieveCasePaymentsUsingGET_1","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"case","in":"path","description":"Ccd Case Number","required":true,"type":"string"}],"responses":{"200":{"description":"Payments retrieved","schema":{"$ref":"#/definitions/PaymentsResponse"}},"400":{"description":"Bad request"}},"deprecated":false}},"/cases/{ccdcasenumber}/paymentgroups":{"get":{"tags":["Case"],"summary":"Get payment groups for a case","description":"Get payment groups for a case","operationId":"retrieveCasePaymentGroupsUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"ccdcasenumber","in":"path","description":"Ccd Case Number","required":true,"type":"string"}],"responses":{"200":{"description":"Payment Groups retrieved","schema":{"$ref":"#/definitions/PaymentGroupResponse"}},"400":{"description":"Bad request"},"403":{"description":"Payment Info Forbidden"},"404":{"description":"Payment Groups not found"}},"deprecated":false}},"/credit-account-payments":{"post":{"tags":["Credit Account Payment"],"summary":"Create credit account payment","description":"Create credit account payment","operationId":"createCreditAccountPaymentUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"in":"body","name":"creditAccountPaymentRequest","description":"Credit Account Payment Request","required":true,"schema":{"$ref":"#/definitions/CreditAccountPaymentRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PaymentDto"}},"201":{"description":"Payment created","schema":{"$ref":"#/definitions/PaymentDto"}},"400":{"description":"Payment creation failed"},"403":{"description":"Payment failed due to insufficient funds or the account being on hold"},"404":{"description":"Account information could not be found"},"422":{"description":"Invalid or missing attribute"},"504":{"description":"Unable to retrieve account information, please try again later"}},"deprecated":false}},"/credit-account-payments/{paymentReference}":{"get":{"tags":["Credit Account Payment"],"summary":"Get credit account payment details by payment reference","description":"Get payment details for supplied payment reference","operationId":"retrieveUsingGET_2","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"paymentReference","in":"path","description":"Payment Reference","required":true,"type":"string"}],"responses":{"200":{"description":"Payment retrieved","schema":{"$ref":"#/definitions/PaymentDto"}},"404":{"description":"Payment not found"}},"deprecated":false}},"/credit-account-payments/{paymentReference}/statuses":{"get":{"tags":["Credit Account Payment"],"summary":"Get credit account payment statuses by payment reference","description":"Get payment statuses for supplied payment reference","operationId":"retrievePaymentStatusUsingGET_1","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"paymentReference","in":"path","description":"Payment Reference","required":true,"type":"string"}],"responses":{"200":{"description":"Payment retrieved","schema":{"$ref":"#/definitions/PaymentDto"}},"404":{"description":"Payment not found"}},"deprecated":false}},"/fees/{feeId}":{"delete":{"tags":["Fees"],"summary":"Delete Fees by Id","description":"Delete Fees by Id","operationId":"deleteFeeUsingDELETE","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"feeId","in":"path","description":"Fee Id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"204":{"description":"Fees Deleted","schema":{"type":"boolean"}},"400":{"description":"Fees not found"}},"deprecated":false}},"/jobs/card-payments-status-update":{"patch":{"tags":["Maintenance Jobs"],"summary":"Update payment status","description":"Updates the payment status on all gov pay pending card payments","operationId":"updatePaymentsStatusUsingPATCH","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"}],"responses":{"200":{"description":"Reports sent"}},"deprecated":false}},"/jobs/email-pay-reports":{"post":{"tags":["Payment Report"],"summary":"Email payment csv reports","description":"fetch payments for between dates, enter the date in format YYYY-MM-DD","operationId":"generateAndEmailReportUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"end_date","in":"query","description":"End Date String","required":false,"type":"string"},{"name":"payment_method","in":"query","description":"Payment Method Type","required":false,"type":"string"},{"name":"service_name","in":"query","description":"Service Type","required":false,"type":"string"},{"name":"start_date","in":"query","description":"Start Date String","required":false,"type":"string"}],"responses":{"200":{"description":"Reports sent"}},"deprecated":false}},"/payment-allocations":{"post":{"tags":["PaymentAllocation"],"summary":"Add Payment Allocations","description":"Add Payment Allocations","operationId":"addNewFeeUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"in":"body","name":"paymentAllocationDto","description":"Payment Allocation Dto","required":true,"schema":{"$ref":"#/definitions/PaymentAllocationDto"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PaymentAllocationDto"}},"201":{"description":"Payment Allocation created","schema":{"$ref":"#/definitions/PaymentAllocationDto"}},"400":{"description":"Payment Allocation failed"}},"deprecated":false}},"/payment-groups":{"post":{"tags":["Payment group"],"summary":"Add Payment Group with Fees","description":"Add Payment Group with Fees","operationId":"addNewFeeUsingPOST_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"in":"body","name":"paymentGroupDto","description":"Payment Group Dto","required":true,"schema":{"$ref":"#/definitions/PaymentGroupDto"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PaymentGroupDto"}},"201":{"description":"Payment group with fee(s) created","schema":{"$ref":"#/definitions/PaymentGroupDto"}},"400":{"description":"Payment group creation failed"}},"deprecated":false}},"/payment-groups/bulk-scan-payments":{"post":{"tags":["Payment group"],"summary":"Record a Bulk Scan Payment with Payment Group","description":"Record a Bulk Scan Payment with Payment Group","operationId":"recordUnsolicitedBulkScanPaymentUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"in":"body","name":"bulkScanPaymentRequest","description":"Bulk Scan Payment Request","required":true,"schema":{"$ref":"#/definitions/BulkScanPaymentRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PaymentDto"}},"201":{"description":"Bulk Scan Payment with payment group created","schema":{"$ref":"#/definitions/PaymentDto"}},"400":{"description":"Bulk Scan Payment creation failed"},"422":{"description":"Invalid or missing attribute"}},"deprecated":false}},"/payment-groups/bulk-scan-payments-strategic":{"post":{"tags":["Payment group"],"summary":"Record a Bulk Scan Payment with Payment Group","description":"Record a Bulk Scan Payment with Payment Group","operationId":"recordUnsolicitedBulkScanPaymentStrategicUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"in":"body","name":"bulkScanPaymentRequestStrategic","description":"Bulk Scan Payment Request Strategic","required":true,"schema":{"$ref":"#/definitions/BulkScanPaymentRequestStrategic"}},{"name":"headers","in":"header","description":"Headers","required":false,"items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PaymentDto"}},"201":{"description":"Bulk Scan Payment with payment group created","schema":{"$ref":"#/definitions/PaymentDto"}},"400":{"description":"Bulk Scan Payment creation failed"},"422":{"description":"Invalid or missing attribute"}},"deprecated":false}},"/payment-groups/fee-pay-apportion/{paymentreference}":{"get":{"tags":["PaymentApportion"],"summary":"Get apportion details by payment reference","description":"Get apportion details for supplied payment reference","operationId":"retrieveApportionDetailsUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"paymentreference","in":"path","description":"Payment Reference","required":true,"type":"string"}],"responses":{"200":{"description":"Apportionment Details retrieved","schema":{"$ref":"#/definitions/PaymentGroupDto"}},"403":{"description":"Payment info forbidden"},"404":{"description":"Payment not found"}},"deprecated":false}},"/payment-groups/{payment-group-reference}":{"get":{"tags":["Payment group"],"summary":"Get payments/remissions/fees details by payment group reference","description":"Get payments/remissions/fees details for supplied payment group reference","operationId":"retrievePaymentUsingGET_1","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"payment-group-reference","in":"path","description":"Payment Group Reference","required":true,"type":"string"}],"responses":{"200":{"description":"Payment retrieved","schema":{"$ref":"#/definitions/PaymentGroupDto"}},"403":{"description":"Payment info forbidden"},"404":{"description":"Payment not found"}},"deprecated":false},"put":{"tags":["Payment group"],"summary":"Add new Fee(s) to existing Payment Group","description":"Add new Fee(s) to existing Payment Group","operationId":"addNewFeetoPaymentGroupUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"payment-group-reference","in":"path","description":"Payment Group Reference","required":true,"type":"string"},{"in":"body","name":"paymentGroupDto","description":"Payment Group Dto","required":true,"schema":{"$ref":"#/definitions/PaymentGroupDto"}}],"responses":{"200":{"description":"Fee(s) added to Payment Group","schema":{"$ref":"#/definitions/PaymentGroupDto"}},"400":{"description":"Payment group creation failed"},"404":{"description":"Payment Group not found"}},"deprecated":false}},"/payment-groups/{payment-group-reference}/bulk-scan-payments":{"post":{"tags":["Payment group"],"summary":"Record a Bulk Scan Payment","description":"Record a Bulk Scan Payment","operationId":"recordBulkScanPaymentUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"in":"body","name":"bulkScanPaymentRequest","description":"Bulk Scan Payment Request","required":true,"schema":{"$ref":"#/definitions/BulkScanPaymentRequest"}},{"name":"payment-group-reference","in":"path","description":"Payment Group Reference","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PaymentDto"}},"201":{"description":"Bulk Scan Payment created","schema":{"$ref":"#/definitions/PaymentDto"}},"400":{"description":"Bulk Scan Payment creation failed"},"422":{"description":"Invalid or missing attribute"}},"deprecated":false}},"/payment-groups/{payment-group-reference}/bulk-scan-payments-strategic":{"post":{"tags":["Payment group"],"summary":"Record a Bulk Scan Payment","description":"Record a Bulk Scan Payment","operationId":"recordBulkScanPaymentStrategicUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"in":"body","name":"bulkScanPaymentRequestStrategic","description":"Bulk Scan Payment Request Strategic","required":true,"schema":{"$ref":"#/definitions/BulkScanPaymentRequestStrategic"}},{"name":"headers","in":"header","description":"Headers","required":false,"items":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},{"name":"payment-group-reference","in":"path","description":"Payment Group Reference","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PaymentDto"}},"201":{"description":"Bulk Scan Payment created","schema":{"$ref":"#/definitions/PaymentDto"}},"400":{"description":"Bulk Scan Payment creation failed"},"422":{"description":"Invalid or missing attribute"}},"deprecated":false}},"/payment-groups/{payment-group-reference}/card-payments":{"post":{"tags":["Payment group"],"summary":"Create card payment in Payment Group","description":"Create card payment in Payment Group","operationId":"createCardPaymentUsingPOST_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"payment-group-reference","in":"path","description":"Payment Group Reference","required":true,"type":"string"},{"in":"body","name":"request","description":"Request","required":true,"schema":{"$ref":"#/definitions/CardPaymentRequest"}},{"name":"return-url","in":"header","description":"Return URL","required":true,"type":"string"},{"name":"service-callback-url","in":"header","description":"Service Callback Url","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PaymentDto"}},"201":{"description":"Payment created","schema":{"$ref":"#/definitions/PaymentDto"}},"400":{"description":"Payment creation failed"},"422":{"description":"Invalid or missing attribute"}},"deprecated":false}},"/payment-groups/{payment-group-reference}/fees/{unique_fee_id}/remissions":{"post":{"tags":["Remissions"],"summary":"Create retrospective remission record","description":"Create retrospective remission record","operationId":"createRetrospectiveRemissionUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"payment-group-reference","in":"path","description":"Payment Group Reference","required":true,"type":"string"},{"in":"body","name":"remissionRequest","description":"Remission Request","required":true,"schema":{"$ref":"#/definitions/RemissionRequest"}},{"name":"unique_fee_id","in":"path","description":"Fee Id","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RemissionDto"}},"201":{"description":"Remission created","schema":{"$ref":"#/definitions/RemissionDto"}},"400":{"description":"Remission creation failed"},"404":{"description":"Given payment group reference not found"},"422":{"description":"Invalid or missing attribute"}},"deprecated":false}},"/payment-groups/{payment-group-reference}/telephony-card-payments":{"post":{"tags":["Payment group"],"summary":"Create telephony card payment in Payment Group","description":"Create telephony card payment in Payment Group","operationId":"createTelephonyCardPaymentUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"payment-group-reference","in":"path","description":"Payment Group Reference","required":true,"type":"string"},{"in":"body","name":"telephonyCardPaymentsRequest","description":"Telephony Card Payments Request","required":true,"schema":{"$ref":"#/definitions/TelephonyCardPaymentsRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TelephonyCardPaymentsResponse"}},"201":{"description":"Payment created","schema":{"$ref":"#/definitions/TelephonyCardPaymentsResponse"}},"400":{"description":"Payment creation failed"},"422":{"description":"Invalid or missing attribute"}},"deprecated":false}},"/payment-records":{"post":{"tags":["Payment Record"],"summary":"Record a payment","description":"Record a payment","operationId":"recordPaymentUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"in":"body","name":"paymentRecordRequest","description":"Payment Record Request","required":true,"schema":{"$ref":"#/definitions/PaymentRecordRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PaymentDto"}},"201":{"description":"Payment created","schema":{"$ref":"#/definitions/PaymentDto"}},"400":{"description":"Payment creation failed"},"422":{"description":"Invalid or missing attribute"}},"deprecated":false}},"/payment/bulkscan-data-report":{"get":{"tags":["Bulk Scanning Report"],"summary":"API to generate Report for Bulk Scan Payment System","operationId":"getBulkScanReportsUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"date_from","in":"query","description":"From Date","required":true,"type":"string","format":"date-time"},{"name":"date_to","in":"query","description":"To Date","required":true,"type":"string","format":"date-time"},{"name":"report_type","in":"query","description":"Report Type","required":true,"type":"string","enum":["PROCESSED_UNALLOCATED","SURPLUS_AND_SHORTFALL"]}],"responses":{"200":{"description":"Report Generated","schema":{"type":"array","items":{"type":"object"}}},"404":{"description":"No Data found to generate Report"}},"deprecated":false}},"/payments":{"get":{"tags":["Payment"],"summary":"Get payments for between dates","description":"Get list of payments. You can optionally provide start date and end dates which can include times as well. Following are the supported date/time formats. These are yyyy-MM-dd, dd-MM-yyyy,yyyy-MM-dd HH:mm:ss, dd-MM-yyyy HH:mm:ss, yyyy-MM-dd'T'HH:mm:ss, dd-MM-yyyy'T'HH:mm:ss","operationId":"retrievePaymentsUsingGET_1","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"ccd_case_number","in":"query","description":"Ccd Case Number","required":false,"type":"string"},{"name":"end_date","in":"query","description":"End Date Time String","required":false,"type":"string"},{"name":"payment_method","in":"query","description":"Payment Method Type","required":false,"type":"string"},{"name":"pba_number","in":"query","description":"Pba Number","required":false,"type":"string"},{"name":"service_name","in":"query","description":"Service Type","required":false,"type":"string"},{"name":"start_date","in":"query","description":"Start Date Time String","required":false,"type":"string"}],"responses":{"200":{"description":"Payments retrieved","schema":{"$ref":"#/definitions/PaymentsResponse"}},"400":{"description":"Bad request"}},"deprecated":false}},"/payments/{reference}":{"get":{"tags":["Payment"],"summary":"Get payment details by payment reference","description":"Get payment details for supplied payment reference","operationId":"retrievePaymentUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"reference","in":"path","description":"Payment Reference","required":true,"type":"string"}],"responses":{"200":{"description":"Payment retrieved","schema":{"$ref":"#/definitions/PaymentDto"}},"403":{"description":"Payment info forbidden"},"404":{"description":"Payment not found"}},"deprecated":false},"patch":{"tags":["Payment"],"summary":"Update case reference by payment reference","description":"Update case reference by payment reference","operationId":"updateCaseReferenceUsingPATCH","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"reference","in":"path","description":"Reference","required":true,"type":"string"},{"in":"body","name":"request","description":"Request","required":true,"schema":{"$ref":"#/definitions/UpdatePaymentRequest"}}],"responses":{"200":{"description":"No content","schema":{"$ref":"#/definitions/ResponseEntity"}},"404":{"description":"Payment not found"}},"deprecated":false}},"/payments/{reference}/status/{status}":{"patch":{"tags":["Payment"],"summary":"Update payment status by payment reference","description":"Update payment status by payment reference","operationId":"updatePaymentStatusUsingPATCH_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"reference","in":"path","description":"Reference","required":true,"type":"string"},{"name":"status","in":"path","description":"Status","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseEntity"}},"204":{"description":"No content","schema":{"$ref":"#/definitions/ResponseEntity"}},"404":{"description":"Payment not found"}},"deprecated":false}},"/pba-accounts/{account}/payments":{"get":{"tags":["Pay By Account"],"summary":"Get payments for a PBA account","description":"Get list of payments","operationId":"retrievePaymentsByAccountUsingGET_1","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"account","in":"path","description":"Account","required":true,"type":"string"}],"responses":{"200":{"description":"Payments retrieved","schema":{"$ref":"#/definitions/PaymentsResponse"}},"400":{"description":"Bad request"}},"deprecated":false}},"/reconciliation-payments":{"get":{"tags":["Payment"],"summary":"Get payments for Reconciliation for between dates","description":"Get list of payments. You can optionally provide start date and end dates which can include times as well. Following are the supported date/time formats. These are yyyy-MM-dd, dd-MM-yyyy,yyyy-MM-dd HH:mm:ss, dd-MM-yyyy HH:mm:ss, yyyy-MM-dd'T'HH:mm:ss, dd-MM-yyyy'T'HH:mm:ss","operationId":"retrievePaymentsWithApportionUsingGET_1","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"ccd_case_number","in":"query","description":"Ccd Case Number","required":false,"type":"string"},{"name":"end_date","in":"query","description":"End Date Time String","required":false,"type":"string"},{"name":"payment_method","in":"query","description":"Payment Method Type","required":false,"type":"string"},{"name":"pba_number","in":"query","description":"Pba Number","required":false,"type":"string"},{"name":"service_name","in":"query","description":"Service Type","required":false,"type":"string"},{"name":"start_date","in":"query","description":"Start Date Time String","required":false,"type":"string"}],"responses":{"200":{"description":"Payments retrieved","schema":{"$ref":"#/definitions/PaymentsResponse"}},"400":{"description":"Bad request"}},"deprecated":false}},"/refdata/channels":{"get":{"tags":["Payment Reference Data"],"summary":"Payment channels","description":"Get all payment channels","operationId":"findAllPaymentChannelsUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"}],"responses":{"200":{"description":"Payment channels found","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentChannel"}}},"404":{"description":"Payment channels not found"}},"deprecated":false}},"/refdata/legacy-sites":{"get":{"tags":["Payment Reference Data"],"summary":"Get allowed legacy sites","operationId":"findAllLegacySitesUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"}],"responses":{"200":{"description":"Legacy sites retrieved successfully","schema":{"type":"array","items":{"$ref":"#/definitions/LegacySite"}}},"401":{"description":"Credentials are required to access this resource"},"404":{"description":"Legacy sites not found"}},"deprecated":false}},"/refdata/methods":{"get":{"tags":["Payment Reference Data"],"summary":"Payment methods","description":"Get all payment methods","operationId":"findAllPaymentMethodsUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"}],"responses":{"200":{"description":"Payment methods found","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentMethod"}}},"404":{"description":"Payment methods not found"}},"deprecated":false}},"/refdata/providers":{"get":{"tags":["Payment Reference Data"],"summary":"Payment providers","description":"Get all payment providers","operationId":"findAllPaymentProvidersUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"}],"responses":{"200":{"description":"Payment providers found","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentProvider"}}},"404":{"description":"Payment providers not found"}},"deprecated":false}},"/refdata/status":{"get":{"tags":["Payment Reference Data"],"summary":"Payment status","description":"Get all payment statuses","operationId":"findAllPaymentStatusesUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"}],"responses":{"200":{"description":"Payment status found","schema":{"type":"array","items":{"$ref":"#/definitions/PaymentStatus"}}},"404":{"description":"Payment status not found"}},"deprecated":false}},"/remission":{"post":{"tags":["Remissions"],"summary":"Create upfront/retrospective remission record","description":"Create upfront/retrospective remission record - Tactical","operationId":"createRemissionV1UsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"in":"body","name":"remissionRequest","description":"Remission Request","required":true,"schema":{"$ref":"#/definitions/RemissionRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RemissionDto"}},"201":{"description":"Remission created","schema":{"$ref":"#/definitions/RemissionDto"}},"400":{"description":"Remission creation failed"},"404":{"description":"Given payment group reference not found"},"422":{"description":"Invalid or missing attribute"}},"deprecated":true}},"/remissions":{"post":{"tags":["Remissions"],"summary":"Create upfront remission record","description":"Create upfront remission record","operationId":"createRemissionUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"in":"body","name":"remissionRequest","description":"Remission Request","required":true,"schema":{"$ref":"#/definitions/RemissionRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RemissionDto"}},"201":{"description":"Remission created","schema":{"$ref":"#/definitions/RemissionDto"}},"400":{"description":"Remission creation failed"},"404":{"description":"Given payment group reference not found"},"422":{"description":"Invalid or missing attribute"}},"deprecated":false}},"/replay-credit-account-payments":{"post":{"tags":["Replay Credit Account Payment"],"summary":"Replay credit account payment","description":"Replay credit account payment","operationId":"replayCreditAccountPaymentUsingPOST","consumes":["multipart/form-data"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"User authorization header","required":true,"type":"string"},{"name":"ServiceAuthorization","in":"header","description":"Service authorization header","required":true,"type":"string"},{"name":"csvFile","in":"formData","description":"Replay PBA Payments File","required":true,"type":"file"},{"in":"formData","name":"isReplayPBAPayments","description":"Is Replay PBA Payments","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Replay Payment Completed Successfully","schema":{"type":"string"}},"400":{"description":"BAD Request"},"500":{"description":"Replay Payment failed"}},"deprecated":false}}},"definitions":{"AccountDto":{"type":"object","properties":{"account_name":{"type":"string"},"account_number":{"type":"string"},"available_balance":{"type":"number"},"credit_limit":{"type":"number"},"effective_date":{"type":"string","example":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"},"status":{"type":"string","enum":["ACTIVE","ON_HOLD","DELETED"]}},"title":"AccountDto"},"BulkScanPaymentRequest":{"type":"object","properties":{"amount":{"type":"number"},"banked_date":{"type":"string"},"ccd_case_number":{"type":"string"},"currency":{"type":"string","enum":["GBP"]},"document_control_number":{"type":"string"},"exception_record":{"type":"string"},"external_provider":{"type":"string"},"giro_slip_no":{"type":"string"},"payer_name":{"type":"string"},"payment_channel":{"$ref":"#/definitions/PaymentChannel"},"payment_method":{"type":"string","enum":["CARD","PBA","CASH","CHEQUE","POSTAL_ORDER","BARCLAY_CARD","ALL"]},"payment_status":{"$ref":"#/definitions/PaymentStatus"},"requestor":{"type":"string","enum":["CMC","DIVORCE","PROBATE","FINREM","DIGITAL_BAR","FPL","IAC","UNSPEC"]},"site_id":{"type":"string"}},"title":"BulkScanPaymentRequest"},"BulkScanPaymentRequestStrategic":{"type":"object","properties":{"amount":{"type":"number"},"banked_date":{"type":"string"},"ccd_case_number":{"type":"string"},"currency":{"type":"string","enum":["GBP"]},"document_control_number":{"type":"string"},"exception_record":{"type":"string"},"external_provider":{"type":"string"},"giro_slip_no":{"type":"string"},"payer_name":{"type":"string"},"payment_allocation_dto":{"$ref":"#/definitions/PaymentAllocationDto"},"payment_channel":{"$ref":"#/definitions/PaymentChannel"},"payment_method":{"type":"string","enum":["CARD","PBA","CASH","CHEQUE","POSTAL_ORDER","BARCLAY_CARD","ALL"]},"payment_status":{"$ref":"#/definitions/PaymentStatus"},"requestor":{"type":"string","enum":["CMC","DIVORCE","PROBATE","FINREM","DIGITAL_BAR","FPL","IAC","UNSPEC"]},"site_id":{"type":"string"}},"title":"BulkScanPaymentRequestStrategic"},"CardDetails":{"type":"object","properties":{"card_brand":{"type":"string"},"cardholder_name":{"type":"string"},"email":{"type":"string"},"expiry_date":{"type":"string"},"last_digits_card_number":{"type":"string"}},"title":"CardDetails"},"CardPaymentRequest":{"type":"object","properties":{"amount":{"type":"number"},"case_reference":{"type":"string"},"ccd_case_number":{"type":"string"},"channel":{"type":"string"},"currency":{"type":"string","enum":["GBP"]},"description":{"type":"string"},"fees":{"type":"array","items":{"$ref":"#/definitions/FeeDto"}},"language":{"type":"string"},"provider":{"type":"string"},"service":{"type":"string","enum":["CMC","DIVORCE","PROBATE","FINREM","DIGITAL_BAR","FPL","IAC","UNSPEC"]},"site_id":{"type":"string"}},"title":"CardPaymentRequest"},"CreditAccountPaymentRequest":{"type":"object","properties":{"account_number":{"type":"string"},"amount":{"type":"number"},"case_reference":{"type":"string"},"ccd_case_number":{"type":"string"},"currency":{"type":"string","enum":["GBP"]},"customer_reference":{"type":"string"},"description":{"type":"string"},"fees":{"type":"array","items":{"$ref":"#/definitions/FeeDto"}},"organisation_name":{"type":"string"},"service":{"type":"string","enum":["CMC","DIVORCE","PROBATE","FINREM","DIGITAL_BAR","FPL","IAC","UNSPEC"]},"site_id":{"type":"string"}},"title":"CreditAccountPaymentRequest"},"FeeDto":{"type":"object","properties":{"allocated_amount":{"type":"number"},"amount_due":{"type":"number"},"apportion_amount":{"type":"number"},"apportioned_payment":{"type":"number"},"calculated_amount":{"type":"number"},"case_reference":{"type":"string"},"ccd_case_number":{"type":"string"},"code":{"type":"string"},"date_apportioned":{"type":"string","format":"date-time"},"date_created":{"type":"string","format":"date-time"},"date_receipt_processed":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"description":{"type":"string"},"fee_amount":{"type":"number"},"id":{"type":"integer","format":"int32"},"jurisdiction1":{"type":"string"},"jurisdiction2":{"type":"string"},"memo_line":{"type":"string"},"natural_account_code":{"type":"string"},"net_amount":{"type":"number"},"payment_group_reference":{"type":"string"},"reference":{"type":"string"},"version":{"type":"string"},"volume":{"type":"integer","format":"int32"}},"title":"FeeDto"},"LegacySite":{"type":"object","properties":{"siteId":{"type":"string"},"siteName":{"type":"string"}},"title":"LegacySite"},"LinkDto":{"type":"object","properties":{"href":{"type":"string"},"method":{"type":"string"}},"title":"LinkDto"},"LinksDto":{"type":"object","properties":{"cancel":{"$ref":"#/definitions/LinkDto"},"next_url":{"$ref":"#/definitions/LinkDto"},"self":{"$ref":"#/definitions/LinkDto"}},"title":"LinksDto"},"NextURLDto":{"type":"object","properties":{"accessToken":{"type":"string"},"href":{"type":"string"},"method":{"type":"string"},"refreshToken":{"type":"string"}},"title":"NextURLDto"},"NextURLDtos":{"type":"object","properties":{"next_url":{"$ref":"#/definitions/NextURLDto"}},"title":"NextURLDtos"},"PaymentAllocationDto":{"type":"object","properties":{"allocation_reason":{"type":"string"},"allocation_status":{"type":"string"},"date_created":{"type":"string","example":"yyyy-MM-dd'T'HH:mm:ss.SSSZ"},"explanation":{"type":"string"},"id":{"type":"string"},"payment_allocation_status":{"$ref":"#/definitions/PaymentAllocationStatus"},"payment_group_reference":{"type":"string"},"payment_reference":{"type":"string"},"reason":{"type":"string"},"receiving_office":{"type":"string"},"unidentified_reason":{"type":"string"},"user_id":{"type":"string"},"user_name":{"type":"string"}},"title":"PaymentAllocationDto"},"PaymentAllocationStatus":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"}},"title":"PaymentAllocationStatus"},"PaymentChannel":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"}},"title":"PaymentChannel"},"PaymentDto":{"type":"object","properties":{"_links":{"$ref":"#/definitions/LinksDto"},"account_number":{"type":"string"},"amount":{"type":"number"},"banked_date":{"type":"string","format":"date-time"},"case_reference":{"type":"string"},"ccd_case_number":{"type":"string"},"channel":{"type":"string"},"currency":{"type":"string","enum":["GBP"]},"customer_reference":{"type":"string"},"date_created":{"type":"string","example":"yyyy-MM-dd'T'HH:mm:ss.SSSZ"},"date_updated":{"type":"string","example":"yyyy-MM-dd'T'HH:mm:ss.SSSZ"},"description":{"type":"string"},"document_control_number":{"type":"string"},"external_provider":{"type":"string"},"external_reference":{"type":"string"},"fees":{"type":"array","items":{"$ref":"#/definitions/FeeDto"}},"giro_slip_no":{"type":"string"},"id":{"type":"string"},"method":{"type":"string"},"organisation_name":{"type":"string"},"payer_name":{"type":"string"},"payment_allocation":{"type":"array","items":{"$ref":"#/definitions/PaymentAllocationDto"}},"payment_group_reference":{"type":"string"},"payment_reference":{"type":"string"},"reference":{"type":"string"},"reported_date_offline":{"type":"string","format":"date-time"},"service_name":{"type":"string"},"site_id":{"type":"string"},"status":{"type":"string"},"status_histories":{"type":"array","items":{"$ref":"#/definitions/StatusHistoryDto"}}},"title":"PaymentDto"},"PaymentGroupDto":{"type":"object","properties":{"date_created":{"type":"string","format":"date-time"},"date_updated":{"type":"string","format":"date-time"},"fees":{"type":"array","items":{"$ref":"#/definitions/FeeDto"}},"payment_group_reference":{"type":"string"},"payments":{"type":"array","items":{"$ref":"#/definitions/PaymentDto"}},"remissions":{"type":"array","items":{"$ref":"#/definitions/RemissionDto"}}},"title":"PaymentGroupDto"},"PaymentGroupResponse":{"type":"object","properties":{"payment_groups":{"type":"array","items":{"$ref":"#/definitions/PaymentGroupDto"}}},"title":"PaymentGroupResponse"},"PaymentMethod":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"}},"title":"PaymentMethod"},"PaymentProvider":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"}},"title":"PaymentProvider"},"PaymentRecordRequest":{"type":"object","properties":{"amount":{"type":"number"},"currency":{"type":"string","enum":["GBP"]},"external_provider":{"type":"string"},"external_reference":{"type":"string"},"fees":{"type":"array","items":{"$ref":"#/definitions/FeeDto"}},"giro_slip_no":{"type":"string"},"payment_channel":{"$ref":"#/definitions/PaymentChannel"},"payment_method":{"type":"string","enum":["CARD","PBA","CASH","CHEQUE","POSTAL_ORDER","BARCLAY_CARD","ALL"]},"payment_status":{"$ref":"#/definitions/PaymentStatus"},"reported_date_offline":{"type":"string"},"requestor":{"type":"string","enum":["CMC","DIVORCE","PROBATE","FINREM","DIGITAL_BAR","FPL","IAC","UNSPEC"]},"requestor_reference":{"type":"string"},"site_id":{"type":"string"}},"title":"PaymentRecordRequest"},"PaymentStatus":{"type":"object","properties":{"description":{"type":"string"},"name":{"type":"string"}},"title":"PaymentStatus"},"PaymentsResponse":{"type":"object","properties":{"payments":{"type":"array","items":{"$ref":"#/definitions/PaymentDto"}}},"title":"PaymentsResponse"},"RemissionDto":{"type":"object","properties":{"beneficiary_name":{"type":"string"},"case_reference":{"type":"string"},"ccd_case_number":{"type":"string"},"date_created":{"type":"string","example":"yyyy-MM-dd'T'HH:mm:ss.SSSZ"},"fee":{"$ref":"#/definitions/FeeDto"},"fee_code":{"type":"string"},"hwf_amount":{"type":"number"},"hwf_reference":{"type":"string"},"id":{"type":"string"},"payment_group_reference":{"type":"string"},"payment_reference":{"type":"string"},"remission_reference":{"type":"string"}},"title":"RemissionDto"},"RemissionRequest":{"type":"object","properties":{"beneficiary_name":{"type":"string"},"case_reference":{"type":"string"},"ccd_case_number":{"type":"string"},"fee":{"$ref":"#/definitions/FeeDto"},"hwf_amount":{"type":"number"},"hwf_reference":{"type":"string"},"payment_group_reference":{"type":"string"},"site_id":{"type":"string"}},"title":"RemissionRequest"},"ResponseEntity":{"type":"object","properties":{"body":{"type":"object"},"statusCode":{"type":"string","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"statusCodeValue":{"type":"integer","format":"int32"}},"title":"ResponseEntity"},"StatusHistoryDto":{"type":"object","properties":{"date_created":{"type":"string","example":"yyyy-MM-dd'T'HH:mm:ss.SSSZ"},"date_updated":{"type":"string","example":"yyyy-MM-dd'T'HH:mm:ss.SSSZ"},"error_code":{"type":"string"},"error_message":{"type":"string"},"external_status":{"type":"string"},"status":{"type":"string"}},"title":"StatusHistoryDto"},"TelephonyCardPaymentsRequest":{"type":"object","properties":{"amount":{"type":"number"},"ccd_case_number":{"type":"string"},"currency":{"type":"string","enum":["GBP"]},"return_url":{"type":"string"},"service":{"type":"string","enum":["CMC","DIVORCE","PROBATE","FINREM","DIGITAL_BAR","FPL","IAC","UNSPEC"]},"site_id":{"type":"string"}},"title":"TelephonyCardPaymentsRequest"},"TelephonyCardPaymentsResponse":{"type":"object","properties":{"_links":{"$ref":"#/definitions/NextURLDtos"},"ccd_case_number":{"type":"string"},"date_created":{"type":"string","example":"yyyy-MM-dd'T'HH:mm:ss.SSSZ"},"payment_group_reference":{"type":"string"},"payment_reference":{"type":"string"},"status":{"type":"string"}},"title":"TelephonyCardPaymentsResponse"},"UpdatePaymentRequest":{"type":"object","properties":{"case_reference":{"type":"string"},"ccd_case_number":{"type":"string"}},"title":"UpdatePaymentRequest"}}}