{
  "opencollection": "1.0.0",
  "info": {
    "name": "WildApricot Admin Accounts Finances.Payments API",
    "version": "7.24.0"
  },
  "items": [
    {
      "info": {
        "name": "Finances.Payments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "WildApricot Get List of Payments by Criteria.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wildapricot.org/v2.2/accounts/:accountId/payments",
            "params": [
              {
                "name": "contactId",
                "value": "",
                "type": "query",
                "description": "Identifier of contact who made the payment."
              },
              {
                "name": "eventId",
                "value": "",
                "type": "query",
                "description": "Identifier of event. When specified API returns collection of payments settled to invoices associated with event registrations for the event."
              },
              {
                "name": "idsOnly",
                "value": "",
                "type": "query",
                "description": "When set to true, API returns only collection of identifiers instead of collection of payments."
              },
              {
                "name": "StartDate",
                "value": "",
                "type": "query",
                "description": "Limits result to payments created since StartDate."
              },
              {
                "name": "EndDate",
                "value": "",
                "type": "query",
                "description": "Limits result to payments created before EndDate."
              },
              {
                "name": "paimentType",
                "value": "",
                "type": "query",
                "description": "Limits result to payment type."
              },
              {
                "name": "unsettledOnly",
                "value": "",
                "type": "query",
                "description": "When set to true, API returns only unsettled payments."
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "You can filter the payments by specifying a set of payment IDs."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.wildapricot.org/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "WildApricot Get List of Payments by Criteria."
        },
        {
          "info": {
            "name": "WildApricot Creates a New Payment.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wildapricot.org/v2.2/accounts/:accountId/payments",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.wildapricot.org/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "WildApricot Creates a New Payment."
        },
        {
          "info": {
            "name": "WildApricot Retrieve Information About Specific Payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wildapricot.org/v2.2/accounts/:accountId/payments/:paymentId",
            "params": [
              {
                "name": "paymentId",
                "value": "",
                "type": "path",
                "description": "Unique payment identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.wildapricot.org/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "WildApricot Retrieve Information About Specific Payment"
        },
        {
          "info": {
            "name": "WildApricot Update Existing Payment Information",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.wildapricot.org/v2.2/accounts/:accountId/payments/:paymentId",
            "params": [
              {
                "name": "paymentId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.wildapricot.org/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "WildApricot Update Existing Payment Information"
        },
        {
          "info": {
            "name": "WildApricot Delete Existing Payment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.wildapricot.org/v2.2/accounts/:accountId/payments/:paymentId",
            "params": [
              {
                "name": "paymentId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.wildapricot.org/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "WildApricot Delete Existing Payment"
        },
        {
          "info": {
            "name": "WildApricot Allocate Invoice to Specific Payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wildapricot.org/v2.2/accounts/:accountId/payments/:paymentId/AllocateInvoice",
            "params": [
              {
                "name": "paymentId",
                "value": "",
                "type": "path",
                "description": "Unique payment identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.wildapricot.org/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "After this operation invoice will be marked as paid."
        },
        {
          "info": {
            "name": "WildApricot Allocate Refund to Specific Payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wildapricot.org/v2.2/accounts/:accountId/payments/:paymentId/AllocateRefundToPayment",
            "params": [
              {
                "name": "paymentId",
                "value": "",
                "type": "path",
                "description": "Unique payment identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.wildapricot.org/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "WildApricot Allocate Refund to Specific Payment"
        },
        {
          "info": {
            "name": "WildApricot Allocate Refund to Specific Donation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wildapricot.org/v2.2/accounts/:accountId/payments/:donationId/AllocateRefundToDonation",
            "params": [
              {
                "name": "donationId",
                "value": "",
                "type": "path",
                "description": "Unique donation identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.wildapricot.org/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "WildApricot Allocate Refund to Specific Donation"
        },
        {
          "info": {
            "name": "WildApricot Unallocate Finance Document from Specific Payment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wildapricot.org/v2.2/accounts/:accountId/payments/:paymentId/UnallocateFromPayment",
            "params": [
              {
                "name": "paymentId",
                "value": "",
                "type": "path",
                "description": "Unique payment identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.wildapricot.org/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "WildApricot Unallocate Finance Document from Specific Payment"
        },
        {
          "info": {
            "name": "WildApricot Unallocate Finance Document from Specific Donation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.wildapricot.org/v2.2/accounts/:accountId/payments/:donationId/UnallocateFromDonation",
            "params": [
              {
                "name": "donationId",
                "value": "",
                "type": "path",
                "description": "Unique donation identifier"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://oauth.wildapricot.org/auth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "WildApricot Unallocate Finance Document from Specific Donation"
        }
      ]
    }
  ],
  "bundled": true
}