# info.description
The **Payment Request Service API** is used for payments, payment requests, and invoices in Rehive.
                    

# paths./admin/company_payment_processors/.get.parameters[].description
A page number within the paginated result set.

# paths./admin/company_payment_processors/{identifier}/.patch.summary
Partially update company payment processor

# paths./admin/payment_processor_quote/.get.parameters[].description
A page number within the paginated result set.

# paths./admin/payment_processors/.get.parameters[].description
A page number within the paginated result set.

# paths./admin/requests/.get.parameters[].description
A page number within the paginated result set.

# paths./admin/requests/{identifier}/logs/.get.parameters[].description
A page number within the paginated result set.

# paths./admin/requests/{identifier}/payment-process-quotes/.get.parameters[].description
A page number within the paginated result set.

# paths./admin/requests/{identifier}/payment-process-quotes/{quote_ident.get.summary
Retrieve request payment processor quote

# paths./admin/requests/{identifier}/payment-process-quotes/{quote_ident.get.summary
Retrieve request payment processor quote conversion

# paths./admin/requests/{identifier}/refunds/.get.parameters[].description
A page number within the paginated result set.

# paths./admin/requests/{identifier}/transactions/.get.parameters[].description
A page number within the paginated result set.

# paths./admin/users/.get.parameters[].description
A page number within the paginated result set.

# paths./admin/webhooks/.get.parameters[].description
A page number within the paginated result set.

# paths./requests/{identifier}/payment_processors/.get.parameters[].description
A page number within the paginated result set.

# paths./requests/{identifier}/transactions/.get.parameters[].description
A page number within the paginated result set.

# paths./user/payment_processors/.get.parameters[].description
A page number within the paginated result set.

# paths./user/requests/.get.parameters[].description
A page number within the paginated result set.

# paths./user/requests/{identifier}/refunds/.get.parameters[].description
A page number within the paginated result set.

# paths./user/requests/{identifier}/transactions/.get.parameters[].description
A page number within the paginated result set.

# paths./user/webhooks/.get.parameters[].description
A page number within the paginated result set.

# components.schemas.ActionResponse.description
This serializer can be used if only a `status` is required in the response.

# components.schemas.Activate.description
Serialize the activation data, should be a token that represents an admin
user.

# components.schemas.AdminCompanyPaymentProcessor.description
Serialize Company Payment Processors, view, create and update.

# components.schemas.AdminPaymentProcessor.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.AdminPaymentProcessor.properties.type.description
* `wallet` - Wallet
* `crypto` - Crypto
* `credit_card` - Credit Card
* `redirect` - Redirect
* `custom` - Custom

# components.schemas.AdminRefund.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.AdminRefund.properties.status.description
* `pending` - Pending
* `processing` - Processing
* `complete` - Complete
* `failed` - Failed

# components.schemas.AdminRequestCreateUpdate.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.AdminRequestCreateUpdate.properties.status.description
* `draft` - Draft
* `initiated` - Initiated
* `processing` - Processing
* `paid` - Paid
* `complete` - Complete
* `failed` - Failed
* `overpaid` - Overpaid
* `cancelled` - Cancelled
* `expired` - Expired
* `late` - Late
* `underpaid` - Underpaid

# components.schemas.AdminUser.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.AdminWebhook.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.AvailablePaymentProcessor.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.AvailablePaymentProcessor.properties.type.description
* `wallet` - Wallet
* `crypto` - Crypto
* `credit_card` - Credit Card
* `redirect` - Redirect
* `custom` - Custom

# components.schemas.CompanyPaymentProcessor.description
Serialize Company Payment Processor, view, create and update.

# components.schemas.ConversionQuote.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.ConversionQuote.properties.status.description
* `quoted` - Quoted
* `pending` - Pending
* `complete` - Complete
* `failed` - Failed
* `cancelled` - Cancelled

# components.schemas.CreateRefund.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.CreateRefund.properties.status.description
* `pending` - Pending
* `processing` - Processing
* `complete` - Complete
* `failed` - Failed

# components.schemas.Currency.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.Deactivate.description
Serialize the deactivation data, should be a token that represents an admin
user.

# components.schemas.PatchedAdminCompanyPaymentProcessor.description
Serialize Company Payment Processors, view, create and update.

# components.schemas.PatchedAdminPaymentProcessor.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.PatchedAdminPaymentProcessor.properties.type.description
* `wallet` - Wallet
* `crypto` - Crypto
* `credit_card` - Credit Card
* `redirect` - Redirect
* `custom` - Custom

# components.schemas.PatchedAdminRequestCreateUpdate.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.PatchedAdminRequestCreateUpdate.properties.status.description
* `draft` - Draft
* `initiated` - Initiated
* `processing` - Processing
* `paid` - Paid
* `complete` - Complete
* `failed` - Failed
* `overpaid` - Overpaid
* `cancelled` - Cancelled
* `expired` - Expired
* `late` - Late
* `underpaid` - Underpaid

# components.schemas.PatchedAdminUser.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.PatchedAdminWebhook.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.PatchedPublicRequestUpdate.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.PatchedPublicRequestUpdate.properties.status.description
* `draft` - Draft
* `initiated` - Initiated
* `processing` - Processing
* `paid` - Paid
* `complete` - Complete
* `failed` - Failed
* `overpaid` - Overpaid
* `cancelled` - Cancelled
* `expired` - Expired
* `late` - Late
* `underpaid` - Underpaid

# components.schemas.PatchedRequestCreateUpdate.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.PatchedRequestCreateUpdate.properties.status.description
* `draft` - Draft
* `initiated` - Initiated
* `processing` - Processing
* `paid` - Paid
* `complete` - Complete
* `failed` - Failed
* `overpaid` - Overpaid
* `cancelled` - Cancelled
* `expired` - Expired
* `late` - Late
* `underpaid` - Underpaid

# components.schemas.PatchedUserCRUDCompanyPaymentProcessor.description
Serialize Company Payment Processors, view, create and update.

# components.schemas.PatchedWebhook.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.PaymentProcessor.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.PaymentProcessor.properties.type.description
* `wallet` - Wallet
* `crypto` - Crypto
* `credit_card` - Credit Card
* `redirect` - Redirect
* `custom` - Custom

# components.schemas.PaymentProcessorQuote.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.PaymentProcessorQuote.properties.status.description
* `pending` - Pending
* `processing` - Processing
* `overpaid` - Overpaid
* `paid` - Paid
* `failed` - Failed
* `expired` - Expired
* `late` - Late
* `underpaid` - Underpaid

# components.schemas.PublicRequest.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.PublicRequest.properties.status.description
* `draft` - Draft
* `initiated` - Initiated
* `processing` - Processing
* `paid` - Paid
* `complete` - Complete
* `failed` - Failed
* `overpaid` - Overpaid
* `cancelled` - Cancelled
* `expired` - Expired
* `late` - Late
* `underpaid` - Underpaid

# components.schemas.Refund.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.Refund.properties.status.description
* `pending` - Pending
* `processing` - Processing
* `complete` - Complete
* `failed` - Failed

# components.schemas.RehiveWebhook.properties.event.description
* `currency.create` - currency.create
* `currency.update` - currency.update
* `transaction.initiate` - transaction.initiate
* `transaction.execute` - transaction.execute
* `user.create` - user.create
* `user.update` - user.update

# components.schemas.Request.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.Request.properties.status.description
* `draft` - Draft
* `initiated` - Initiated
* `processing` - Processing
* `paid` - Paid
* `complete` - Complete
* `failed` - Failed
* `overpaid` - Overpaid
* `cancelled` - Cancelled
* `expired` - Expired
* `late` - Late
* `underpaid` - Underpaid

# components.schemas.RequestCreateUpdate.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.RequestCreateUpdate.properties.status.description
* `draft` - Draft
* `initiated` - Initiated
* `processing` - Processing
* `paid` - Paid
* `complete` - Complete
* `failed` - Failed
* `overpaid` - Overpaid
* `cancelled` - Cancelled
* `expired` - Expired
* `late` - Late
* `underpaid` - Underpaid

# components.schemas.RequestLogs.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.RequestTransaction.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.RequestTransaction.properties.status.description
* `pending` - Pending
* `pending_settled` - Pending Settled
* `settled` - Settled
* `complete` - Complete
* `failed` - Failed

# components.schemas.User.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.schemas.UserCRUDCompanyPaymentProcessor.description
Serialize Company Payment Processors, view, create and update.

# components.schemas.UserCompanyPaymentProcessor.description
Serialize Company Payment Processors, view, create and update.

# components.schemas.Webhook.description
A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

# components.securitySchemes.apiAuth.description
Token-based HTTP Authentication scheme.
Include an API token in the `Authorization` header using the format: `Token <your-api-key>`.