{"openapi":"3.0.1","info":{"title":"settlements","version":"1.2.0.2345"},"servers":[{"url":"https://api.pushpay.com/"}],"paths":{"/v1/settlement/{settlementKey}/payments":{"get":{"tags":["settlements"],"summary":"Retrieve all visible payments from a settlement","description":"Retrieve the set of in scope payments related to the specified settlement","operationId":"getSettlementPayments","parameters":[{"name":"settlementKey","in":"path","required":true,"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/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/organization/{organizationKey}/settlements":{"get":{"tags":["settlements"],"summary":"Retrieve all settlements that belong to an organization","description":"Retrieves all settlements that belong to an organization & which pass the specified filters","operationId":"getOrganizationSettlements","parameters":[{"name":"organizationKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order data by a particular property in ascending or descending order. Uses format 'PropertyName ASC' or 'PropertyName DESC'.  Valid columns are 'name', 'depositDate', and 'transactions'","schema":{"type":"string"}},{"name":"isReconciled","in":"query","description":"Only include settlements which have or have not been reconciled by the user","schema":{"type":"boolean"}},{"name":"name","in":"query","description":"Only include settlements which contain the following substring, wildcharacters implicitly prepended and appended","schema":{"type":"string"}},{"name":"type","in":"query","description":"Only include settlements which are of the specified type (ACH, CreditCard, DepositedCheck or CashAndRecorded)","schema":{"type":"string","enum":["ACH","CashAndRecorded","CreditCard","DepositedCheck"]}},{"name":"depositFrom","in":"query","description":"Only include settlements which have been deposited after the specified date (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"depositTo","in":"query","description":"Only include settlements which have been deposited before the specified date (UTC)","schema":{"type":"string","format":"date-time"}},{"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/SettlementsRepresentation"}}}},"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/merchant/{merchantKey}/settlements":{"get":{"tags":["settlements"],"summary":"Retrieve all settlements that belong to a merchant","description":"Retrieves all settlements that belong to the in scope merchant & which pass the specified filters","operationId":"getMerchantSettlements","parameters":[{"name":"merchantKey","in":"path","description":"The unique key of the merchant - a case-sensitive series of characters","required":true,"schema":{"type":"string"}},{"name":"orderBy","in":"query","description":"Order data by a particular property in ascending or descending order. Uses format 'PropertyName ASC' or 'PropertyName DESC'.  Valid columns are 'name', 'depositDate', and 'transactions'","schema":{"type":"string"}},{"name":"isReconciled","in":"query","description":"Only include settlements which have or have not been reconciled by the user","schema":{"type":"boolean"}},{"name":"name","in":"query","description":"Only include settlements which contain the following substring, wildcharacters implicitly prepended and appended","schema":{"type":"string"}},{"name":"type","in":"query","description":"Only include settlements which are of the specified type (ACH, CreditCard, DepositedCheck or CashAndRecorded)","schema":{"type":"string","enum":["ACH","CashAndRecorded","CreditCard","DepositedCheck"]}},{"name":"depositFrom","in":"query","description":"Only include settlements which have been deposited after the specified date (UTC)","schema":{"type":"string","format":"date-time"}},{"name":"depositTo","in":"query","description":"Only include settlements which have been deposited before the specified date (UTC)","schema":{"type":"string","format":"date-time"}},{"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/SettlementsRepresentation"}}}},"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/settlement/{settlementKey}":{"get":{"tags":["settlements"],"summary":"Retrieve a single settlement by key","description":"Retrieve a single in scope settlement by its key","operationId":"getSettlement","parameters":[{"name":"settlementKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/SettlementRepresentation"}}}},"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"]}]}}},"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":{"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"}}},"SettlementRepresentation":{"required":["_links","estimatedDepositDate","isReconciled","key","name","totalAmount","totalPayments","type"],"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"totalAmount":{"$ref":"#/components/schemas/Money"},"type":{"type":"string","enum":["ACH","CashAndRecorded","CreditCard","DepositedCheck"]},"totalPayments":{"type":"integer"},"estimatedDepositDate":{"type":"object","properties":{}},"isReconciled":{"type":"boolean"},"_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"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"}}},"FundDetails":{"required":["code","key","name","taxDeductible"],"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"code":{"type":"string"},"taxDeductible":{"type":"boolean"}}},"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"}}},"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"},"MerchantDetails":{"required":["role"],"type":"object","properties":{"key":{"type":"string"},"handle":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"}}},"SettlementsRepresentation":{"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/SettlementRepresentation"}},"_links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}},"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"}