Resolve Payment Requests

A payment is sent by a payment provider in order to resolve a payment request after it was paid. The response contains the resolved payment request.

Request body

Key	Mandatory	Description

Key	Mandatory	Description
`recipient`	no	The recipient of the payment.
`iban`	yes	The IBAN (international bank account number) of the payment recipient.
`bic`	no	The BIC (bank identifier code) for the payment.
`amount`	yes	The amount of the payment. See Amount.
`purpose`	yes	The purpose of the payment, for example, the invoice or customer identifier.

//post the payment

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

//with

{
  "recipient": "Dr. med. Hackler",
  "iban": "DE02300209000106531065",
  "bic": "CMCIDEDDXXX",
  "amount": "335.50:EUR",
  "purpose": "ReNr AZ356789Z"
}

Response

//response

HTTP/1.1 201 Created
X-Request-Id: 7b5a7f79-ae7c-4040-b6cf-25cde58ad937
Content-Type: application/vnd.gini.v1+json

{
  "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"
  }
}

For more information, see Get Payment Request.

Pay API

Resolve Payment Requests

Request body

Response

Related content