# /paymentmethods/idealqr/v1/transactions/{transactionId}/payments

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Payments Gateway",
    "description": "Common payments API",
    "version": "1.23.0"
  },
  "security": [
    {
      "oAuth2ClientCredentials": []
    }
  ],
  "servers": [
    {
      "url": "/api/v1/"
    }
  ],
  "paths": {
    "/paymentmethods/idealqr/v1/transactions/{transactionId}/payments": {
      "get": {
        "tags": [
          "idealqr"
        ],
        "operationId": "getIdealqrTransactionPayments",
        "parameters": [
          {
            "name": "transactionId",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Uuid"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "schema": {
              "$ref": "#/components/schemas/PageSize"
            }
          },
          {
            "name": "after",
            "in": "query",
            "schema": {
              "$ref": "#/components/schemas/After"
            }
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/IdealQRTransactionPaymentsPaginated"
          },
          "4XX": {
            "$ref": "#/components/responses/UserError"
          },
          "5XX": {
            "$ref": "#/components/responses/InternalError"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Uuid": {
        "description": "Unique identifier",
        "type": "string",
        "format": "uuid",
        "minLength": 36,
        "maxLength": 36,
        "example": "8db1e7fa-ba8a-4189-92fd-67a20217443d"
      },
      "Datetime": {
        "description": "ISO 8601 date and time",
        "type": "string",
        "format": "date-time",
        "minLength": 20,
        "example": "2006-01-02T15:04:05Z"
      },
      "Amount": {
        "description": "Denomination in the smallest currency subunit, as for example eurocents.",
        "type": "integer",
        "minimum": 1,
        "maximum": 99999999,
        "example": 1200
      },
      "BIC": {
        "description": "Bank Identification Code",
        "type": "string",
        "minLength": 8,
        "maxLength": 11,
        "example": "RABONL2U"
      },
      "IdealqrPayment": {
        "type": "object",
        "required": [
          "payment",
          "transaction",
          "idealTransactionId",
          "status",
          "createdAt"
        ],
        "properties": {
          "payment": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Uuid"
              },
              {
                "example": "433a3406-3460-4795-b7ed-b5b9ad1aa9bf"
              }
            ]
          },
          "transaction": {
            "$ref": "#/components/schemas/Uuid"
          },
          "idealTransactionId": {
            "description": "The 16-digit transaction ID within the iDEAL scheme as known by the acquirer and issuing bank, and \nused in the credit transfer. The value can have leading zeros.\nThis value is `null` if the status `FAILURE`.",
            "type": "string",
            "nullable": true,
            "minLength": 16,
            "maxLength": 16,
            "example": 1234567890123456
          },
          "status": {
            "description": "* `SUCCESS`   - Payment has succeeded.\n* `CANCELLED` - Payment has not succeeded; cancelled by the consumer.\n* `EXPIRED`   - Payment has not succeeded; expired.\n* `FAILURE`   - Payment has not succeeded; unknown reason.\n",
            "type": "string",
            "enum": [
              "SUCCESS",
              "FAILURE",
              "CANCELLED",
              "EXPIRED"
            ]
          },
          "createdAt": {
            "$ref": "#/components/schemas/Datetime"
          },
          "amount": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Amount"
              },
              {
                "description": "Denomination in the smallest currency subunit, as for example eurocents.\nOnly present in successful payments.\n"
              }
            ]
          },
          "consumerName": {
            "description": "Name of the consumer. Only present in successful payments.",
            "type": "string",
            "example": "John"
          },
          "consumerBic": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BIC"
              },
              {
                "description": "Bank Identification Code. Only present in successful payments."
              }
            ]
          },
          "consumerIban": {
            "description": "IBAN of the consumer. Only present in successful payments.",
            "type": "string",
            "example": "NL24RABO8487376045"
          }
        }
      },
      "PageSize": {
        "description": "The number of elements to be returned",
        "type": "integer",
        "minimum": 10,
        "maximum": 100,
        "example": 20
      },
      "After": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Datetime"
          },
          {
            "description": "Return the elements that were created after this date"
          },
          {
            "example": "2022-10-13T14:21:30.478935Z"
          }
        ]
      }
    },
    "responses": {
      "IdealQRTransactionPaymentsPaginated": {
        "description": "iDEAL-QR Payments details",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "total",
                "pageSize",
                "payments"
              ],
              "properties": {
                "total": {
                  "description": "The total of payments that the order has",
                  "type": "integer",
                  "example": 150
                },
                "pageSize": {
                  "$ref": "#/components/schemas/PageSize"
                },
                "payments": {
                  "type": "array",
                  "items": {
                    "allOf": [
                      {
                        "$ref": "#/components/schemas/IdealqrPayment"
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      },
      "InternalError": {
        "description": "Internal server error. This can be caused by an unresponsive backend",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "id",
                "message"
              ],
              "properties": {
                "id": {
                  "$ref": "#/components/schemas/Uuid"
                },
                "message": {
                  "type": "string",
                  "example": "Service Unavailable"
                }
              }
            }
          }
        }
      },
      "UserError": {
        "description": "The user input was incorrect or something illegal was attempted (eg. using a service without having that service configured for the user, or not being authorized)",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "id",
                "message"
              ],
              "properties": {
                "id": {
                  "$ref": "#/components/schemas/Uuid"
                },
                "message": {
                  "type": "string",
                  "example": "no authorization methods provided"
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "oAuth2ClientCredentials": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "/api/v1/authorization/oauth2/token",
            "scopes": {}
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 103,
      "1": 234,
      "2": 76,
      "3": 191,
      "4": 145,
      "5": 198,
      "6": 48,
      "7": 79,
      "8": 46,
      "9": 249,
      "10": 185,
      "11": 249
    }
  }
}
```