payment-requests.services.rehive.io
Open in
urlscan Pro
2606:4700:10::ac43:2857
Public Scan
URL:
https://payment-requests.services.rehive.io/
Submission: On August 27 via automatic, source certstream-suspicious — Scanned from DE
Submission: On August 27 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
* activate
* postActivate service
* admin
* getRetrieve company
* putUpdate company
* patchPartially update company
* getRetrieve configuration
* putUpdate configuration
* patchPartially update configuration
* getList company payment processors
* postCreate company payment processor
* getRetrieve company payment processor
* putUpdate company payment processor
* patchPartially update company payment processor
* delDelete company payment processor
* getList payment processor quotes
* getList payment processors
* postCreate payment processor
* getRetrieve payment processor
* putUpdate payment processor
* patchPartially update payment processor
* delDelete payment processor
* getList requests
* postCreate request
* getRetrieve request
* putUpdate request
* patchPartially update request
* getList request logs
* getList request payment processor quotes
* getRetrieve request payment processor quote
* getRetrieve request payment processor quote conversion
* getList request refunds
* postCreate request refund
* getList request transactions
* getList users
* getRetrieve user
* putUpdate user
* patchPartially update user
* getList webhooks
* postCreate webhook
* getRetrieve webhook
* putUpdate webhook
* patchPartially update webhook
* delDelete webhook
* deactivate
* postDeactivate service
* requests
* getRetrieve request
* putUpdate request
* patchPartially update request
* postCreate OTP challenge
* getList request payment processors
* postResend OTP challenge
* getList request transactions
* user
* getList payment processors
* postCreate payment processor
* getRetrieve payment processor
* putUpdate payment processor
* patchPartially update payment processor
* delDelete payment processor
* getList request
* postCreate request
* getRetrieve request
* putUpdate request
* patchPartially update request
* postSend notification
* getList request refunds
* postCreate request refund
* getList request transactions
* getList webhooks
* postCreate webhook
* getRetrieve webhook
* putUpdate webhook
* patchPartially webhook
* delDelete webhook
* webhook
* postReceive Platform webhook
* webhooks
* postReceive Platform webhook
* postReceive Platform webhook
* postReceive Platform webhook
* postReceive Platform webhook
* postReceive Platform webhook
API docs by Redocly
PAYMENT REQUEST SERVICE API (1 (1))
Download OpenAPI specification:Download
Rehive Support: support@rehive.com URL: https://rehive.com/support/ Terms of
Service
The Payment Request Service API is used for payments, payment requests, and
invoices in Rehive.
Docs portal
ACTIVATE
ACTIVATE SERVICE
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
token
required
string
RESPONSES
200
post/activate/
https://payment-requests.services.rehive.com/api/activate/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "token": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
ADMIN
RETRIEVE COMPANY
AUTHORIZATIONS:
apiAuth
RESPONSES
200
get/admin/company/
https://payment-requests.services.rehive.com/api/admin/company/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
* "name": "string",
* "reminder_intervals": [
* 0
]
}
}
UPDATE COMPANY
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
required
string
reminder_intervals
Array of integers
RESPONSES
200
put/admin/company/
https://payment-requests.services.rehive.com/api/admin/company/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "reminder_intervals": [
* 0
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
* "name": "string",
* "reminder_intervals": [
* 0
]
}
}
PARTIALLY UPDATE COMPANY
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
name
string
reminder_intervals
Array of integers
RESPONSES
200
patch/admin/company/
https://payment-requests.services.rehive.com/api/admin/company/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "name": "string",
* "reminder_intervals": [
* 0
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "9600ee5d-1c66-4d31-b2c3-97ef4a25d053",
* "name": "string",
* "reminder_intervals": [
* 0
]
}
}
RETRIEVE CONFIGURATION
AUTHORIZATIONS:
apiAuth
RESPONSES
200
get/admin/company/configuration/
https://payment-requests.services.rehive.com/api/admin/company/configuration/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "base_redirect_url": "string",
* "otp_notification_id": "string",
* "request_notification_id": "string",
* "reminder_default": true,
* "request_param_config": "string"
}
}
UPDATE CONFIGURATION
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
base_redirect_url
string or null <= 100 characters
reminder_default
boolean
request_param_config
string or null <= 50 characters
RESPONSES
200
put/admin/company/configuration/
https://payment-requests.services.rehive.com/api/admin/company/configuration/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "base_redirect_url": "string",
* "reminder_default": true,
* "request_param_config": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "base_redirect_url": "string",
* "otp_notification_id": "string",
* "request_notification_id": "string",
* "reminder_default": true,
* "request_param_config": "string"
}
}
PARTIALLY UPDATE CONFIGURATION
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
base_redirect_url
string or null <= 100 characters
reminder_default
boolean
request_param_config
string or null <= 50 characters
RESPONSES
200
patch/admin/company/configuration/
https://payment-requests.services.rehive.com/api/admin/company/configuration/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "base_redirect_url": "string",
* "reminder_default": true,
* "request_param_config": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "base_redirect_url": "string",
* "otp_notification_id": "string",
* "request_notification_id": "string",
* "reminder_default": true,
* "request_param_config": "string"
}
}
LIST COMPANY PAYMENT PROCESSORS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/company_payment_processors/
https://payment-requests.services.rehive.com/api/admin/company_payment_processors/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "active": true,
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currencies": [
* {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
}
]
}
]
}
}
CREATE COMPANY PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
company_base_endpoint
required
string <= 255 characters
company_external_api_key
required
string <= 255 characters
active
boolean
payment_processor
string
currencies
Array of strings <= 100 items
RESPONSES
201
post/admin/company_payment_processors/
https://payment-requests.services.rehive.com/api/admin/company_payment_processors/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "active": true,
* "company_base_endpoint": "string",
* "company_external_api_key": "string",
* "payment_processor": "string",
* "currencies": [
* "string"
]
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "active": true,
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currencies": [
* {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
}
]
}
}
RETRIEVE COMPANY PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/company_payment_processors/{identifier}/
https://payment-requests.services.rehive.com/api/admin/company_payment_processors/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "active": true,
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currencies": [
* {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
}
]
}
}
UPDATE COMPANY PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
company_base_endpoint
required
string <= 255 characters
company_external_api_key
required
string <= 255 characters
active
boolean
payment_processor
string
currencies
Array of strings <= 100 items
RESPONSES
200
put/admin/company_payment_processors/{identifier}/
https://payment-requests.services.rehive.com/api/admin/company_payment_processors/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "active": true,
* "company_base_endpoint": "string",
* "company_external_api_key": "string",
* "payment_processor": "string",
* "currencies": [
* "string"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "active": true,
* "company_base_endpoint": "string",
* "payment_processor": "string"
}
}
PARTIALLY UPDATE COMPANY PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
active
boolean
company_base_endpoint
string <= 255 characters
company_external_api_key
string <= 255 characters
payment_processor
string
currencies
Array of strings <= 100 items
RESPONSES
200
patch/admin/company_payment_processors/{identifier}/
https://payment-requests.services.rehive.com/api/admin/company_payment_processors/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "active": true,
* "company_base_endpoint": "string",
* "company_external_api_key": "string",
* "payment_processor": "string",
* "currencies": [
* "string"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "active": true,
* "company_base_endpoint": "string",
* "payment_processor": "string"
}
}
DELETE COMPANY PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/company_payment_processors/{identifier}/
https://payment-requests.services.rehive.com/api/admin/company_payment_processors/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "active": true,
* "company_base_endpoint": "string",
* "payment_processor": "string"
}
}
LIST PAYMENT PROCESSOR QUOTES
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/payment_processor_quote/
https://payment-requests.services.rehive.com/api/admin/payment_processor_quote/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
]
}
}
LIST PAYMENT PROCESSORS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/payment_processors/
https://payment-requests.services.rehive.com/api/admin/payment_processors/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
}
]
}
}
CREATE PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
description
required
string <= 255 characters
name
required
string <= 100 characters
type
required
string
Enum: "wallet" "crypto" "credit_card" "redirect" "custom"
* wallet - Wallet
* crypto - Crypto
* credit_card - Credit Card
* redirect - Redirect
* custom - Custom
unique_string_name
required
string <= 100 characters
logo
string or null <= 100 characters
selector_description
string or null <= 255 characters
pending_processing_description
string or null <= 255 characters
processing_description
string or null <= 255 characters
currencies
Array of strings or null or null
longest_expiration_time
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
rehive_transaction_identifier
object or null
rehive_subtype
string or null <= 255 characters
generate_accounts
boolean
RESPONSES
201
post/admin/payment_processors/
https://payment-requests.services.rehive.com/api/admin/payment_processors/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "type": "wallet",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "longest_expiration_time": -9223372036854776000,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "generate_accounts": true
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
}
}
RETRIEVE PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/payment_processors/{identifier}/
https://payment-requests.services.rehive.com/api/admin/payment_processors/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
}
}
UPDATE PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
description
required
string <= 255 characters
name
required
string <= 100 characters
type
required
string
Enum: "wallet" "crypto" "credit_card" "redirect" "custom"
* wallet - Wallet
* crypto - Crypto
* credit_card - Credit Card
* redirect - Redirect
* custom - Custom
unique_string_name
required
string <= 100 characters
logo
string or null <= 100 characters
selector_description
string or null <= 255 characters
pending_processing_description
string or null <= 255 characters
processing_description
string or null <= 255 characters
currencies
Array of strings or null or null
longest_expiration_time
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
rehive_transaction_identifier
object or null
rehive_subtype
string or null <= 255 characters
generate_accounts
boolean
RESPONSES
200
put/admin/payment_processors/{identifier}/
https://payment-requests.services.rehive.com/api/admin/payment_processors/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "type": "wallet",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "longest_expiration_time": -9223372036854776000,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "generate_accounts": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "type": "wallet",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "longest_expiration_time": -9223372036854776000,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "generate_accounts": true
}
}
PARTIALLY UPDATE PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
unique_string_name
string <= 100 characters
logo
string or null <= 100 characters
name
string <= 100 characters
type
string
Enum: "wallet" "crypto" "credit_card" "redirect" "custom"
* wallet - Wallet
* crypto - Crypto
* credit_card - Credit Card
* redirect - Redirect
* custom - Custom
description
string <= 255 characters
selector_description
string or null <= 255 characters
pending_processing_description
string or null <= 255 characters
processing_description
string or null <= 255 characters
currencies
Array of strings or null or null
longest_expiration_time
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
rehive_transaction_identifier
object or null
rehive_subtype
string or null <= 255 characters
generate_accounts
boolean
RESPONSES
200
patch/admin/payment_processors/{identifier}/
https://payment-requests.services.rehive.com/api/admin/payment_processors/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "type": "wallet",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "longest_expiration_time": -9223372036854776000,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "generate_accounts": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "type": "wallet",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "longest_expiration_time": -9223372036854776000,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "generate_accounts": true
}
}
DELETE PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/payment_processors/{identifier}/
https://payment-requests.services.rehive.com/api/admin/payment_processors/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "type": "wallet",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "longest_expiration_time": -9223372036854776000,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "generate_accounts": true
}
}
LIST REQUESTS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
created
string <date-time>
created__gt
string
created__gte
string
created__lt
string
created__lte
string
expiration_date__gt
string
expiration_date__gte
string
expiration_date__lt
string
expiration_date__lte
string
id
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
payer_email
string
payer_mobile_number
string
payment_processor_quote_reference
string
refund_status
string
refunded
string
request_currency
string
request_reference
string
request_type
string
status
string
status__in
string
RESPONSES
200
get/admin/requests/
https://payment-requests.services.rehive.com/api/admin/requests/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_email": "string",
* "payer_mobile_number": "string",
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": -9223372036854776000,
* "primary_payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "redirect_url": "string",
* "payment_processor_quotes": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "amount": -9223372036854776000,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "status": "pending",
* "type": "native",
* "transaction_collection": "string",
* "reason": "string",
* "request": 0,
* "created": 0,
* "updated": 0
}
],
* "return_url": "string",
* "send_request_on": 0,
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "refunded": true,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE REQUEST
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
account
required
string <= 255 characters
request_currency
required
string
user
required
string <uuid>
payer_user
object (User)
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
request_reference
string or null <= 255 characters
request_amount
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
primary_payment_processor
string
description
string or null <= 255 characters
metadata
object or null
status
string
Enum: "draft" "initiated" "processing" "paid" "complete" "failed" "overpaid"
"cancelled" "expired" "late" "underpaid"
* draft - Draft
* initiated - Initiated
* processing - Processing
* paid - Paid
* complete - Complete
* failed - Failed
* overpaid - Overpaid
* cancelled - Cancelled
* expired - Expired
* late - Late
* underpaid - Underpaid
expiration_date
integer
due_date
integer
send_request_on
integer
payer_email
string <email>
send_reminders
boolean
reminder_intervals
Array of integers
note
string or null <= 255 characters
return_url
string or null <= 255 characters
payer_mobile_number
string
payment_processor_quotes
Array of objects (PaymentProcessorQuote)
RESPONSES
201
post/admin/requests/
https://payment-requests.services.rehive.com/api/admin/requests/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "user": "76f62a58-5404-486d-9afc-07bded328704",
* "payer_user": {
* "base_currency": "string"
},
* "request_reference": "string",
* "request_currency": "string",
* "request_amount": -9223372036854776000,
* "primary_payment_processor": "string",
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "payer_email": "user@example.com",
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "return_url": "string",
* "payer_mobile_number": "string",
* "payment_processor_quotes": [
* {
* "payment_processor": {
* "type": "wallet",
* "weight": 0
},
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted"
},
* "created": 0,
* "updated": 0
}
]
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_email": "string",
* "payer_mobile_number": "string",
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": -9223372036854776000,
* "primary_payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "redirect_url": "string",
* "payment_processor_quotes": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "amount": -9223372036854776000,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "status": "pending",
* "type": "native",
* "transaction_collection": "string",
* "reason": "string",
* "request": 0,
* "created": 0,
* "updated": 0
}
],
* "return_url": "string",
* "send_request_on": 0,
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "refunded": true,
* "created": 0,
* "updated": 0
}
}
RETRIEVE REQUEST
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/requests/{identifier}/
https://payment-requests.services.rehive.com/api/admin/requests/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_email": "string",
* "payer_mobile_number": "string",
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": -9223372036854776000,
* "primary_payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "redirect_url": "string",
* "payment_processor_quotes": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "amount": -9223372036854776000,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "status": "pending",
* "type": "native",
* "transaction_collection": "string",
* "reason": "string",
* "request": 0,
* "created": 0,
* "updated": 0
}
],
* "return_url": "string",
* "send_request_on": 0,
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "refunded": true,
* "created": 0,
* "updated": 0
}
}
UPDATE REQUEST
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
account
required
string <= 255 characters
status
required
string
Enum: "draft" "initiated" "processing" "paid" "complete" "failed" "overpaid"
"cancelled" "expired" "late" "underpaid"
* draft - Draft
* initiated - Initiated
* processing - Processing
* paid - Paid
* complete - Complete
* failed - Failed
* overpaid - Overpaid
* cancelled - Cancelled
* expired - Expired
* late - Late
* underpaid - Underpaid
user
object (User)
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
payer_user
object (User)
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
request_reference
string or null <= 255 characters
request_amount
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
primary_payment_processor
object (PaymentProcessor)
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
description
string or null <= 255 characters
metadata
object or null
expiration_date
integer
due_date
integer
payment_processor_quotes
Array of objects (PaymentProcessorQuote)
refunds
Array of objects (Refund)
return_url
string or null <= 255 characters
send_request_on
integer
send_reminders
boolean
reminder_intervals
Array of integers
note
string or null <= 255 characters
created
integer
updated
integer
RESPONSES
200
put/admin/requests/{identifier}/
https://payment-requests.services.rehive.com/api/admin/requests/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "user": {
* "base_currency": "string"
},
* "payer_user": {
* "base_currency": "string"
},
* "request_reference": "string",
* "request_amount": -9223372036854776000,
* "primary_payment_processor": {
* "type": "wallet",
* "weight": 0
},
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "payment_processor_quotes": [
* {
* "payment_processor": {
* "type": "wallet",
* "weight": 0
},
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted"
},
* "created": 0,
* "updated": 0
}
],
* "refunds": [
* {
* "amount": -9223372036854776000,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "reason": "string",
* "created": 0,
* "updated": 0
}
],
* "return_url": "string",
* "send_request_on": 0,
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "created": 0,
* "updated": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_email": "string",
* "payer_mobile_number": "string",
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": -9223372036854776000,
* "primary_payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "redirect_url": "string",
* "payment_processor_quotes": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "amount": -9223372036854776000,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "status": "pending",
* "type": "native",
* "transaction_collection": "string",
* "reason": "string",
* "request": 0,
* "created": 0,
* "updated": 0
}
],
* "return_url": "string",
* "send_request_on": 0,
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "refunded": true,
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE REQUEST
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
user
string <uuid>
payer_user
object (User)
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
request_reference
string or null <= 255 characters
request_currency
string
request_amount
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
primary_payment_processor
string
description
string or null <= 255 characters
metadata
object or null
status
string
Enum: "draft" "initiated" "processing" "paid" "complete" "failed" "overpaid"
"cancelled" "expired" "late" "underpaid"
* draft - Draft
* initiated - Initiated
* processing - Processing
* paid - Paid
* complete - Complete
* failed - Failed
* overpaid - Overpaid
* cancelled - Cancelled
* expired - Expired
* late - Late
* underpaid - Underpaid
expiration_date
integer
due_date
integer
send_request_on
integer
payer_email
string <email>
account
string <= 255 characters
send_reminders
boolean
reminder_intervals
Array of integers
note
string or null <= 255 characters
return_url
string or null <= 255 characters
payer_mobile_number
string
payment_processor_quotes
Array of objects (PaymentProcessorQuote)
RESPONSES
200
patch/admin/requests/{identifier}/
https://payment-requests.services.rehive.com/api/admin/requests/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "user": "76f62a58-5404-486d-9afc-07bded328704",
* "payer_user": {
* "base_currency": "string"
},
* "request_reference": "string",
* "request_currency": "string",
* "request_amount": -9223372036854776000,
* "primary_payment_processor": "string",
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "payer_email": "user@example.com",
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "return_url": "string",
* "payer_mobile_number": "string",
* "payment_processor_quotes": [
* {
* "payment_processor": {
* "type": "wallet",
* "weight": 0
},
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted"
},
* "created": 0,
* "updated": 0
}
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": "76f62a58-5404-486d-9afc-07bded328704",
* "payer_user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "request_reference": "string",
* "request_currency": "string",
* "request_amount": -9223372036854776000,
* "primary_payment_processor": "string",
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "redirect_url": "string",
* "payer_email": "user@example.com",
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "return_url": "string",
* "payer_mobile_number": "string",
* "payment_processor_quotes": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
]
}
}
LIST REQUEST LOGS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/requests/{identifier}/logs/
https://payment-requests.services.rehive.com/api/admin/requests/{identifier}/logs/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "request": 0,
* "user_agent": "string",
* "ip_address": "string",
* "email": "string",
* "mobile_number": "string"
}
]
}
}
LIST REQUEST PAYMENT PROCESSOR QUOTES
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/requests/{identifier}/payment-process-quotes/
https://payment-requests.services.rehive.com/api/admin/requests/{identifier}/payment-process-quotes/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
]
}
}
RETRIEVE REQUEST PAYMENT PROCESSOR QUOTE
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
quote_identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/requests/{identifier}/payment-process-quotes/{quote_identifier}/
https://payment-requests.services.rehive.com/api/admin/requests/{identifier}/payment-process-quotes/{quote_identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
}
RETRIEVE REQUEST PAYMENT PROCESSOR QUOTE CONVERSION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
quote_identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/requests/{identifier}/payment-process-quotes/{quote_identifier}/execute/
https://payment-requests.services.rehive.com/api/admin/requests/{identifier}/payment-process-quotes/{quote_identifier}/execute/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
}
LIST REQUEST REFUNDS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/requests/{identifier}/refunds/
https://payment-requests.services.rehive.com/api/admin/requests/{identifier}/refunds/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "amount": -9223372036854776000,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "status": "pending",
* "type": "native",
* "transaction_collection": "string",
* "reason": "string",
* "request": 0,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE REQUEST REFUND
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
currency
required
string
amount
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
type
string
Value: "native"
* native - Native
reason
string or null <= 100 characters
created
integer
updated
integer
RESPONSES
201
post/admin/requests/{identifier}/refunds/
https://payment-requests.services.rehive.com/api/admin/requests/{identifier}/refunds/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "amount": -9223372036854776000,
* "currency": "string",
* "type": "native",
* "reason": "string",
* "created": 0,
* "updated": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": -9223372036854776000,
* "currency": "string",
* "status": "pending",
* "type": "native",
* "transaction_collection": "string",
* "reason": "string",
* "request": 0,
* "created": 0,
* "updated": 0
}
}
LIST REQUEST TRANSACTIONS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/requests/{identifier}/transactions/
https://payment-requests.services.rehive.com/api/admin/requests/{identifier}/transactions/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "rehive_code": "string",
* "status": "pending",
* "payment_processor_quote": 0,
* "details": {
* "property1": null,
* "property2": null
}
}
]
}
}
LIST USERS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/admin/users/
https://payment-requests.services.rehive.com/api/admin/users/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "base_currency": "string",
* "rate_padding": "string",
* "email": "string",
* "mobile_number": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
}
]
}
}
RETRIEVE USER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/users/{identifier}/
https://payment-requests.services.rehive.com/api/admin/users/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "base_currency": "string",
* "rate_padding": "string",
* "email": "string",
* "mobile_number": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
}
}
UPDATE USER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
base_currency
string or null <= 12 characters
rate_padding
string or null <decimal> ^-?\d{0,12}(?:\.\d{0,18})?$
RESPONSES
200
put/admin/users/{identifier}/
https://payment-requests.services.rehive.com/api/admin/users/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "base_currency": "string",
* "rate_padding": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "base_currency": "string",
* "rate_padding": "string",
* "email": "string",
* "mobile_number": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
}
}
PARTIALLY UPDATE USER
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
base_currency
string or null <= 12 characters
rate_padding
string or null <decimal> ^-?\d{0,12}(?:\.\d{0,18})?$
RESPONSES
200
patch/admin/users/{identifier}/
https://payment-requests.services.rehive.com/api/admin/users/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "base_currency": "string",
* "rate_padding": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "base_currency": "string",
* "rate_padding": "string",
* "email": "string",
* "mobile_number": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
}
}
LIST WEBHOOKS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
event
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
secret
string
url
string
RESPONSES
200
get/admin/webhooks/
https://payment-requests.services.rehive.com/api/admin/webhooks/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
]
}
}
CREATE WEBHOOK
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
event
required
string
Enum: "service_payment_requests.request.create"
"service_payment_requests.request.update"
"service_payment_requests.quote.create" "service_payment_requests.otp.create"
"service_payment_requests.payer_reminder"
"service_payment_requests.payer_requested"
* service_payment_requests.request.create -
service_payment_requests.request.create
* service_payment_requests.request.update -
service_payment_requests.request.update
* service_payment_requests.quote.create - Payment Requests Quote Create
* service_payment_requests.otp.create - service_payment_requests.otp.create
* service_payment_requests.payer_reminder - Payment Requests Payer Reminder
* service_payment_requests.payer_requested - Payment Requests Request Payer
Requested
url
required
string <= 150 characters
secret
string or null <= 150 characters
RESPONSES
201
post/admin/webhooks/
https://payment-requests.services.rehive.com/api/admin/webhooks/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
}
RETRIEVE WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/admin/webhooks/{identifier}/
https://payment-requests.services.rehive.com/api/admin/webhooks/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
}
UPDATE WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
event
required
string
Enum: "service_payment_requests.request.create"
"service_payment_requests.request.update"
"service_payment_requests.quote.create" "service_payment_requests.otp.create"
"service_payment_requests.payer_reminder"
"service_payment_requests.payer_requested"
* service_payment_requests.request.create -
service_payment_requests.request.create
* service_payment_requests.request.update -
service_payment_requests.request.update
* service_payment_requests.quote.create - Payment Requests Quote Create
* service_payment_requests.otp.create - service_payment_requests.otp.create
* service_payment_requests.payer_reminder - Payment Requests Payer Reminder
* service_payment_requests.payer_requested - Payment Requests Request Payer
Requested
url
required
string <= 150 characters
secret
string or null <= 150 characters
RESPONSES
200
put/admin/webhooks/{identifier}/
https://payment-requests.services.rehive.com/api/admin/webhooks/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
}
PARTIALLY UPDATE WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
secret
string or null <= 150 characters
url
string <= 150 characters
event
string
Enum: "service_payment_requests.request.create"
"service_payment_requests.request.update"
"service_payment_requests.quote.create" "service_payment_requests.otp.create"
"service_payment_requests.payer_reminder"
"service_payment_requests.payer_requested"
* service_payment_requests.request.create -
service_payment_requests.request.create
* service_payment_requests.request.update -
service_payment_requests.request.update
* service_payment_requests.quote.create - Payment Requests Quote Create
* service_payment_requests.otp.create - service_payment_requests.otp.create
* service_payment_requests.payer_reminder - Payment Requests Payer Reminder
* service_payment_requests.payer_requested - Payment Requests Request Payer
Requested
RESPONSES
200
patch/admin/webhooks/{identifier}/
https://payment-requests.services.rehive.com/api/admin/webhooks/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
}
DELETE WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/admin/webhooks/{identifier}/
https://payment-requests.services.rehive.com/api/admin/webhooks/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
}
DEACTIVATE
DEACTIVATE SERVICE
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
token
required
string
purge
boolean
Default: false
RESPONSES
200
post/deactivate/
https://payment-requests.services.rehive.com/api/deactivate/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "token": "string",
* "purge": false
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
REQUESTS
RETRIEVE REQUEST
AUTHORIZATIONS:
None
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/requests/{identifier}/
https://payment-requests.services.rehive.com/api/requests/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": 0,
* "primary_payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "account": "string",
* "redirect_url": "string",
* "payer_email": "user@example.com",
* "payer_mobile_number": "string",
* "return_url": "string",
* "payment_processor_quotes": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
],
* "available_payment_processors": [
* {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "selectable_currencies": [
* "string"
],
* "weight": 0
}
],
* "expiration_date": 0,
* "note": "string",
* "refunded": true,
* "due_date": 0,
* "created": 0,
* "updated": 0
}
}
UPDATE REQUEST
AUTHORIZATIONS:
None
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
status
required
string
Enum: "draft" "initiated" "processing" "paid" "complete" "failed" "overpaid"
"cancelled" "expired" "late" "underpaid"
* draft - Draft
* initiated - Initiated
* processing - Processing
* paid - Paid
* complete - Complete
* failed - Failed
* overpaid - Overpaid
* cancelled - Cancelled
* expired - Expired
* late - Late
* underpaid - Underpaid
user
object (User)
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
payer_user
object (User)
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
primary_payment_processor
object (PaymentProcessor)
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
payer_email
string <email>
payment_processor_quotes
Array of objects (PaymentProcessorQuote)
available_payment_processors
Array of objects (AvailablePaymentProcessor)
expiration_date
integer
note
string or null <= 255 characters
due_date
integer
created
integer
updated
integer
RESPONSES
200
put/requests/{identifier}/
https://payment-requests.services.rehive.com/api/requests/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "user": {
* "base_currency": "string"
},
* "payer_user": {
* "base_currency": "string"
},
* "primary_payment_processor": {
* "type": "wallet",
* "weight": 0
},
* "status": "draft",
* "payer_email": "user@example.com",
* "payment_processor_quotes": [
* {
* "payment_processor": {
* "type": "wallet",
* "weight": 0
},
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted"
},
* "created": 0,
* "updated": 0
}
],
* "available_payment_processors": [
* {
* "type": "wallet",
* "selectable_currencies": [
* "string"
],
* "weight": 0
}
],
* "expiration_date": 0,
* "note": "string",
* "due_date": 0,
* "created": 0,
* "updated": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": 0,
* "primary_payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "account": "string",
* "redirect_url": "string",
* "payer_email": "user@example.com",
* "payer_mobile_number": "string",
* "return_url": "string",
* "payment_processor_quotes": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
],
* "available_payment_processors": [
* {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "selectable_currencies": [
* "string"
],
* "weight": 0
}
],
* "expiration_date": 0,
* "note": "string",
* "refunded": true,
* "due_date": 0,
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE REQUEST
AUTHORIZATIONS:
None
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
user
object (User)
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
primary_payment_processor
string
status
string
Enum: "draft" "initiated" "processing" "paid" "complete" "failed" "overpaid"
"cancelled" "expired" "late" "underpaid"
* draft - Draft
* initiated - Initiated
* processing - Processing
* paid - Paid
* complete - Complete
* failed - Failed
* overpaid - Overpaid
* cancelled - Cancelled
* expired - Expired
* late - Late
* underpaid - Underpaid
payer_email
string <email>
payer_mobile_number
string
payment_processor_quotes
Array of objects (PaymentProcessorQuote)
payment_processor_currency
string
available_payment_processors
Array of objects (AvailablePaymentProcessor)
quote_amount
string
note
string or null <= 255 characters
RESPONSES
200
patch/requests/{identifier}/
https://payment-requests.services.rehive.com/api/requests/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "user": {
* "base_currency": "string"
},
* "primary_payment_processor": "string",
* "status": "draft",
* "payer_email": "user@example.com",
* "payer_mobile_number": "string",
* "payment_processor_quotes": [
* {
* "payment_processor": {
* "type": "wallet",
* "weight": 0
},
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted"
},
* "created": 0,
* "updated": 0
}
],
* "payment_processor_currency": "string",
* "available_payment_processors": [
* {
* "type": "wallet",
* "selectable_currencies": [
* "string"
],
* "weight": 0
}
],
* "quote_amount": "string",
* "note": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": 0,
* "primary_payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "account": "string",
* "redirect_url": "string",
* "payer_email": "user@example.com",
* "payer_mobile_number": "string",
* "return_url": "string",
* "payment_processor_quotes": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
],
* "available_payment_processors": [
* {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "selectable_currencies": [
* "string"
],
* "weight": 0
}
],
* "expiration_date": 0,
* "note": "string",
* "refunded": true,
* "due_date": 0,
* "created": 0,
* "updated": 0
}
}
CREATE OTP CHALLENGE
AUTHORIZATIONS:
None
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
otp
required
string
RESPONSES
200
post/requests/{identifier}/otp_challenge/
https://payment-requests.services.rehive.com/api/requests/{identifier}/otp_challenge/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "otp": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
LIST REQUEST PAYMENT PROCESSORS
AUTHORIZATIONS:
None
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/requests/{identifier}/payment_processors/
https://payment-requests.services.rehive.com/api/requests/{identifier}/payment_processors/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
}
]
}
}
RESEND OTP CHALLENGE
AUTHORIZATIONS:
None
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
post/requests/{identifier}/resend_otp/
https://payment-requests.services.rehive.com/api/requests/{identifier}/resend_otp/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
LIST REQUEST TRANSACTIONS
AUTHORIZATIONS:
None
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/requests/{identifier}/transactions/
https://payment-requests.services.rehive.com/api/requests/{identifier}/transactions/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "rehive_code": "string",
* "status": "pending",
* "payment_processor_quote": 0,
* "details": {
* "property1": null,
* "property2": null
}
}
]
}
}
USER
LIST PAYMENT PROCESSORS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/user/payment_processors/
https://payment-requests.services.rehive.com/api/user/payment_processors/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "active": true,
* "company_payment_processor": {
* "id": "string",
* "active": true,
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currencies": [
* {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
}
]
},
* "currencies": [
* {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
}
]
}
]
}
}
CREATE PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
active
boolean
currencies
Array of strings <= 100 items
RESPONSES
201
post/user/payment_processors/
https://payment-requests.services.rehive.com/api/user/payment_processors/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "active": true,
* "currencies": [
* "string"
]
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "active": true,
* "company_payment_processor": {
* "id": "string",
* "active": true,
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currencies": [
* {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
}
]
},
* "currencies": [
* {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
}
]
}
}
RETRIEVE PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/payment_processors/{id}/
https://payment-requests.services.rehive.com/api/user/payment_processors/{id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "active": true,
* "company_payment_processor": {
* "id": "string",
* "active": true,
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currencies": [
* {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
}
]
},
* "currencies": [
* {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
}
]
}
}
UPDATE PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
active
boolean
currencies
Array of strings <= 100 items
RESPONSES
200
put/user/payment_processors/{id}/
https://payment-requests.services.rehive.com/api/user/payment_processors/{id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "active": true,
* "currencies": [
* "string"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "active": true,
* "company_payment_processor": 0
}
}
PARTIALLY UPDATE PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
id
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
active
boolean
currencies
Array of strings <= 100 items
RESPONSES
200
patch/user/payment_processors/{id}/
https://payment-requests.services.rehive.com/api/user/payment_processors/{id}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "active": true,
* "currencies": [
* "string"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "active": true,
* "company_payment_processor": 0
}
}
DELETE PAYMENT PROCESSOR
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
id
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/user/payment_processors/{id}/
https://payment-requests.services.rehive.com/api/user/payment_processors/{id}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "active": true,
* "company_payment_processor": 0
}
}
LIST REQUEST
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
created
string <date-time>
created__gt
string
created__gte
string
created__lt
string
created__lte
string
expiration_date__gt
string
expiration_date__gte
string
expiration_date__lt
string
expiration_date__lte
string
id
string
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
payer_email
string
payer_mobile_number
string
payment_processor_quote_reference
string
refund_status
string
refunded
string
request_currency
string
request_reference
string
request_type
string
status
string
status__in
string
RESPONSES
200
get/user/requests/
https://payment-requests.services.rehive.com/api/user/requests/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_email": "string",
* "payer_mobile_number": "string",
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": -9223372036854776000,
* "primary_payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "redirect_url": "string",
* "payment_processor_quotes": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "amount": -9223372036854776000,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "status": "pending",
* "type": "native",
* "transaction_collection": "string",
* "reason": "string",
* "request": 0,
* "created": 0,
* "updated": 0
}
],
* "return_url": "string",
* "send_request_on": 0,
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "refunded": true,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE REQUEST
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
account
required
string <= 255 characters
request_currency
required
string
user
object (User)
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
payer_user
object (User)
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
request_reference
string or null <= 255 characters
request_amount
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
primary_payment_processor
string
description
string or null <= 255 characters
metadata
object or null
status
string
Enum: "draft" "initiated" "processing" "paid" "complete" "failed" "overpaid"
"cancelled" "expired" "late" "underpaid"
* draft - Draft
* initiated - Initiated
* processing - Processing
* paid - Paid
* complete - Complete
* failed - Failed
* overpaid - Overpaid
* cancelled - Cancelled
* expired - Expired
* late - Late
* underpaid - Underpaid
expiration_date
integer
due_date
integer
send_request_on
integer
send_reminders
boolean
reminder_intervals
Array of integers
note
string or null <= 255 characters
payer_email
string <email>
return_url
string or null <= 255 characters
payer_mobile_number
string
payment_processor_quotes
Array of objects (PaymentProcessorQuote)
RESPONSES
201
post/user/requests/
https://payment-requests.services.rehive.com/api/user/requests/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "user": {
* "base_currency": "string"
},
* "payer_user": {
* "base_currency": "string"
},
* "request_reference": "string",
* "request_currency": "string",
* "request_amount": -9223372036854776000,
* "primary_payment_processor": "string",
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "payer_email": "user@example.com",
* "return_url": "string",
* "payer_mobile_number": "string",
* "payment_processor_quotes": [
* {
* "payment_processor": {
* "type": "wallet",
* "weight": 0
},
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted"
},
* "created": 0,
* "updated": 0
}
]
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "request_reference": "string",
* "request_currency": "string",
* "request_amount": -9223372036854776000,
* "primary_payment_processor": "string",
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "redirect_url": "string",
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "payer_email": "user@example.com",
* "return_url": "string",
* "payer_mobile_number": "string",
* "payment_processor_quotes": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
]
}
}
RETRIEVE REQUEST
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/requests/{identifier}/
https://payment-requests.services.rehive.com/api/user/requests/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_email": "string",
* "payer_mobile_number": "string",
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": -9223372036854776000,
* "primary_payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "redirect_url": "string",
* "payment_processor_quotes": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "amount": -9223372036854776000,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "status": "pending",
* "type": "native",
* "transaction_collection": "string",
* "reason": "string",
* "request": 0,
* "created": 0,
* "updated": 0
}
],
* "return_url": "string",
* "send_request_on": 0,
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "refunded": true,
* "created": 0,
* "updated": 0
}
}
UPDATE REQUEST
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
account
required
string <= 255 characters
status
required
string
Enum: "draft" "initiated" "processing" "paid" "complete" "failed" "overpaid"
"cancelled" "expired" "late" "underpaid"
* draft - Draft
* initiated - Initiated
* processing - Processing
* paid - Paid
* complete - Complete
* failed - Failed
* overpaid - Overpaid
* cancelled - Cancelled
* expired - Expired
* late - Late
* underpaid - Underpaid
user
object (User)
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
payer_user
object (User)
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
request_reference
string or null <= 255 characters
request_amount
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
primary_payment_processor
object (PaymentProcessor)
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
description
string or null <= 255 characters
metadata
object or null
expiration_date
integer
due_date
integer
payment_processor_quotes
Array of objects (PaymentProcessorQuote)
refunds
Array of objects (Refund)
return_url
string or null <= 255 characters
send_request_on
integer
send_reminders
boolean
reminder_intervals
Array of integers
note
string or null <= 255 characters
created
integer
updated
integer
RESPONSES
200
put/user/requests/{identifier}/
https://payment-requests.services.rehive.com/api/user/requests/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "user": {
* "base_currency": "string"
},
* "payer_user": {
* "base_currency": "string"
},
* "request_reference": "string",
* "request_amount": -9223372036854776000,
* "primary_payment_processor": {
* "type": "wallet",
* "weight": 0
},
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "payment_processor_quotes": [
* {
* "payment_processor": {
* "type": "wallet",
* "weight": 0
},
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted"
},
* "created": 0,
* "updated": 0
}
],
* "refunds": [
* {
* "amount": -9223372036854776000,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "type": "native",
* "reason": "string",
* "created": 0,
* "updated": 0
}
],
* "return_url": "string",
* "send_request_on": 0,
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "created": 0,
* "updated": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_email": "string",
* "payer_mobile_number": "string",
* "request_reference": "string",
* "request_currency": {
* "property1": null,
* "property2": null
},
* "request_amount": -9223372036854776000,
* "primary_payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "redirect_url": "string",
* "payment_processor_quotes": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
],
* "refunds": [
* {
* "id": "string",
* "amount": -9223372036854776000,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "status": "pending",
* "type": "native",
* "transaction_collection": "string",
* "reason": "string",
* "request": 0,
* "created": 0,
* "updated": 0
}
],
* "return_url": "string",
* "send_request_on": 0,
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "refunded": true,
* "created": 0,
* "updated": 0
}
}
PARTIALLY UPDATE REQUEST
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
user
object (User)
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
payer_user
object (User)
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
request_reference
string or null <= 255 characters
request_currency
string
request_amount
integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ]
primary_payment_processor
string
description
string or null <= 255 characters
metadata
object or null
status
string
Enum: "draft" "initiated" "processing" "paid" "complete" "failed" "overpaid"
"cancelled" "expired" "late" "underpaid"
* draft - Draft
* initiated - Initiated
* processing - Processing
* paid - Paid
* complete - Complete
* failed - Failed
* overpaid - Overpaid
* cancelled - Cancelled
* expired - Expired
* late - Late
* underpaid - Underpaid
expiration_date
integer
due_date
integer
send_request_on
integer
account
string <= 255 characters
send_reminders
boolean
reminder_intervals
Array of integers
note
string or null <= 255 characters
payer_email
string <email>
return_url
string or null <= 255 characters
payer_mobile_number
string
payment_processor_quotes
Array of objects (PaymentProcessorQuote)
RESPONSES
200
patch/user/requests/{identifier}/
https://payment-requests.services.rehive.com/api/user/requests/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "user": {
* "base_currency": "string"
},
* "payer_user": {
* "base_currency": "string"
},
* "request_reference": "string",
* "request_currency": "string",
* "request_amount": -9223372036854776000,
* "primary_payment_processor": "string",
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "payer_email": "user@example.com",
* "return_url": "string",
* "payer_mobile_number": "string",
* "payment_processor_quotes": [
* {
* "payment_processor": {
* "type": "wallet",
* "weight": 0
},
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted"
},
* "created": 0,
* "updated": 0
}
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "payer_user": {
* "id": "string",
* "base_currency": "string",
* "company": "string",
* "mobile_number": "string",
* "email": "string",
* "first_name": "string",
* "profile": "string",
* "last_name": "string"
},
* "request_reference": "string",
* "request_currency": "string",
* "request_amount": -9223372036854776000,
* "primary_payment_processor": "string",
* "description": "string",
* "metadata": {
* "property1": null,
* "property2": null
},
* "status": "draft",
* "expiration_date": 0,
* "due_date": 0,
* "send_request_on": 0,
* "redirect_url": "string",
* "account": "string",
* "send_reminders": true,
* "reminder_intervals": [
* 0
],
* "note": "string",
* "payer_email": "user@example.com",
* "return_url": "string",
* "payer_mobile_number": "string",
* "payment_processor_quotes": [
* {
* "id": "string",
* "request": 0,
* "reference": "string",
* "deposit_details": {
* "property1": null,
* "property2": null
},
* "payment_processor": {
* "id": "string",
* "native": true,
* "unique_string_name": "string",
* "logo": "string",
* "name": "string",
* "description": "string",
* "selector_description": "string",
* "pending_processing_description": "string",
* "processing_description": "string",
* "currencies": [
* "string"
],
* "type": "wallet",
* "longest_expiration_time": 0,
* "rehive_transaction_identifier": {
* "property1": null,
* "property2": null
},
* "rehive_subtype": "string",
* "active_weight": 0,
* "generate_accounts": true,
* "weight": 0
},
* "currency": {
* "property1": null,
* "property2": null
},
* "amount": 0,
* "total_paid": 0,
* "total_pending": 0,
* "expiration_date": 0,
* "status": "pending",
* "conversion_quote": {
* "status": "quoted",
* "conversion_quote_id": "string",
* "rate": "string"
},
* "created": 0,
* "account": "string",
* "updated": 0
}
]
}
}
SEND NOTIFICATION
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
post/user/requests/{identifier}/notify/
https://payment-requests.services.rehive.com/api/user/requests/{identifier}/notify/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
LIST REQUEST REFUNDS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/user/requests/{identifier}/refunds/
https://payment-requests.services.rehive.com/api/user/requests/{identifier}/refunds/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "amount": -9223372036854776000,
* "currency": {
* "code": "string",
* "display_code": "string",
* "description": "string",
* "symbol": "string",
* "unit": "string",
* "divisibility": -2147483648
},
* "status": "pending",
* "type": "native",
* "transaction_collection": "string",
* "reason": "string",
* "request": 0,
* "created": 0,
* "updated": 0
}
]
}
}
CREATE REQUEST REFUND
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
currency
required
string
amount
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
type
string
Value: "native"
* native - Native
reason
string or null <= 100 characters
created
integer
updated
integer
RESPONSES
201
post/user/requests/{identifier}/refunds/
https://payment-requests.services.rehive.com/api/user/requests/{identifier}/refunds/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "amount": -9223372036854776000,
* "currency": "string",
* "type": "native",
* "reason": "string",
* "created": 0,
* "updated": 0
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "amount": -9223372036854776000,
* "currency": "string",
* "status": "pending",
* "type": "native",
* "transaction_collection": "string",
* "reason": "string",
* "request": 0,
* "created": 0,
* "updated": 0
}
}
LIST REQUEST TRANSACTIONS
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/user/requests/{identifier}/transactions/
https://payment-requests.services.rehive.com/api/user/requests/{identifier}/transactions/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "rehive_code": "string",
* "status": "pending",
* "payment_processor_quote": 0,
* "details": {
* "property1": null,
* "property2": null
}
}
]
}
}
LIST WEBHOOKS
AUTHORIZATIONS:
apiAuth
QUERY PARAMETERS
page
integer
A page number within the paginated result set.
page_size
integer
Number of results to return per page.
RESPONSES
200
get/user/webhooks/
https://payment-requests.services.rehive.com/api/user/webhooks/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "count": 123,
* "next": "http://api.example.org/accounts/?page=4",
* "previous": "http://api.example.org/accounts/?page=2",
* "results": [
* {
* "id": "string",
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
]
}
}
CREATE WEBHOOK
AUTHORIZATIONS:
apiAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
event
required
string
Enum: "service_payment_requests.request.create"
"service_payment_requests.request.update"
"service_payment_requests.quote.create" "service_payment_requests.otp.create"
"service_payment_requests.payer_reminder"
"service_payment_requests.payer_requested"
* service_payment_requests.request.create -
service_payment_requests.request.create
* service_payment_requests.request.update -
service_payment_requests.request.update
* service_payment_requests.quote.create - Payment Requests Quote Create
* service_payment_requests.otp.create - service_payment_requests.otp.create
* service_payment_requests.payer_reminder - Payment Requests Payer Reminder
* service_payment_requests.payer_requested - Payment Requests Request Payer
Requested
url
required
string <= 150 characters
secret
string or null <= 150 characters
RESPONSES
201
post/user/webhooks/
https://payment-requests.services.rehive.com/api/user/webhooks/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
}
RETRIEVE WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
get/user/webhooks/{identifier}/
https://payment-requests.services.rehive.com/api/user/webhooks/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
}
UPDATE WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
event
required
string
Enum: "service_payment_requests.request.create"
"service_payment_requests.request.update"
"service_payment_requests.quote.create" "service_payment_requests.otp.create"
"service_payment_requests.payer_reminder"
"service_payment_requests.payer_requested"
* service_payment_requests.request.create -
service_payment_requests.request.create
* service_payment_requests.request.update -
service_payment_requests.request.update
* service_payment_requests.quote.create - Payment Requests Quote Create
* service_payment_requests.otp.create - service_payment_requests.otp.create
* service_payment_requests.payer_reminder - Payment Requests Payer Reminder
* service_payment_requests.payer_requested - Payment Requests Request Payer
Requested
url
required
string <= 150 characters
secret
string or null <= 150 characters
RESPONSES
200
put/user/webhooks/{identifier}/
https://payment-requests.services.rehive.com/api/user/webhooks/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
}
PARTIALLY WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
secret
string or null <= 150 characters
url
string <= 150 characters
event
string
Enum: "service_payment_requests.request.create"
"service_payment_requests.request.update"
"service_payment_requests.quote.create" "service_payment_requests.otp.create"
"service_payment_requests.payer_reminder"
"service_payment_requests.payer_requested"
* service_payment_requests.request.create -
service_payment_requests.request.create
* service_payment_requests.request.update -
service_payment_requests.request.update
* service_payment_requests.quote.create - Payment Requests Quote Create
* service_payment_requests.otp.create - service_payment_requests.otp.create
* service_payment_requests.payer_reminder - Payment Requests Payer Reminder
* service_payment_requests.payer_requested - Payment Requests Request Payer
Requested
RESPONSES
200
patch/user/webhooks/{identifier}/
https://payment-requests.services.rehive.com/api/user/webhooks/{identifier}/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
{
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
}
DELETE WEBHOOK
AUTHORIZATIONS:
apiAuth
PATH PARAMETERS
identifier
required
string^([a-zA-Z0-9\_\-]+)$
RESPONSES
200
delete/user/webhooks/{identifier}/
https://payment-requests.services.rehive.com/api/user/webhooks/{identifier}/
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "status": "success",
* "data": {
* "id": "string",
* "secret": "string",
* "url": "string",
* "event": "service_payment_requests.request.create"
}
}
WEBHOOK
RECEIVE PLATFORM WEBHOOK
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
company
required
string
data
required
object
event
required
string
Enum: "currency.create" "currency.update" "transaction.initiate"
"transaction.execute" "user.create" "user.update"
* currency.create - currency.create
* currency.update - currency.update
* transaction.initiate - transaction.initiate
* transaction.execute - transaction.execute
* user.create - user.create
* user.update - user.update
id
required
string
RESPONSES
200
post/webhook/
https://payment-requests.services.rehive.com/api/webhook/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "id": "string",
* "event": "currency.create",
* "company": "string",
* "data": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
WEBHOOKS
RECEIVE PLATFORM WEBHOOK
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
company
required
string
data
required
object
event
required
string
Enum: "currency.create" "currency.update" "transaction.initiate"
"transaction.execute" "user.create" "user.update"
* currency.create - currency.create
* currency.update - currency.update
* transaction.initiate - transaction.initiate
* transaction.execute - transaction.execute
* user.create - user.create
* user.update - user.update
id
required
string
RESPONSES
200
post/webhooks/rehive_transaction/executed/
https://payment-requests.services.rehive.com/api/webhooks/rehive_transaction/executed/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "id": "string",
* "event": "currency.create",
* "company": "string",
* "data": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
RECEIVE PLATFORM WEBHOOK
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
company
required
string
data
required
object
event
required
string
Enum: "currency.create" "currency.update" "transaction.initiate"
"transaction.execute" "user.create" "user.update"
* currency.create - currency.create
* currency.update - currency.update
* transaction.initiate - transaction.initiate
* transaction.execute - transaction.execute
* user.create - user.create
* user.update - user.update
id
required
string
RESPONSES
200
post/webhooks/rehive_transaction/initiated/
https://payment-requests.services.rehive.com/api/webhooks/rehive_transaction/initiated/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "id": "string",
* "event": "currency.create",
* "company": "string",
* "data": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
RECEIVE PLATFORM WEBHOOK
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
company
required
string
data
required
object
event
required
string
Enum: "currency.create" "currency.update" "transaction.initiate"
"transaction.execute" "user.create" "user.update"
* currency.create - currency.create
* currency.update - currency.update
* transaction.initiate - transaction.initiate
* transaction.execute - transaction.execute
* user.create - user.create
* user.update - user.update
id
required
string
RESPONSES
200
post/webhooks/rehive_user/create/
https://payment-requests.services.rehive.com/api/webhooks/rehive_user/create/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "id": "string",
* "event": "currency.create",
* "company": "string",
* "data": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
RECEIVE PLATFORM WEBHOOK
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
company
required
string
data
required
object
event
required
string
Enum: "currency.create" "currency.update" "transaction.initiate"
"transaction.execute" "user.create" "user.update"
* currency.create - currency.create
* currency.update - currency.update
* transaction.initiate - transaction.initiate
* transaction.execute - transaction.execute
* user.create - user.create
* user.update - user.update
id
required
string
RESPONSES
200
post/webhooks/rehive_user/email_update/
https://payment-requests.services.rehive.com/api/webhooks/rehive_user/email_update/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "id": "string",
* "event": "currency.create",
* "company": "string",
* "data": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}
RECEIVE PLATFORM WEBHOOK
AUTHORIZATIONS:
None
REQUEST BODY SCHEMA:
APPLICATION/JSONAPPLICATION/X-WWW-FORM-URLENCODEDMULTIPART/FORM-DATAAPPLICATION/JSON
company
required
string
data
required
object
event
required
string
Enum: "currency.create" "currency.update" "transaction.initiate"
"transaction.execute" "user.create" "user.update"
* currency.create - currency.create
* currency.update - currency.update
* transaction.initiate - transaction.initiate
* transaction.execute - transaction.execute
* user.create - user.create
* user.update - user.update
id
required
string
RESPONSES
200
post/webhooks/rehive_user/update/
https://payment-requests.services.rehive.com/api/webhooks/rehive_user/update/
REQUEST SAMPLES
* Payload
Content type
application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json
Copy
Expand all Collapse all
{
* "id": "string",
* "event": "currency.create",
* "company": "string",
* "data": {
* "property1": null,
* "property2": null
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "status": "sucess"
}