# Payouts
## ***Coming Soon\****
####
## Payouts
> Retrieve a list of Payouts with optional filtering and pagination.
```json
{"openapi":"3.0.3","info":{"title":"Aquanow CAMS REST API","version":"1.0"},"servers":[{"url":"https://cams.aquanow.com/api","description":"production"},{"url":"http://localhost:3001/api","description":"local"},{"url":"https://cams.dev.aquanow.com/api","description":"dev"},{"url":"https://cams.staging.aquanow.com/api","description":"staging"},{"url":"https://cams.cert.aquanow.com/api","description":"cert"},{"url":"https://marketdata.aquanow.com","description":"production market data"},{"url":"https://marketdata.staging.aquanow.com","description":"staging market data"},{"url":"https://marketdata.dev.aquanow.com","description":"dev market data"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer"}},"schemas":{"PayoutStatus":{"type":"string","enum":["PENDING_AUTHORIZATION","PROCESSING","COMPLETED","FAILED"]},"PayoutsAuthorize":{"allOf":[{"$ref":"#/components/schemas/Payouts"},{"type":"object","properties":{"status":{"type":"string"},"authorizedAt":{"type":"string","format":"date-time"}}}]},"Payouts":{"type":"object","required":["payoutId","beneficiaryAddressId","sourceCurrency","sourceAccountId","beneficiaryCurrency","conversionRate","sourceQuantity","beneficiaryQuantity","feeCurrency","payoutFeeRate","payoutFeeQuantity","netBeneficiaryQuantity","memo","feePaidBy","paymentReason","status","requestedAt","expiresAt"],"properties":{"payoutId":{"type":"string","format":"uuid"},"beneficiaryAddressId":{"type":"string","format":"uuid"},"beneficiaryId":{"type":"string","format":"uuid"},"sourceAccountId":{"type":"string","format":"uuid"},"sourceQuantity":{"type":"string","format":"number"},"beneficiaryQuantity":{"type":"string","format":"number"},"payoutFeeQuantity":{"type":"string","format":"number"},"netBeneficiaryQuantity":{"type":"string","format":"number"},"sourceCurrency":{"type":"string"},"feeCurrency":{"type":"string"},"beneficiaryCurrency":{"type":"string"},"memo":{"type":"string","nullable":true},"feePaidBy":{"$ref":"#/components/schemas/FeePaidBy"},"status":{"$ref":"#/components/schemas/PayoutStatus"},"payoutFeeRate":{"type":"string","format":"number"},"clientReference":{"type":"string","description":"An optional freeform text field that clients can use to add additional notes or references to their order for internal tracking purposes.","nullable":true},"conversionRate":{"type":"string","format":"number"},"paymentReason":{"type":"string"},"requestedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}}},"FeePaidBy":{"type":"string","enum":["MERCHANT"]}},"responses":{"400":{"description":"Validation Error"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient Privileges"},"4XX":{"description":"Client error"},"5XX":{"description":"Server error"}}},"paths":{"/v1/payouts":{"get":{"summary":"Payouts","description":"Retrieve a list of Payouts with optional filtering and pagination.","tags":["Payouts"],"parameters":[{"name":"after","in":"query","required":false,"schema":{"type":"string"},"description":"When provided, specifies the last item returned in previous page, used to fetch the next page. Fetches the first page when omitted."},{"name":"limit","in":"query","required":false,"schema":{"type":"string","format":"integer"},"description":"When provided, specifies the number of items to return in the page. Uses default page size of 10 when omitted."},{"name":"payoutId","in":"query","schema":{"type":"string","format":"uuid"},"description":"Filter by transfer ID"},{"name":"beneficiaryId","in":"query","schema":{"type":"string","format":"uuid"},"description":"Filter by destination customer ID"},{"name":"beneficiaryCurrency","in":"query","schema":{"type":"string"},"description":"Filter by beneficiary currency"},{"name":"sourceCurrency","in":"query","schema":{"type":"string"},"description":"Filter by source currency"},{"name":"status","in":"query","schema":{"$ref":"#/components/schemas/PayoutStatus"},"description":"Filter by status"},{"name":"requestedAt","in":"query","schema":{"type":"string","format":"date-time"},"description":"Filter by request date lower bound, exclusive"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"after":{"type":"string","description":"The token of the last item in the response","nullable":true},"totalCount":{"type":"string","format":"integer","description":"The total number of items in the entire filtered data set"},"items":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsAuthorize"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"4XX":{"$ref":"#/components/responses/4XX"},"5XX":{"$ref":"#/components/responses/5XX"}},"operationId":"ListTransfers"}}}}
```
## Get payout
> Retrieve a payout by its ID.
```json
{"openapi":"3.0.3","info":{"title":"Aquanow CAMS REST API","version":"1.0"},"servers":[{"url":"https://cams.aquanow.com/api","description":"production"},{"url":"http://localhost:3001/api","description":"local"},{"url":"https://cams.dev.aquanow.com/api","description":"dev"},{"url":"https://cams.staging.aquanow.com/api","description":"staging"},{"url":"https://cams.cert.aquanow.com/api","description":"cert"},{"url":"https://marketdata.aquanow.com","description":"production market data"},{"url":"https://marketdata.staging.aquanow.com","description":"staging market data"},{"url":"https://marketdata.dev.aquanow.com","description":"dev market data"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer"}},"schemas":{"PayoutsAuthorize":{"allOf":[{"$ref":"#/components/schemas/Payouts"},{"type":"object","properties":{"status":{"type":"string"},"authorizedAt":{"type":"string","format":"date-time"}}}]},"Payouts":{"type":"object","required":["payoutId","beneficiaryAddressId","sourceCurrency","sourceAccountId","beneficiaryCurrency","conversionRate","sourceQuantity","beneficiaryQuantity","feeCurrency","payoutFeeRate","payoutFeeQuantity","netBeneficiaryQuantity","memo","feePaidBy","paymentReason","status","requestedAt","expiresAt"],"properties":{"payoutId":{"type":"string","format":"uuid"},"beneficiaryAddressId":{"type":"string","format":"uuid"},"beneficiaryId":{"type":"string","format":"uuid"},"sourceAccountId":{"type":"string","format":"uuid"},"sourceQuantity":{"type":"string","format":"number"},"beneficiaryQuantity":{"type":"string","format":"number"},"payoutFeeQuantity":{"type":"string","format":"number"},"netBeneficiaryQuantity":{"type":"string","format":"number"},"sourceCurrency":{"type":"string"},"feeCurrency":{"type":"string"},"beneficiaryCurrency":{"type":"string"},"memo":{"type":"string","nullable":true},"feePaidBy":{"$ref":"#/components/schemas/FeePaidBy"},"status":{"$ref":"#/components/schemas/PayoutStatus"},"payoutFeeRate":{"type":"string","format":"number"},"clientReference":{"type":"string","description":"An optional freeform text field that clients can use to add additional notes or references to their order for internal tracking purposes.","nullable":true},"conversionRate":{"type":"string","format":"number"},"paymentReason":{"type":"string"},"requestedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}}},"FeePaidBy":{"type":"string","enum":["MERCHANT"]},"PayoutStatus":{"type":"string","enum":["PENDING_AUTHORIZATION","PROCESSING","COMPLETED","FAILED"]}},"responses":{"400":{"description":"Validation Error"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient Privileges"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"properties":{"id":{"type":"string"}}}}}},"4XX":{"description":"Client error"},"5XX":{"description":"Server error"}}},"paths":{"/v1/payouts/{payoutId}":{"get":{"summary":"Get payout","description":"Retrieve a payout by its ID.","tags":["Payouts"],"parameters":[{"name":"payoutId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"The payout ID"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutsAuthorize"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"4XX":{"$ref":"#/components/responses/4XX"},"5XX":{"$ref":"#/components/responses/5XX"}},"operationId":"GetPayoutById"}}}}
```
## Create Payout
> Request a payout for an specified account
```json
{"openapi":"3.0.3","info":{"title":"Aquanow CAMS REST API","version":"1.0"},"servers":[{"url":"https://cams.aquanow.com/api","description":"production"},{"url":"http://localhost:3001/api","description":"local"},{"url":"https://cams.dev.aquanow.com/api","description":"dev"},{"url":"https://cams.staging.aquanow.com/api","description":"staging"},{"url":"https://cams.cert.aquanow.com/api","description":"cert"},{"url":"https://marketdata.aquanow.com","description":"production market data"},{"url":"https://marketdata.staging.aquanow.com","description":"staging market data"},{"url":"https://marketdata.dev.aquanow.com","description":"dev market data"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer"}},"schemas":{"PayoutInput":{"type":"object","required":["sourceCurrency","sourceAccountId","sourceQuantity","beneficiaryCurrency","beneficiaryAddressId","feePaidBy","paymentReason"],"properties":{"sourceAccountId":{"type":"string","maxLength":256},"beneficiaryAddressId":{"type":"string","maxLength":256,"description":"Previously whitelisted cryptoAddressId on the following API https://docs.aquanow.io/cams/api-reference/customers/crypto-addresses"},"beneficiaryId":{"type":"string","format":"uuid"},"sourceQuantity":{"type":"string","format":"number"},"sourceCurrency":{"type":"string"},"beneficiaryCurrency":{"type":"string"},"paymentReason":{"type":"string","description":"Payment Reason"},"feePaidBy":{"$ref":"#/components/schemas/FeePaidBy"},"clientReference":{"type":"string","description":"An optional freeform text field that clients can use to add additional notes or references to their order for internal tracking purposes.","nullable":true}}},"FeePaidBy":{"type":"string","enum":["MERCHANT"]},"Payouts":{"type":"object","required":["payoutId","beneficiaryAddressId","sourceCurrency","sourceAccountId","beneficiaryCurrency","conversionRate","sourceQuantity","beneficiaryQuantity","feeCurrency","payoutFeeRate","payoutFeeQuantity","netBeneficiaryQuantity","memo","feePaidBy","paymentReason","status","requestedAt","expiresAt"],"properties":{"payoutId":{"type":"string","format":"uuid"},"beneficiaryAddressId":{"type":"string","format":"uuid"},"beneficiaryId":{"type":"string","format":"uuid"},"sourceAccountId":{"type":"string","format":"uuid"},"sourceQuantity":{"type":"string","format":"number"},"beneficiaryQuantity":{"type":"string","format":"number"},"payoutFeeQuantity":{"type":"string","format":"number"},"netBeneficiaryQuantity":{"type":"string","format":"number"},"sourceCurrency":{"type":"string"},"feeCurrency":{"type":"string"},"beneficiaryCurrency":{"type":"string"},"memo":{"type":"string","nullable":true},"feePaidBy":{"$ref":"#/components/schemas/FeePaidBy"},"status":{"$ref":"#/components/schemas/PayoutStatus"},"payoutFeeRate":{"type":"string","format":"number"},"clientReference":{"type":"string","description":"An optional freeform text field that clients can use to add additional notes or references to their order for internal tracking purposes.","nullable":true},"conversionRate":{"type":"string","format":"number"},"paymentReason":{"type":"string"},"requestedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}}},"PayoutStatus":{"type":"string","enum":["PENDING_AUTHORIZATION","PROCESSING","COMPLETED","FAILED"]}},"responses":{"400":{"description":"Validation Error"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient Privileges"},"4XX":{"description":"Client error"},"5XX":{"description":"Server error"}}},"paths":{"/v1/payouts":{"post":{"summary":"Create Payout","description":"Request a payout for an specified account","tags":["Payouts"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutInput"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"4XX":{"$ref":"#/components/responses/4XX"},"5XX":{"$ref":"#/components/responses/5XX"}},"operationId":"CreatePayout"}}}}
```
## Authorize a previously created payout
> For a payout to be accepted, the account must have sufficient buying power.
```json
{"openapi":"3.0.3","info":{"title":"Aquanow CAMS REST API","version":"1.0"},"servers":[{"url":"https://cams.aquanow.com/api","description":"production"},{"url":"http://localhost:3001/api","description":"local"},{"url":"https://cams.dev.aquanow.com/api","description":"dev"},{"url":"https://cams.staging.aquanow.com/api","description":"staging"},{"url":"https://cams.cert.aquanow.com/api","description":"cert"},{"url":"https://marketdata.aquanow.com","description":"production market data"},{"url":"https://marketdata.staging.aquanow.com","description":"staging market data"},{"url":"https://marketdata.dev.aquanow.com","description":"dev market data"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer"}},"parameters":{"X-Request-Id":{"name":"X-Request-Id","in":"header","required":false,"schema":{"type":"string"},"description":"A client-supplied unique identifier for this request, used for safely retrying and deduplicating operations. When the same X-Request-Id is sent with multiple identical requests within a defined time window, the server treats them as the same logical operation and will not perform the side effect more than once. Instead, it will return the original result associated with that identifier, if available. The client should generate a collision-resistant value (for example, a UUID) and reuse it only when retrying the same operation."}},"schemas":{"PayoutsAuthorize":{"allOf":[{"$ref":"#/components/schemas/Payouts"},{"type":"object","properties":{"status":{"type":"string"},"authorizedAt":{"type":"string","format":"date-time"}}}]},"Payouts":{"type":"object","required":["payoutId","beneficiaryAddressId","sourceCurrency","sourceAccountId","beneficiaryCurrency","conversionRate","sourceQuantity","beneficiaryQuantity","feeCurrency","payoutFeeRate","payoutFeeQuantity","netBeneficiaryQuantity","memo","feePaidBy","paymentReason","status","requestedAt","expiresAt"],"properties":{"payoutId":{"type":"string","format":"uuid"},"beneficiaryAddressId":{"type":"string","format":"uuid"},"beneficiaryId":{"type":"string","format":"uuid"},"sourceAccountId":{"type":"string","format":"uuid"},"sourceQuantity":{"type":"string","format":"number"},"beneficiaryQuantity":{"type":"string","format":"number"},"payoutFeeQuantity":{"type":"string","format":"number"},"netBeneficiaryQuantity":{"type":"string","format":"number"},"sourceCurrency":{"type":"string"},"feeCurrency":{"type":"string"},"beneficiaryCurrency":{"type":"string"},"memo":{"type":"string","nullable":true},"feePaidBy":{"$ref":"#/components/schemas/FeePaidBy"},"status":{"$ref":"#/components/schemas/PayoutStatus"},"payoutFeeRate":{"type":"string","format":"number"},"clientReference":{"type":"string","description":"An optional freeform text field that clients can use to add additional notes or references to their order for internal tracking purposes.","nullable":true},"conversionRate":{"type":"string","format":"number"},"paymentReason":{"type":"string"},"requestedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}}},"FeePaidBy":{"type":"string","enum":["MERCHANT"]},"PayoutStatus":{"type":"string","enum":["PENDING_AUTHORIZATION","PROCESSING","COMPLETED","FAILED"]}},"responses":{"400":{"description":"Validation Error"},"401":{"description":"Unauthorized"},"403":{"description":"Insufficient Privileges"},"4XX":{"description":"Client error"},"5XX":{"description":"Server error"}}},"paths":{"/v1/payouts/authorize":{"patch":{"summary":"Authorize a previously created payout","description":"For a payout to be accepted, the account must have sufficient buying power.","tags":["Payouts"],"parameters":[{"$ref":"#/components/parameters/X-Request-Id"}],"requestBody":{"content":{"application/json":{"schema":{"description":"Execute a previously requested payout.","required":["payoutId"],"properties":{"payoutId":{"type":"string","format":"uuid","description":"The payoutId returned by request payout"}}},"type":"object"}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutsAuthorize"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"4XX":{"$ref":"#/components/responses/4XX"},"5XX":{"$ref":"#/components/responses/5XX"}}}}}}
```