...
In case you want to submit a parsed QR code, please use application/vnd.gini.v1.partial+qr+json. The parsing of the QR field fields is optional. The paymentdata needs to contain the iban and paymentRecipient keys, but the values can be empty. See the contain at least the iban and the paymentRecipient keys. Hence, the minimal valid QR code body could be the following:
| Code Block | ||
|---|---|---|
| ||
{
"qrcode": "bank://singlepaymentsepa?name=Gini%20Online%20Shop&reason=A12345-6789&iban=DE89370400440532013000&bic=GINIBICXXX&amount=47%2C65¤cy=EUR",
"paymentdata": {
"iban": "DE01234567898765432101",
"paymentRecipient": "Telekom GmbH"
}
} |
Mandatory QR fields
Key | Value |
|---|---|
|
|
|
|
Optional QR fields
Key | Value |
|---|---|
|
|
|
|
|
|
See the full QR code example below.
Request
In order to upload a page picture or a partial document, specify a different content type:
...
Status Code | Description |
|---|---|
400 (Bad Request) | Returned when the sent send file has invalid format. |
401 (Unauthorized) | Authorization credentials are either missing, wrong or outdated. |
415 | Content type is not supported. |
503 | Service unavailable. Try again later. |
...
| Code Block | ||
|---|---|---|
| ||
//upload a partial document
//variant for web applications running in a web browser with access token:
curl -H 'Authorization: BEARER <token>'
--form 'file=@file.JPEG'
-H 'Accept: application/vnd.gini.v1+json'
-H 'Content-Type: application/vnd.gini.v1.partial+png'
-i https://pay-api.gini.net/documents
//variant for other types of applications with access token:
curl -H 'Authorization: BEARER <token>'
--data-binary '@file.JPEG'
-H 'Accept: application/vnd.gini.v1+json'
-H 'Content-Type: application/vnd.gini.v1.partial+png'
-i https://pay-api.gini.net/documents?filename=file.JPEG
//or with X-User-identifier (see how to setup X-User-identifier):
curl -H 'X-User-Identifier: user1'
--form 'file=@file.JPEG'
-H 'Accept: application/vnd.gini.v1+json'
-H 'Content-Type: application/vnd.gini.v1.partial+png'
-u 'client-id:client-secret'
-i https://pay-api.gini.net/documents
// variant for QR code
curl -H 'Authorization: BEARER <token>'
--form 'data.json={
"qrcode": "bank://singlepaymentsepa?name=Gini%20Online%20Shop&reason=A12345-6789&iban=DE89370400440532013000&bic=GINIBICXXX&amount=47%2C65¤cy=EUR",
"paymentdata": {
"amountToPay": "25.79:EUR",
"paymentRecipient": "Telekom GmbH",
"iban": "<IBAN>DE01234567898765432101",
"bic": "<BIC>SPESDE3EXXX",
"paymentReference": "<REFERENCE>Nr.12345"
}
}'
-H 'Accept: application/vnd.gini.v1+json'
-H 'Content-Type: application/vnd.gini.v1.partial+png'
-i https://pay-api.gini.net/documents |
...