OpenApi Payins

openApiPayins.md

Show Payins

Returns json data about the client's payins from the most recent to the oldest.

• URL

  BETA : apibeta.koalect.com/openapi/payins

  Production : api.koalect.com/openapi/payins

• Method:

  GET

• Header Params

  Authorization header has to contain your API Key.

• URL Params

  Required:

  None.

  Allowed:

  page=[integer]

  limit=[integer]

• Success Response:

  • Code: 200 Content:

    {
      "data": [{
        "id": 1109,
        "amount": 740,
        "date": "2016-08-12 15:27:17",
        "mangopay_transaction_id": "1035353542",
        "payment_method": "VISA",
        "project": {
            "id": 1025227,
            "title": {
              "default": "Test project"
            },
            "goal_amount": 9524,
            "benefiting_organisation": "Save the turtles",
            "project_code": "BRA-3997-9901",
            "projectnummer": "9901",
            "oude_code": "248718"
        },
        "user": {
            "firstname": "Jean",
            "lastname": "SMITH",
            "email": "jeansmith@example.com",
            "birthday": "1989-01-01",
            "address": {
                "street": "Rue de la rue",
                "number": "7",
                "box": "6",
                "postal_code": "1133548",
                "city": "City",
                "country": "Country"
            }
        }
      }],
      "error": null,
      "page": 1,
      "limit": 1,
      "total_pages": 12,
      "total_transactions": 12
    }

• Error Response:

  • Code: 422 Unprocessable entity Content:

    {
      "data": null,
      "error": "Invalid parameters"
    }

  OR

  • Code: 401 Unauthorized Content:

    {
      "data": null,
      "error": "Invalid API key."
    }