{
  "opencollection": "1.0.0",
  "info": {
    "name": "Mastercard Bill Payment Validator Account Opening Donations API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Donations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Recurring Donation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/donors/:donor_id/setups/:donation_setup_id",
            "headers": [
              {
                "name": "x-openapi-clientid",
                "value": ""
              },
              {
                "name": "x-correlation-id",
                "value": ""
              },
              {
                "name": "ProgramId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "donation_setup_id",
                "value": "",
                "type": "path",
                "description": "donation_setup_id"
              },
              {
                "name": "donor_id",
                "value": "",
                "type": "path",
                "description": "donor_id"
              }
            ]
          },
          "docs": "Retrieve donation setup details by setupid"
        },
        {
          "info": {
            "name": "Update Recurring Donation",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/donors/:donor_id/setups/:donation_setup_id",
            "headers": [
              {
                "name": "x-openapi-clientid",
                "value": ""
              },
              {
                "name": "x-correlation-id",
                "value": ""
              },
              {
                "name": "ProgramId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "donation_setup_id",
                "value": "",
                "type": "path",
                "description": "donation_setup_id"
              },
              {
                "name": "donor_id",
                "value": "",
                "type": "path",
                "description": "donor_id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update Monthly, Micro or Round-up donation for a registered user. Encrypting request body is not required."
        },
        {
          "info": {
            "name": "Delete Recurring Donation",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/donors/:donor_id/setups/:donation_setup_id",
            "headers": [
              {
                "name": "x-openapi-clientid",
                "value": ""
              },
              {
                "name": "x-correlation-id",
                "value": ""
              },
              {
                "name": "ProgramId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "donation_setup_id",
                "value": "",
                "type": "path",
                "description": "donation_setup_id"
              },
              {
                "name": "donor_id",
                "value": "",
                "type": "path",
                "description": "donor_id"
              }
            ]
          },
          "docs": "Delete Monthly, Micro or Round-up donation for a registered user"
        },
        {
          "info": {
            "name": "Get All Non Mastercard Brand Cards API",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/donations/non-ma/setup/cards",
            "headers": [
              {
                "name": "x-openapi-clientid",
                "value": ""
              },
              {
                "name": "x-correlation-id",
                "value": ""
              },
              {
                "name": "ProgramId",
                "value": ""
              }
            ]
          },
          "docs": "This API is used by the API consumer to download all their Non-Mastercard registered cards."
        },
        {
          "info": {
            "name": "Donation Transaction Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/donations/transactions",
            "headers": [
              {
                "name": "x-openapi-clientid",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "transactionId",
                "value": "",
                "type": "query",
                "description": "TransactionId is a unique identifier for the donation at Mastercard Donate platform. It is recommended to pass the transactionId as query parameter by the customer while retrieving its status. If correlation Id not passed as query parameter, then this field becomes mandatory."
              },
              {
                "name": "correlationId",
                "value": "",
                "type": "query",
                "description": "CorrelationId is a unique donation request ID. It is recommended to pass the x-correlation-id by the customer while retrieving the donation transaction status. If transaction Id not passed as query parameter, then this field becomes mandatory."
              }
            ]
          },
          "docs": "This API can retrieve the status of a particular donation transaction by passing the respective transaction Id or correlation Id. To retrieve the transaction status, donor need to provide either the `transactionId` or `correlationId` or both as query parameters. In case both parameters are passed, transaction Id value takes precedence over correlation Id."
        },
        {
          "info": {
            "name": "Program Transaction History API",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/donations/program/:programId/transactions",
            "headers": [
              {
                "name": "x-openapi-clientid",
                "value": ""
              },
              {
                "name": "x-correlation-id",
                "value": ""
              },
              {
                "name": "ProgramId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "donor_id",
                "value": "",
                "type": "query",
                "description": "Donor"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "limit"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "offset"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Get Program Transaction History Details based on retrieves a list of donation transactions by programId in a given timeframe.\"cardID\", \"charityID\" and \"donationType\" are optional fields. If a Micro donation is setup, it won't show up in Program Transaction History until the end of the month when the transaction happen. Encrypting request body is not required."
        },
        {
          "info": {
            "name": "Upload Non Mastercard Brand Card transactions API",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/donations/non-ma/transactions",
            "headers": [
              {
                "name": "x-openapi-clientid",
                "value": ""
              },
              {
                "name": "ProgramId",
                "value": ""
              },
              {
                "name": "x-correlation-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API is to be used by API Consumer to upload the non-Mastercard transactions details to the Donate Platform."
        },
        {
          "info": {
            "name": "Record API",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/donations/record",
            "headers": [
              {
                "name": "x-openapi-clientid",
                "value": ""
              },
              {
                "name": "x-correlation-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This API is used to store all external donations. Entire request body should be encrypted."
        }
      ]
    }
  ],
  "bundled": true
}