Operations

requestPolicyInfo

Basic policy info request

POST /accountLookups/policy/{requestId}

Requests the current status of the policy identified by the supplied policy reference. Not all service providers support policy lookups. In the case where this function is not supported by the requested service provider, a 501 HTTP status code may be returned

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
requestId path yes The randomly generated UUID of this request string
body body yes A policy lookup request PolicyLookupRequest

Response

Content-Type: application/json

Status Code Reason Response Model
200 Success PolicyLookupResponse
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

requestTrafficFineInfo

Basic traffic fine info request

POST /accountLookups/traffic/{requestId}

Requests information related to a specific traffic fine as identified by the noticeNumber. In the case where this function is not supported by the relevant service provider, a 501 HTTP status code may be returned

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
requestId path yes The randomly generated UUID of this request string
body body yes A traffic fine lookup request TrafficFineLookupRequest

Response

Content-Type: application/json

Status Code Reason Response Model
200 Success TrafficFineLookupResponse
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

requestAccountInfo

Basic account information request

POST /accountLookups/{requestId}

Requests the current status of the account identified by the supplied account reference. Not all services support account lookups. In the case where this function is not supported for the requested service, a 501 HTTP status code may be returned

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
requestId path yes The randomly generated UUID of this request string
body body yes An account lookup request AccountLookupRequest

Response

Content-Type: application/json

Status Code Reason Response Model
200 Success AccountLookupResponse
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

createPolicyPayment

Initiate a policy payment transaction

POST /payments/policy/{paymentId}

Requests that a payment be made towards a policy.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
paymentId path yes The randomly generated UUID of this request string
body body yes A policy payment request PolicyPaymentRequest

Response

Content-Type: application/json

Status Code Reason Response Model
201 Created PolicyPaymentResponse
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

createTrafficFinePayment

Initiate a traffic fine payment transaction

POST /payments/traffic/{paymentId}

Requests that a payment be made towards a traffic fine.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
paymentId path yes The randomly generated UUID of this request string
body body yes A traffic fine payment request TrafficFinePaymentRequest

Response

Content-Type: application/json

Status Code Reason Response Model
201 Created TrafficFinePaymentResponse
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

createAccountPayment

Initiate a bill payment transaction

POST /payments/{paymentId}

Requests that a payment be made towards a customer account

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
paymentId path yes The randomly generated UUID of this request string
body body yes A payment request PaymentRequest

Response

Content-Type: application/json

Status Code Reason Response Model
201 Created PaymentResponse
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

confirmPayment

Confirm an existing bill payment

POST /payments/{paymentId}/confirmations/{adviceId}

If a createPayment request previously succeeded with a 201 status it must be confirmed or cancelled to complete the transaction. confirmPayment can only succeed if a payment was created but not cancelled. confirmPayment must be repeated until a final HTTP status code is received (not 500 or 504). If a status code of either 500 or 504 is received, or no response is received, the request must be repeated. confirmPayment may be called repeatedly on the same payment resource without negative effect.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
adviceId path yes The randomly generated UUID of this request string
paymentId path yes The UUID generated for the original createPayment request string
body body yes A payment confirmation TenderAdvice

Response

Content-Type: application/json

Status Code Reason Response Model
202 Accepted BasicAdviceResponse
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

reversePayment

Reverse a payment request that failed or timed out

POST /payments/{paymentId}/reversals/{adviceId}

If a createPayment request fails with a 500 or 504 HTTP status code, or no response was received within the timeout period, it must be reversed to ensure the payment is not reflected on a customer's account. reversePayment must be repeated until a final HTTP status code is received (not 500 or 504). reversePayment may be called repeatedly on the same payment resource without negative effect.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
adviceId path yes The randomly generated UUID of this request string
paymentId path yes The UUID generated for the original createPayment request string
body body yes A payment reversal BasicReversal

Response

Content-Type: application/json

Status Code Reason Response Model
202 Accepted BasicAdviceResponse
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

createRefund

Creates a refund of previously confirmed payment

POST /refunds/{refundId}

If a payment is completed and confirmed successfully, some services support that customers may request a refund for a particular payment for some time after the payment took place. Not all services support refunds. In the case where this function is not supported for the requested service, a 501 HTTP status code may be returned

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
refundId path yes The randomly generated UUID of this request string
body body yes A refund request RefundRequest

Response

Content-Type: application/json

Status Code Reason Response Model
201 Created RefundResponse
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
501 Not implemented ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

confirmRefund

Confirm an existing bill payment refund

POST /refunds/{refundId}/confirmations/{adviceId}

If a createRefund request previously succeeded with a 201 status it must be confirmed or reversed to complete the transaction. confirmRefund can only succeed if a refund was created but not reversed. confirmRefund must be repeated until a final HTTP status code is received (not 500 or 504). If a status code of either 500 or 504 is received, or no response is received, the request must be repeated. confirmRefund may be called repeatedly on the same refund resource without negative effect.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
adviceId path yes The randomly generated UUID of this request string
refundId path yes The UUID generated for the corresponding createRefund request string
body body yes A refund confirmation BasicAdvice

Response

Content-Type: application/json

Status Code Reason Response Model
202 Accepted BasicAdviceResponse
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail

reverseRefund

Reverse a refund request that failed or timed out

POST /refunds/{refundId}/reversals/{adviceId}

If a createRefund request fails with a 500 or 504 HTTP status code, or no response was received within the timeout period, it must be reversed to ensure the payment is not refelected on a customer's account. reverseRefund must be repeated until a final HTTP status code is received (not 500 or 504). reverseRefund may be called repeatedly on the same payment resource without negative effect.

Security

  • httpBasic

Request

Content-Type: application/json

Parameters

Name Located in Required Description Default Schema
adviceId path yes The randomly generated UUID of this request string
refundId path yes The UUID generated for the corresponding createRefund request string
body body yes A refund reversal BasicReversal

Response

Content-Type: application/json

Status Code Reason Response Model
202 Accepted BasicAdviceResponse
400 Bad request ErrorDetail
500 Internal Server Error ErrorDetail
503 Service Unavailable ErrorDetail
504 Gateway Timeout ErrorDetail