Create Payment Requests
- Former user (Deleted)
Owned by Former user (Deleted), created
Payment Requests are handled via Health API using header application/vnd.gini.v3+json
Request
Key | Mandatory | Description |
|---|---|---|
| no | The URI of the source document whenever the payment details were extracted by the Gini system beforehand. |
| no | The ID of the target payment provider. See Payment Providers. |
| no | The recipient of the payment. |
| yes | The IBAN (international bank account number) of the payment recipient. |
| no | The BIC (bank identifier code) for the payment. |
| yes | The amount of the payment. See Amount. |
| yes | The purpose of the payment, for example, the invoice or the customer identifier. |
//create a payment request
POST /paymentRequests HTTP/1.1
Host: health-api.gini.net
Authorization: BEARER c796535e-32e4-11eb-b966-e30e07dee3dc
Content-Type: application/vnd.gini.v3+json
//with
{
"sourceDocumentLocation": "https://health-api.gini.net/documents/88090c5a-32ed-11eb-9e1a-9f2bc4656a7d",
"paymentProvider": "9a9b41f2-32f8-11eb-9fb5-e378350b0392",
"recipient": "Dr. med. Hackler",
"iban": "DE02300209000106531065",
"bic": "CMCIDEDDXXX",
"amount": "335.50:EUR",
"purpose": "ReNr AZ356789Z"
}//response
HTTP/1.1 201 Created
X-Request-Id: 7b5a7f79-ae7c-4040-b6cf-25cde58ad937
Location: https://health-api.gini.net/paymentRequests/b4bd3e80-7bd1-11e4-95ab-000000000000
Content-Type: application/vnd.gini.v1+jsonÂ