BixHub API for payment commitment request.
- Payment commitment request sent by BixHub for claims of medical cover that should be accepted or rejected by Nordea for further processing
Creating a payment commitment request
<details>
<summary><code>POST</code> <code><b>/</b></code> <code>(creates a new payment commitment request)</code></summary>
</details>
Parameters
Name Type Data Type Description Mandatory Content-Type header String Accepted value: application/json Yes X-IBM-Client-Id header String Value to be provided by Nordea Yes X-IBM-Client-Secret header String Value to be provided by Nordea Yes None payload object (JSON) See example below Yes
Sample payload
{
"document":"\<StandardBusinessDocument>\<StandardBusinessDocumentHeader>\<HeaderVersion>1.0\</HeaderVersion>\<Sender>\<Identifier>1.2.246.537.10.19623654\</Identifier>\<ContactInformation>\<Contact>hoitolaitos\</Contact>\<ContactTypeIdentifier>HSP\</ContactTypeIdentifier>\</ContactInformation>\</Sender>\<Receiver>\<Identifier >1.2.246.537.10.12345678\</Identifier>\<ContactInformation>\<Contact>vakuutusyhti\</Contact>\<ContactTypeIdentifier>IC\</ContactTypeIdentifier>\</ContactInformation>\</Receiver>\<DocumentIdentification>\<Standard>HL7.CDA2005\</Standard>\<TypeVersion>1.1\</TypeVersion>\<InstanceIdentifier>1.2.246.537.10.19623654.2022020210170085\</InstanceIdentifier>\<Type>ilmoitus\</Type>\<CreationDateAndTime>2022-02-02T10:17:00\</CreationDateAndTime>\</DocumentIdentification>\</StandardBusinessDocumentHeader>\</StandardBusinessDocument>"
}
Responses
http code | content-type | response |
---|---|---|
200 | text/plain;charset=UTF-8 | Document received: <The same document as in payload> |
400 | application/json | {"code":"400","message":"Bad Request"} |
401 | text/html;charset=utf-8 | {"httpCode": "401","httpMessage": "Unauthorized","moreInformation": "Invalid client id or secret."} |
Example cURL
curl --location 'https://api.dev.nordeaopenbanking.com/bixhubapi/v1/statement' \
--header 'Content-Type: application/json' \
--header 'X-IBM-Client-Id: <provided on request>' \
--header 'X-IBM-Client-Secret: <provided on request>' \
--data '{
"document":"<StandardBusinessDocument><StandardBusinessDocumentHeader><HeaderVersion>1.0</HeaderVersion><Sender><Identifier>1.2.246.537.10.19623654</Identifier><ContactInformation><Contact>hoitolaitos</Contact><ContactTypeIdentifier>HSP</ContactTypeIdentifier></ContactInformation></Sender><Receiver><Identifier >1.2.246.537.10.12345678</Identifier><ContactInformation><Contact>vakuutusyhti</Contact><ContactTypeIdentifier>IC</ContactTypeIdentifier></ContactInformation></Receiver><DocumentIdentification><Standard>HL7.CDA2005</Standard><TypeVersion>1.1</TypeVersion><InstanceIdentifier>1.2.246.537.10.19623654.2022020210170085</InstanceIdentifier><Type>ilmoitus</Type><CreationDateAndTime>2022-02-02T10:17:00</CreationDateAndTime></DocumentIdentification></StandardBusinessDocumentHeader></StandardBusinessDocument>"
}'