Requirements

In order to fetch the payment receipt indicating that a user has initiated a payment, you require the payment-id that has been returned to you in the response of the previous steps.

Endpoints Overview

Request Example:

GET /payment-receipts/{receipt-id}

Example Response:

{
  "id": "3ca31c37-986a-454e-ad64-8e97143c86bc",
  "debtor": {
    "iban": "DE93300308800013441006"
  },
  "creditor": {
    "iban": "DE93300308800013441006",
    "name": "John Doe"
  },
  "amount": {
    "value": 23.99,
    "currency": "EUR"
  },
  "purpose": "Thanks for all the fish.",
  "submitted_at": "2019-08-24T14:15:22Z",
}

The submitted_atfield refers to the time at which the payment was submitted to the payment provider.

📘

1. This call might return a 404 as long as the user is still being guided through the flow but has not initiated the payment at the bank. The same holds true if the user aborts the flow.
2. The payment receipt is only available for 1 hour after the payment process is sucessfully processed.
3. The payment receipt is not a payment guarantee, it is only a confirmation from the bank that the payment was successfully submitted by the user. In case of insufficient balance the bank still might reject the payment at a later time, e.g. during booking hours

Error Handling

The finX API employs HTTP status codes to indicate the outcome of each API request. Familiarity with these codes is essential for understanding the response.

200 OK: This status code indicates a successful request, typically returned when retrieving account or transaction data.

400 Bad Request: If the request is malformed, contains missing or invalid parameters, or violates validation rules, the API responds with a 400 status code.

401 Unauthorized: When the provided authorization is insufficient or invalid, the API responds with a 401 status code, indicating the need for proper user authentication.