Get Payment Requests

Payment Requests can be retrieved from both the Pay API (using header application/vnd.gini.v1+json) and the Health API (using application/vnd.gini.v3+json).

Response

Key	Description

Key	Description
`createdAt`	ISO 8601 date string defining point in time when the payment request was created.
`recipient`	The recipient of the payment.
`iban`	The IBAN (international bank account number) of the payment recipient.
`bic`	The BIC (bank identifier code) for the payment.
`amount`	The amount of the payment. See Amount.
`purpose`	The purpose of the payment, for example, the invoice or customer identifier.
`status`	Status depending on the comparison of the payment request with the actual payment can be "open", "paid" or "invalid".
`requesterUri`	The URI of the business SDK app for returning after successful payment. Contains the payment request id as parameter.
`createdAt`	ISO 8601 timestamp in UTC timezone, defines the point in time when the payment request was created.
`_links`	Object with links to other resources like document and payment.

//get a payment request from Health API

GET /paymentRequests/b4bd3e80-7bd1-11e4-95ab-000000000000
Host: health-api.gini.net
Authorization: BEARER c796535e-32e4-11eb-b966-e30e07dee3dc
Accept: application/vnd.gini.v3+json

//response

{
  "createdAt": "2020-12-07T15:50:23",
  "recipient": "Dr. med. Hackler",
  "iban": "DE02300209000106531065",
  "requesterUri": "ginipay-example://payment-requester?paymentRequestId=b4bd3e80-7bd1-11e4-95ab-000000000000",
  "bic": "CMCIDEDDXXX",
  "amount": "335.50:EUR",
  "purpose": "ReNr AZ356789Z",
  "status": "paid",
  "_links": {
     "paymentProvider": "https://health-api.gini.net/paymentProviders/7e72441c-32f8-11eb-b611-c3190574373c",
     "_self": "https://health-api.gini.net/paymentRequests/b4bd3e80-7bd1-11e4-95ab-000000000000"
  }
}

//get a payment request from Pay API

GET /paymentRequests/b4bd3e80-7bd1-11e4-95ab-000000000000
Host: pay-api.gini.net
Authorization: BEARER c796535e-32e4-11eb-b966-e30e07dee3dc
Accept: application/vnd.gini.v1+json

//response

{
  "createdAt": "2020-12-07T15:50:23",
  "recipient": "Dr. med. Hackler",
  "iban": "DE02300209000106531065",
  "requesterUri": "ginipay-example://payment-requester?paymentRequestId=b4bd3e80-7bd1-11e4-95ab-000000000000",
  "bic": "CMCIDEDDXXX",
  "amount": "335.50:EUR",
  "purpose": "ReNr AZ356789Z",
  "status": "paid",
  "_links": {
     "payment": "https://pay-api.gini.net/paymentRequests/b4bd3e80-7bd1-11e4-95ab-000000000000/payment",
     "sourceDocumentLocation": "https://pay-api.gini.net/documents/88090c5a-32ed-11eb-9e1a-9f2bc4656a7d",
     "_self": "https://pay-api.gini.net/paymentRequests/b4bd3e80-7bd1-11e4-95ab-000000000000"
  }
}