Halobject

HalPaymentCoverageReport

HYPERMEDIA structure used for returning the payment coverage report to the CBPII

Fields (3)

requestPaymentCoverageRequestResourcerequired
Schema: PaymentCoverageRequestResource
resultbooleanrequired
Result of the coverage check :
Result of the coverage check :
- true: the payment can be covered
- false: the payment cannot be covered
_linksPaymentCoverageReportLinksrequired
Schema: PaymentCoverageReportLinks

Example

{
  "request": {
    "paymentCoverageRequestId": "MyCoverage123456",
    "instructedAmount": {
      "amount": 12345,
      "currency": "EUR"
    },
    "accountId": {
      "iban": "YY13RDHN98392489481620896668799742"
    }
  },
  "result": true,
  "_links": {
    "self": {
      "href": "v1/funds-confirmations"
    }
  }
}