{"openapi":"3.0.1","info":{"title":"payments","version":"1.2.0.2345"},"servers":[{"url":"https://api.pushpay.com/"}],"paths":{"/v1/merchant/{merchantKey}/recurringpayment/{token}":{"get":{"tags":["payments"],"summary":"Get a person's recurring payment","description":"Retrieves a single recurring payment record, given the keys for the merchant and the payment","operationId":"getRecurringPayment","parameters":[{"name":"merchantKey","in":"path","description":"The unique key of the merchant - a case-sensitive series of characters","required":true,"schema":{"type":"string"}},{"name":"token","in":"path","description":"The token is a unique identifier for this resource - a case-sensitive series of characters","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/RecurringPaymentRepresentation"}}}},"400":{"description":"The server will not process the request due to a client error","content":{}},"401":{"description":"Request failed because the client was not authorized to perform this action","content":{}},"404":{"description":"Could not find resource","content":{}},"429":{"description":"Request was throttled due to too many requests from this client or IP address","content":{}}},"security":[{"oauth2":["merchant:view_recurring_payments","read"]}]}},"/v1/organization/{organizationKey}/recurringpayments":{"get":{"tags":["payments"],"summary":"Get all recurring payments associated with an organization","description":"Retrieves all recurring payment records associated with an organization","operationId":"getOrganizationRecurring","parameters":[{"name":"organizationKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"updatedFrom","in":"query","description":"Only include payments changed after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"updatedTo","in":"query","description":"Only include payments changed before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"createdFrom","in":"query","description":"Only include payments after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"createdTo","in":"query","description":"Only include payments before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"status","in":"query","description":"Filter recurring payments by status, acceptable values are any combination of (Active, Cancelled, Paused)","required":true,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["Active","Cancelled","Completed","Paused"]}}},{"name":"orderBy","in":"query","description":"Order data by a particular property in ascending or descending order. Uses format 'PropertyName ASC' or 'PropertyName DESC'","schema":{"type":"string"}},{"name":"page","in":"query","description":"The page parameter (Note: page numbering starts at 0)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"The page size parameter (Note: default page size is 25)","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/OrganizationPagedRecurringPaymentsRepresentation"}}}},"400":{"description":"The server will not process the request due to a client error","content":{}},"401":{"description":"Request failed because the client was not authorized to perform this action","content":{}},"404":{"description":"Could not find resource","content":{}},"429":{"description":"Request was throttled due to too many requests from this client or IP address","content":{}}},"security":[{"oauth2":["merchant:view_recurring_payments"]}]}},"/v1/paymentmethod/{key}":{"get":{"tags":["payments"],"summary":"Get specific payment method (identified by its key) for this pushpayer","description":"This operation requires that the OAuth2 bearer token include a 'sub' (subject) claim.","operationId":"getPaymentMethod","parameters":[{"name":"key","in":"path","description":"The unique index of the payment method (Note: payment method indexes are only unique per pushpayer)","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PaymentMethodRepresentation"}}}},"400":{"description":"The server will not process the request due to a client error","content":{}},"401":{"description":"Request failed because the client was not authorized to perform this action","content":{}},"404":{"description":"Could not find resource","content":{}},"429":{"description":"Request was throttled due to too many requests from this client or IP address","content":{}}},"security":[{"oauth2":["read"]}]}},"/v1/merchant/{merchantKey}/recurringpayment/{paymentToken}/payments":{"get":{"tags":["payments"],"summary":"Get payment for a recurring payment","operationId":"getRecurringPaymentPayments","parameters":[{"name":"merchantKey","in":"path","description":"The unique key of the merchant - a case-sensitive series of characters","required":true,"schema":{"type":"string"}},{"name":"paymentToken","in":"path","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Only include payments after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"Only include payments before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"createdFrom","in":"query","description":"Only include payments after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"createdTo","in":"query","description":"Only include payments before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"updatedFrom","in":"query","description":"Only include payments changed after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"updatedTo","in":"query","description":"Only include payments changed before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"orderby","in":"query","description":"Order data by a particular property in ascending or descending order. Uses format 'PropertyName ASC' or 'PropertyName DESC'","schema":{"type":"string"}},{"name":"type","in":"query","description":"Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount). If payment type is not explicitly set then all payments except for non cash gifts will be returned. To get all types of payments use All value.","schema":{"type":"string","enum":["ACH","AchCheck","All","Cash","CreditCard","DepositedCheck","NonCash","NzBankAccount","RecordedCheck"]}},{"name":"status","in":"query","description":"Only include payments with the specified status (Success, Failed, or Processing)","schema":{"type":"string","enum":["Failed","Processing","Success"]}},{"name":"source","in":"query","description":"Only include payment sources of (Mobile, Web, Recurring, Kiosk, VirtualTerminal, TextGiving, CheckDeposit, TransactionImport or BatchEntry). If payment source is not explicitly set then all payments except for TransactionImport payments will be returned.","schema":{"type":"string","enum":["BatchEntry","CheckDeposit","Kiosk","Mobile","Recurring","TextGiving","TransactionImport","VirtualTerminal","Web"]}},{"name":"page","in":"query","description":"The page parameter (Note: page numbering starts at 0)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"The page size parameter (Note: default page size is 25)","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PaymentsRepresentation"}}}},"400":{"description":"The server will not process the request due to a client error","content":{}},"401":{"description":"Request failed because the client was not authorized to perform this action","content":{}},"404":{"description":"Could not find resource","content":{}},"429":{"description":"Request was throttled due to too many requests from this client or IP address","content":{}}},"security":[{"oauth2":["merchant:view_recurring_payments","read"]}]}},"/v1/merchant/{merchantKey}/recurringpayments":{"get":{"tags":["payments"],"summary":"Get all recurring payments associated with a merchant","description":"Retrieves all recurring payment records associated with a merchant","operationId":"getPersonRecurring","parameters":[{"name":"merchantKey","in":"path","description":"The unique key of the merchant - a case-sensitive series of characters","required":true,"schema":{"type":"string"}},{"name":"updatedFrom","in":"query","description":"Only include payments changed after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"updatedTo","in":"query","description":"Only include payments changed before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"createdFrom","in":"query","description":"Only include payments after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"createdTo","in":"query","description":"Only include payments before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"status","in":"query","description":"Filter recurring payments by status, acceptable values are any combination of (Active, Cancelled, Paused)","required":true,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["Active","Cancelled","Completed","Paused"]}}},{"name":"orderBy","in":"query","description":"Order data by a particular property in ascending or descending order. Uses format 'PropertyName ASC' or 'PropertyName DESC'","schema":{"type":"string"}},{"name":"page","in":"query","description":"The page parameter (Note: page numbering starts at 0)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"The page size parameter (Note: default page size is 25)","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedRecurringPaymentsRepresentation"}}}},"400":{"description":"The server will not process the request due to a client error","content":{}},"401":{"description":"Request failed because the client was not authorized to perform this action","content":{}},"404":{"description":"Could not find resource","content":{}},"429":{"description":"Request was throttled due to too many requests from this client or IP address","content":{}}},"security":[{"oauth2":["merchant:view_recurring_payments"]}]}},"/v1/organization/{organizationKey}/payments":{"get":{"tags":["payments"],"summary":"Get payment for this organization","operationId":"getOrganizationPayments","parameters":[{"name":"organizationKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Only include payments after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"Only include payments before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"createdFrom","in":"query","description":"Only include payments after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"createdTo","in":"query","description":"Only include payments before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"updatedFrom","in":"query","description":"Only include payments changed after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"updatedTo","in":"query","description":"Only include payments changed before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"orderby","in":"query","description":"Order data by a particular property in ascending or descending order. Uses format 'PropertyName ASC' or 'PropertyName DESC'","schema":{"type":"string"}},{"name":"type","in":"query","description":"Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount). If payment type is not explicitly set then all payments except for non cash gifts will be returned. To get all types of payments use All value.","schema":{"type":"string","enum":["ACH","AchCheck","All","Cash","CreditCard","DepositedCheck","NonCash","NzBankAccount","RecordedCheck"]}},{"name":"status","in":"query","description":"Only include payments with the specified status (Success, Failed, or Processing)","schema":{"type":"string","enum":["Failed","Processing","Success"]}},{"name":"source","in":"query","description":"Only include payment sources of (Mobile, Web, Recurring, Kiosk, VirtualTerminal, TextGiving, CheckDeposit, TransactionImport or BatchEntry). If payment source is not explicitly set then all payments except for TransactionImport payments will be returned.","schema":{"type":"string","enum":["BatchEntry","CheckDeposit","Kiosk","Mobile","Recurring","TextGiving","TransactionImport","VirtualTerminal","Web"]}},{"name":"page","in":"query","description":"The page parameter (Note: page numbering starts at 0)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"The page size parameter (Note: default page size is 25)","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/OrganizationPaymentsListRepresentation"}}}},"400":{"description":"The server will not process the request due to a client error","content":{}},"401":{"description":"Request failed because the client was not authorized to perform this action","content":{}},"404":{"description":"Could not find resource","content":{}},"429":{"description":"Request was throttled due to too many requests from this client or IP address","content":{}}},"security":[{"oauth2":["merchant:view_payments"]}]}},"/v1/paymentmethods":{"get":{"tags":["payments"],"summary":"Get payment methods for this pushpayer","description":"This operation requires that the OAuth2 bearer token include a 'sub' (subject) claim.","operationId":"getPaymentMethods","responses":{"200":{"description":"success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PaymentMethodListRepresentation"}}}},"400":{"description":"The server will not process the request due to a client error","content":{}},"401":{"description":"Request failed because the client was not authorized to perform this action","content":{}},"429":{"description":"Request was throttled due to too many requests from this client or IP address","content":{}}},"security":[{"oauth2":["read"]}]}},"/v1/merchant/{merchantKey}/payment/{token}":{"get":{"tags":["payments"],"summary":"Get a payment made to a merchant identified by its payment token","operationId":"getPayment","parameters":[{"name":"merchantKey","in":"path","description":"The unique key of the merchant - a case-sensitive series of characters","required":true,"schema":{"type":"string"}},{"name":"token","in":"path","description":"The token is a unique identifier for this resource - a case-sensitive series of characters","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PaymentRepresentation"}}}},"400":{"description":"The server will not process the request due to a client error","content":{}},"401":{"description":"Request failed because the client was not authorized to perform this action","content":{}},"404":{"description":"Could not find resource","content":{}},"429":{"description":"Request was throttled due to too many requests from this client or IP address","content":{}}},"security":[{"oauth2":["merchant:view_payments","read"]}]}},"/v1/merchant/{merchantKey}/splitpayment/{splitPaymentKey}":{"get":{"tags":["payments"],"summary":"Get a split payment made to a merchant identified by its key","operationId":"getSplitPayment","parameters":[{"name":"merchantKey","in":"path","description":"The unique key of the merchant - a case-sensitive series of characters","required":true,"schema":{"type":"string"}},{"name":"splitPaymentKey","in":"path","description":"The unique key of the split payment - a case-sensitive series of characters","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/SplitPaymentRepresentation"}}}},"400":{"description":"The server will not process the request due to a client error","content":{}},"401":{"description":"Request failed because the client was not authorized to perform this action","content":{}},"404":{"description":"Could not find resource","content":{}},"429":{"description":"Request was throttled due to too many requests from this client or IP address","content":{}}},"security":[{"oauth2":["merchant:view_payments","read"]}]}},"/v1/merchant/{merchantKey}/payments":{"get":{"tags":["payments"],"summary":"Get payment for this merchant","operationId":"getMerchantPayments","parameters":[{"name":"merchantKey","in":"path","description":"The unique key of the merchant - a case-sensitive series of characters","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Only include payments after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"Only include payments before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"createdFrom","in":"query","description":"Only include payments after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"createdTo","in":"query","description":"Only include payments before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"updatedFrom","in":"query","description":"Only include payments changed after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"updatedTo","in":"query","description":"Only include payments changed before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"orderby","in":"query","description":"Order data by a particular property in ascending or descending order. Uses format 'PropertyName ASC' or 'PropertyName DESC'","schema":{"type":"string"}},{"name":"type","in":"query","description":"Only include payments made with the specified type of payment method (ACH, CreditCard, DepositedCheck, or NzBankAccount). If payment type is not explicitly set then all payments except for non cash gifts will be returned. To get all types of payments use All value.","schema":{"type":"string","enum":["ACH","AchCheck","All","Cash","CreditCard","DepositedCheck","NonCash","NzBankAccount","RecordedCheck"]}},{"name":"status","in":"query","description":"Only include payments with the specified status (Success, Failed, or Processing)","schema":{"type":"string","enum":["Failed","Processing","Success"]}},{"name":"source","in":"query","description":"Only include payment sources of (Mobile, Web, Recurring, Kiosk, VirtualTerminal, TextGiving, CheckDeposit, TransactionImport or BatchEntry). If payment source is not explicitly set then all payments except for TransactionImport payments will be returned.","schema":{"type":"string","enum":["BatchEntry","CheckDeposit","Kiosk","Mobile","Recurring","TextGiving","TransactionImport","VirtualTerminal","Web"]}},{"name":"page","in":"query","description":"The page parameter (Note: page numbering starts at 0)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"The page size parameter (Note: default page size is 25)","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PaymentsRepresentation"}}}},"400":{"description":"The server will not process the request due to a client error","content":{}},"401":{"description":"Request failed because the client was not authorized to perform this action","content":{}},"404":{"description":"Could not find resource","content":{}},"429":{"description":"Request was throttled due to too many requests from this client or IP address","content":{}}},"security":[{"oauth2":["merchant:view_payments"]}]}},"/v1/person/{memberKey}/recurringpayments":{"get":{"tags":["payments"],"summary":"Get all recurring payments associated with a payer","description":"Retrieves all recurring payment records associated with a payer","operationId":"getRecurringPayments","parameters":[{"name":"memberKey","in":"path","description":"The unique key of the community member - a case-sensitive series of characters","required":true,"schema":{"type":"string"}},{"name":"updatedFrom","in":"query","description":"Only include payments changed after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"updatedTo","in":"query","description":"Only include payments changed before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"createdFrom","in":"query","description":"Only include payments after a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"createdTo","in":"query","description":"Only include payments before a date/time (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"status","in":"query","description":"Filter recurring payments by status, acceptable values are any combination of (Active, Cancelled, Paused)","required":true,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["Active","Cancelled","Completed","Paused"]}}},{"name":"orderBy","in":"query","description":"Order data by a particular property in ascending or descending order. Uses format 'PropertyName ASC' or 'PropertyName DESC'","schema":{"type":"string"}},{"name":"page","in":"query","description":"The page parameter (Note: page numbering starts at 0)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"The page size parameter (Note: default page size is 25)","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/PagedRecurringPaymentsRepresentation"}}}},"400":{"description":"The server will not process the request due to a client error","content":{}},"401":{"description":"Request failed because the client was not authorized to perform this action","content":{}},"404":{"description":"Could not find resource","content":{}},"429":{"description":"Request was throttled due to too many requests from this client or IP address","content":{}}},"security":[{"oauth2":["merchant:view_recurring_payments","read"]}]}}},"components":{"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.pushpay.com/oauth/token","scopes":{"manage_webhooks":"Grants access to manage webhooks.","merchant:manage_webhooks":"Grants access to manage webhooks for a specific merchant.","read":"Grants read-only access."}}}}},"schemas":{"SplitPaymentRepresentation":{"required":["_links","items","key","totalAmount"],"type":"object","properties":{"key":{"type":"string"},"totalAmount":{"$ref":"#/components/schemas/Money"},"items":{"type":"array","items":{"$ref":"#/components/schemas/PaymentRepresentation"}},"_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"CardPaymentMethod":{"type":"object","properties":{"reference":{"type":"string"},"brand":{"type":"string"},"logo":{"type":"object","properties":{}},"cardSource":{"type":"string","enum":["Apple","Direct"]}}},"IntegrationDetails":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"PaymentBatchDetails":{"required":["createdOn","id","key","name","type"],"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["BatchEntry","CheckDeposit"]},"createdOn":{"type":"string"}}},"PaymentRefundDetails":{"type":"object","properties":{"transactionId":{"type":"string"},"paymentToken":{"type":"string"}}},"Money":{"required":["amount","currency"],"type":"object","properties":{"currency":{"type":"string","enum":["AUD","CAD","NZD","Unspecified","USD"]},"amount":{"type":"string"}}},"PagedRecurringPaymentsRepresentation":{"required":["_links","items","page","pageSize"],"type":"object","properties":{"page":{"type":"integer"},"pageSize":{"type":"integer"},"total":{"type":"integer"},"totalPages":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/RecurringPaymentRepresentation"}},"_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"FundDetails":{"required":["code","key","name","taxDeductible"],"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"},"taxDeductible":{"type":"boolean"}}},"OrganizationPagedRecurringPaymentsRepresentation":{"required":["_links","items","organizationKey","page","pageSize"],"type":"object","properties":{"organizationKey":{"type":"string"},"page":{"type":"integer"},"pageSize":{"type":"integer"},"total":{"type":"integer"},"totalPages":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/RecurringPaymentRepresentation"}},"_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"PaymentMethodRepresentation":{"required":["_links","key","nickname","reference","title","type"],"type":"object","properties":{"key":{"type":"integer"},"nickname":{"type":"string"},"type":{"type":"string","enum":["ACH","AchCheck","All","Cash","CreditCard","DepositedCheck","NonCash","NzBankAccount","RecordedCheck"]},"reference":{"type":"string"},"isPreferred":{"type":"boolean"},"title":{"type":"string"},"icon":{"type":"string"},"_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"CheckPaymentMethod":{"type":"object","properties":{"routingNumber":{"type":"string"},"reference":{"type":"string"},"bankName":{"type":"string"},"checkNumber":{"type":"string"}}},"CampusDetails":{"required":["key","name"],"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"}}},"FieldValue":{"required":["key"],"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"label":{"type":"string"}}},"RecurringPaymentRepresentation":{"required":["_links","createdOn","externalLinks","fields","paymentMethodType","schedule","source","status","updatedOn"],"type":"object","properties":{"schedule":{"$ref":"#/components/schemas/PaymentScheduleDetails"},"status":{"type":"string","enum":["Active","Cancelled","Completed","Paused","Pending"]},"paymentToken":{"type":"string"},"amount":{"$ref":"#/components/schemas/PaymentAmountRepresentation"},"payer":{"$ref":"#/components/schemas/PayerRepresentation"},"communityMember":{"$ref":"#/components/schemas/CommunityMemberDetails"},"recipient":{"$ref":"#/components/schemas/MerchantDetails"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/FieldValue"}},"createdOn":{"type":"string"},"updatedOn":{"type":"string"},"paymentMethodType":{"type":"string","enum":["ACH","AchCheck","All","Cash","CreditCard","DepositedCheck","NonCash","NzBankAccount","RecordedCheck"]},"source":{"type":"string","enum":["Autopay","DirectProcessing","EmbeddedGiving","Fastpay","GuestAnticipatedPayment","HostedPaymentsPage","Kiosk","LoggedInWeb","MobileApp","ScheduledPayment","TextGiving","VirtualTerminal"]},"card":{"$ref":"#/components/schemas/CardPaymentMethod"},"account":{"$ref":"#/components/schemas/AccountPaymentMethod"},"achCheck":{"$ref":"#/components/schemas/CheckPaymentMethod"},"recordedCheck":{"$ref":"#/components/schemas/CheckPaymentMethod"},"recordedACH":{"$ref":"#/components/schemas/RecordedPaymentMethod"},"depositedCheck":{"$ref":"#/components/schemas/CheckPaymentMethod"},"recordedCreditCard":{"$ref":"#/components/schemas/RecordedPaymentMethod"},"importedUnspecified":{"$ref":"#/components/schemas/ImportedUnspecified"},"importedUnsupported":{"$ref":"#/components/schemas/ImportedUnsupported"},"ipAddress":{"type":"string"},"data":{"type":"string"},"givenOn":{"type":"string"},"notes":{"type":"string"},"sourceReference":{"type":"string"},"externalLinks":{"type":"array","items":{"$ref":"#/components/schemas/ExternalLink"}},"fund":{"$ref":"#/components/schemas/FundDetails"},"campus":{"$ref":"#/components/schemas/CampusDetails"},"_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"ErrorResultCode":{"required":["code","description","key"],"type":"object","properties":{"code":{"type":"integer"},"key":{"type":"string"},"description":{"type":"string"}}},"PaymentAmountRepresentation":{"required":["amount","currency","details"],"type":"object","properties":{"amount":{"type":"string"},"currency":{"type":"string","enum":["AUD","CAD","NZD","Unspecified","USD"]},"details":{"$ref":"#/components/schemas/PaymentAmountDetails"}}},"PaymentAmountDetails":{"required":["base"],"type":"object","properties":{"base":{"type":"string"},"fee":{"type":"string"}}},"AddressDetails":{"type":"object","properties":{"country":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XK","YE","YT","ZA","ZM","ZW"]},"line1":{"type":"string"},"line2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zipOrPostCode":{"type":"string"}}},"AccountPaymentMethod":{"type":"object","properties":{"routingNumber":{"type":"string"},"reference":{"type":"string"},"bankName":{"type":"string"},"accountName":{"type":"string"},"accountType":{"type":"string","enum":["Checking","Savings"]}}},"CommunityMemberDetails":{"type":"object","properties":{"key":{"type":"string"}}},"ExternalLink":{"required":["application"],"type":"object","properties":{"application":{"$ref":"#/components/schemas/IntegrationDetails"},"relationship":{"type":"string"},"value":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"validationFailures":{"type":"object","properties":{}},"id":{"type":"string"},"resultCode":{"$ref":"#/components/schemas/ErrorResultCode"}}},"ImportedUnsupported":{"type":"object"},"OrganizationPaymentsListRepresentation":{"required":["_links","items","organizationKey","page","pageSize"],"type":"object","properties":{"organizationKey":{"type":"string"},"page":{"type":"integer"},"pageSize":{"type":"integer"},"total":{"type":"integer"},"totalPages":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/PaymentRepresentation"}},"_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"PaymentMethodListRepresentation":{"required":["_links","items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodRepresentation"}},"_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"PaymentScheduleDetails":{"required":["endType","frequency"],"type":"object","properties":{"frequency":{"type":"string","enum":["FirstAndFifteenth","FiveMinutes","Fortnightly","FourHours","Monthly","OneMinute","Other","Quarterly","SemiYearly","Weekly","Yearly"]},"startDate":{"type":"string"},"endDate":{"type":"string"},"endType":{"type":"string","enum":["Date","Never","Occurrences"]},"endOccurrences":{"type":"integer"},"nextPaymentDate":{"type":"string"},"remainingOccurrences":{"type":"integer"}}},"MerchantDetails":{"required":["role"],"type":"object","properties":{"key":{"type":"string"},"handle":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"}}},"ImportedUnspecified":{"type":"object"},"RecordedPaymentMethod":{"type":"object","properties":{"reference":{"type":"string"}}},"PayerRepresentation":{"required":["_links","emailAddressVerified","exportKey","mobileNumberVerified","payerType","role"],"type":"object","properties":{"key":{"type":"string"},"emailAddress":{"type":"string"},"emailAddressVerified":{"type":"boolean"},"mobileNumber":{"type":"string"},"mobileNumberVerified":{"type":"boolean"},"fullName":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"address":{"$ref":"#/components/schemas/AddressDetails"},"updatedOn":{"type":"string"},"role":{"type":"string"},"payerType":{"type":"string","enum":["Guest","Registered"]},"exportKey":{"type":"string"},"_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"PaymentRepresentation":{"required":["_links","createdOn","externalLinks","fields","paymentMethodType","source","status","updatedOn"],"type":"object","properties":{"status":{"type":"string","enum":["Deleted","Error","Expired","Failed","New","Processing","Success"]},"anticipatedPaymentToken":{"type":"string"},"settlement":{"$ref":"#/components/schemas/SettlementDetails"},"recurringPaymentToken":{"type":"string"},"transactionId":{"type":"string"},"splitPaymentKey":{"type":"string"},"error":{"$ref":"#/components/schemas/ErrorResponse"},"refundFor":{"$ref":"#/components/schemas/PaymentRefundDetails"},"refundedBy":{"$ref":"#/components/schemas/PaymentRefundDetails"},"batchId":{"type":"string"},"batch":{"$ref":"#/components/schemas/PaymentBatchDetails"},"assetType":{"type":"string","enum":["Other","Property","StocksAndBonds","Vehicles"]},"descriptionForDonor":{"type":"string"},"descriptionForMerchant":{"type":"string"},"paymentToken":{"type":"string"},"amount":{"$ref":"#/components/schemas/PaymentAmountRepresentation"},"payer":{"$ref":"#/components/schemas/PayerRepresentation"},"communityMember":{"$ref":"#/components/schemas/CommunityMemberDetails"},"recipient":{"$ref":"#/components/schemas/MerchantDetails"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/FieldValue"}},"createdOn":{"type":"string"},"updatedOn":{"type":"string"},"paymentMethodType":{"type":"string","enum":["ACH","AchCheck","All","Cash","CreditCard","DepositedCheck","NonCash","NzBankAccount","RecordedCheck"]},"source":{"type":"string","enum":["Autopay","DirectProcessing","EmbeddedGiving","Fastpay","GuestAnticipatedPayment","HostedPaymentsPage","Kiosk","LoggedInWeb","MobileApp","ScheduledPayment","TextGiving","VirtualTerminal"]},"card":{"$ref":"#/components/schemas/CardPaymentMethod"},"account":{"$ref":"#/components/schemas/AccountPaymentMethod"},"achCheck":{"$ref":"#/components/schemas/CheckPaymentMethod"},"recordedCheck":{"$ref":"#/components/schemas/CheckPaymentMethod"},"recordedACH":{"$ref":"#/components/schemas/RecordedPaymentMethod"},"depositedCheck":{"$ref":"#/components/schemas/CheckPaymentMethod"},"recordedCreditCard":{"$ref":"#/components/schemas/RecordedPaymentMethod"},"importedUnspecified":{"$ref":"#/components/schemas/ImportedUnspecified"},"importedUnsupported":{"$ref":"#/components/schemas/ImportedUnsupported"},"ipAddress":{"type":"string"},"data":{"type":"string"},"givenOn":{"type":"string"},"notes":{"type":"string"},"sourceReference":{"type":"string"},"externalLinks":{"type":"array","items":{"$ref":"#/components/schemas/ExternalLink"}},"fund":{"$ref":"#/components/schemas/FundDetails"},"campus":{"$ref":"#/components/schemas/CampusDetails"},"_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"SettlementDetails":{"required":["estimatedDepositDate","key","name"],"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"estimatedDepositDate":{"type":"object","properties":{}}}},"Link":{"required":["href","isTemplated","rel","title"],"type":"object","properties":{"rel":{"type":"string"},"href":{"type":"string"},"title":{"type":"string"},"isTemplated":{"type":"boolean"}}},"PaymentsRepresentation":{"required":["_links","items","page","pageSize"],"type":"object","properties":{"page":{"type":"integer"},"pageSize":{"type":"integer"},"total":{"type":"integer"},"totalPages":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/PaymentRepresentation"}},"_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}}}},"x-original-swagger-version":"2.0"}