Payment API Information
home
Payment Initiation Information
The Payment Initiation API enables Payment Initiating Service Providers (PISP) to initiate payments, with customer approval, for a C. Hoare & Co. account.
The payment-order implementation includes:
- domestic payments;
- domestic scheduled payments;
- standing orders;
- international payments;
- file payments.
C. Hoare & Co.'s implementation conforms to the OBIE Payment specifications v3.1; any variances are documented below.
Domestic Payments
Key Information
- The domestic payment endpoints can be used to initiate a domestic payment consent journey, check the status of a consent, request a confirmation of funds response, send a payment-order and check the status of a payment-order.
- Confirmation of Funds response is not yet supported
- A payment initiated requiring the Multiple Authorisation Object is not yet supported; any multiple authorisation payment initiated will be rejected with error code '1531 Invalid Payment Status'
- C. Hoare & Co. processes payments on any working day (defined as any day, other than a Saturday, Sunday or public holiday in England or Wales.) See processing times below.
- We advise sending a payment-order regardless of a negative response to a GET/domestic-payment-consents/{ConsentId}/fundconfirmation request. C. Hoare & Co. do not operate real time balances.
- The POST/payment-order must be sent within 1 minute of the successful payment consent; otherwise it will not be valid
- Any related charge details for the payment will not be expressed in the charge object until the customer has completed their authentication journey.
Payment Validations
LocalInstrument
UK.OBIE.FPS and UK.OBIE.CHAPS are accepted payment types for Local Instrument.
When LocalInstrument is blank, the request will be processed as a Faster Payment.
POST/domestic-payments-consents where the amount is equal to or exceeding £100,000.00 must be sent as a UK.OBIE.CHAPS; otherwise the request will be rejected.
Format
The attributes below must conform to the maximum field length validation based on LocalInstrument selected:
| Object | Attribute | UK.OBIE.FPS Max field length | UK.OBIE.CHAPS Max field length |
|---|---|---|---|
| CreditorAccount | Name | 18 | 70 |
| RemittanceInformation | Reference | 18 | 70 |
Field Values
The domestic payment endpoints adopt the OBIE v3.1 schema with only a few exceptions:-
| Object | Attribute | CHC Implementation |
|---|---|---|
| OBWriteDomestic2 | ||
| DebtorAccount | Secondary Identification | Not supported. Any roll number should be specified in the Remittance Information/Reference field |
| CreditorAccount | Secondary Identification | Not supported. Any roll number should be specified in the Remittance Information/Reference field |
| Remittance information | Unstructured | Not supported. Only one identifier can be accepted; use Reference field |
| OBWriteDomesticConsentResponse2 | ||
| Data | CutOffDateTime | Not supported |
| Data | ExpectedExecutionDateTime | Not supported |
| Data | ExpectedSettlementDateTime | Not supported |
| OBWriteDomesticResponse2 | ||
| Data | ExpectedExecutionDateTime | Not supported |
| Data | ExpectedSettlementDateTime | Not supported |
Payment Processing
CHAPS instructions received after 5pm (UK time), or on a non-working day, will normally be processed on the following working day.
Faster Payments and payments to C. Hoare & Co. customers received after 11:30pm (UK time), or on a non-working day, will normally be processed on the following working day.
Scheduled Domestic Payments
Key Information
- The scheduled domestic payment endpoints can be used to initiate a scheduled domestic payment consent journey, check the status of a consent, send a payment-order and check the status of a payment-order.
- Multiple Authorisation Object is supported
- C.Hoare & Co. online customers can cancel a scheduled payment via the PSU interface
- C. Hoare & Co. process payments on any Working day defined as any day, other than a Saturday, Sunday or public holiday in England or Wales. See processing times below.
- The POST/payment-order must be sent within 1 minute(s) of the successful payment consent to be valid
- Any related charge details for the payment will not be expressed in the Charge object until the customer has completed their authentication journey
Payment Validations
LocalInstrument
UK.OBIE.FPS and UK.OBIE.CHAPS are accepted payment types for Local Instrument.
When LocalInstrument is blank, the request will be processed as a Faster Payment.
POST/domestic-payments-consents where the amount is equal to or exceeding £100,000.00 must be sent as a UK.OBIE.CHAPS; otherwise the request will be rejected.
RequestedExecutionDateTime
Date must fall on a working day. Any request where RequestedExecutionDate falls on a weekend will be rejected.
DateTime should be specified as ISO 8601 format e.g. 2017-04-05T10:43:07+00:00. Timezone element of DateTime is not currently supported.
Format
The attributes below must conform to the maximum field length validation based on LocalInstrument selected:
| Object | Attribute | UK.OBIE.FPS Max field length | UK.OBIE.CHAPS Max field length |
|---|---|---|---|
| CreditorAccount | Name | 18 | 70 |
| RemittanceInformation | Reference | 18 | 70 |
Field Values
The domestic payment endpoints adopt the OBIE v3.1 schema with only a few exceptions:-
| Object | Attribute | CHC Implementation |
|---|---|---|
| OBWriteDomestic2 | ||
| DebtorAccount | Secondary Identification | Not supported. Any roll number should be specified in the Remittance Information/Reference field |
| CreditorAccount | Secondary Identification | Not supported. Any roll number should be specified in the Remittance Information/Reference field |
| Remittance information | Unstructured | Not supported. Only one identifier can be accepted; use Reference field |
| OBWriteDomesticConsentResponse2 | ||
| Data | CutOffDateTime | Not supported |
| Data | ExpectedExecutionDateTime | Not supported |
| Data | ExpectedSettlementDateTime | Not supported |
| OBWriteDomesticResponse2 | ||
| Data | ExpectedExecutionDateTime | Not supported |
| Data | ExpectedSettlementDateTime | Not supported |
Payment Processing
CHAPS instructions received after 5pm (UK time), or on a non-working day, will normally be processed on the following working day.
Faster Payments and payments to C. Hoare & Co. customers received after 11:30pm (UK time), or on a non-working day, will normally be processed on the following working day.