The Payment Request object
Attributes
id string
Unique identifier for the object.
created_at string
ISO 8601 timestamp of when the object was created.
updated_at string
ISO 8601 timestamp of when the object was last updated.
status string
Default: draft
payment_request_type string
Default: Inward
transaction_date string
mode_of_payment string
party_type string
party string
reference_doctype string
reference_name string
grand_total number required
is_a_subscription boolean
Default: false
currency string
bank_account string
bank string
bank_account_no string
account string
iban string
branch_code string
swift_number string
cost_center string
project string
print_format string
email_to string
subject string
payment_gateway_account string
make_sales_invoice boolean
Default: false
message string
mute_email boolean
Default: false
payment_url string
payment_gateway string
payment_account string
payment_channel string
payment_order string
failed_reason string
outstanding_amount number
company string
party_account_currency string
party_name string
phone_number string
The Payment Request object
{
"id": "payment-request_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"payment_request_type": "Inward",
"transaction_date": "2024-01-15",
"mode_of_payment": "mode_of_payment_example",
"party_type": "party_type_example",
"party": "party_example",
"reference_doctype": "reference_doctype_example",
"reference_name": "reference_name_example",
"grand_total": 0,
"is_a_subscription": false,
"currency": "USD",
"bank_account": "bank_account_example",
"bank": "bank_example",
"bank_account_no": "bank_account_no_example",
"account": "account_example",
"iban": "iban_example",
"branch_code": "branch_code_example",
"swift_number": "swift_number_example",
"cost_center": "cost_center_example",
"project": "project_example",
"print_format": "print_format_example",
"email_to": "[email protected]",
"subject": "subject_example",
"payment_gateway_account": "payment_gateway_account_example",
"make_sales_invoice": false,
"message": "message_example",
"mute_email": false,
"payment_url": "payment_url_example",
"payment_gateway": "payment_gateway_example",
"payment_account": "payment_account_example",
"payment_channel": "payment_channel_example",
"payment_order": "payment_order_example",
"failed_reason": "failed_reason_example",
"outstanding_amount": 0,
"company": "Example Corp",
"party_account_currency": "USD",
"party_name": "party_name_example",
"phone_number": "phone_number_example"
} GET
/api/accounts/payment-request/{id} Retrieve a payment request
Retrieves the details of an existing payment request. Supply the unique payment request ID that was returned from a previous request.
Path parameters
id string required
The identifier of the payment request to retrieve.
Returns
Returns the payment request object if a valid identifier was provided.
GET /api/accounts/payment-request/{id}
curl https://api.overplane.dev/api/accounts/payment-request/payment-request_abc123 \
-H "Authorization: Bearer sk_test_..." Response
{
"id": "payment-request_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"payment_request_type": "Inward",
"transaction_date": "2024-01-15",
"mode_of_payment": "mode_of_payment_example",
"party_type": "party_type_example",
"party": "party_example",
"reference_doctype": "reference_doctype_example",
"reference_name": "reference_name_example",
"grand_total": 0,
"is_a_subscription": false,
"currency": "USD",
"bank_account": "bank_account_example",
"bank": "bank_example",
"bank_account_no": "bank_account_no_example",
"account": "account_example",
"iban": "iban_example",
"branch_code": "branch_code_example",
"swift_number": "swift_number_example",
"cost_center": "cost_center_example",
"project": "project_example",
"print_format": "print_format_example",
"email_to": "[email protected]",
"subject": "subject_example",
"payment_gateway_account": "payment_gateway_account_example",
"make_sales_invoice": false,
"message": "message_example",
"mute_email": false,
"payment_url": "payment_url_example",
"payment_gateway": "payment_gateway_example",
"payment_account": "payment_account_example",
"payment_channel": "payment_channel_example",
"payment_order": "payment_order_example",
"failed_reason": "failed_reason_example",
"outstanding_amount": 0,
"company": "Example Corp",
"party_account_currency": "USD",
"party_name": "party_name_example",
"phone_number": "phone_number_example"
} GET
/api/accounts/payment-request List all payment requests
Returns a list of payment requests. The results are sorted by creation date, with the most recently created appearing first.
Query parameters
limit integer
Maximum number of objects to return. Default: 20.
offset integer
Number of objects to skip for pagination. Default: 0.
Returns
A paginated list of payment request objects.
GET /api/accounts/payment-request
curl https://api.overplane.dev/api/accounts/payment-request \
-H "Authorization: Bearer sk_test_..." Response
{
"data": [
{
"id": "payment-request_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"payment_request_type": "Inward",
"transaction_date": "2024-01-15",
"mode_of_payment": "mode_of_payment_example",
"party_type": "party_type_example",
"party": "party_example",
"reference_doctype": "reference_doctype_example",
"reference_name": "reference_name_example",
"grand_total": 0,
"is_a_subscription": false,
"currency": "USD",
"bank_account": "bank_account_example",
"bank": "bank_example",
"bank_account_no": "bank_account_no_example",
"account": "account_example",
"iban": "iban_example",
"branch_code": "branch_code_example",
"swift_number": "swift_number_example",
"cost_center": "cost_center_example",
"project": "project_example",
"print_format": "print_format_example",
"email_to": "[email protected]",
"subject": "subject_example",
"payment_gateway_account": "payment_gateway_account_example",
"make_sales_invoice": false,
"message": "message_example",
"mute_email": false,
"payment_url": "payment_url_example",
"payment_gateway": "payment_gateway_example",
"payment_account": "payment_account_example",
"payment_channel": "payment_channel_example",
"payment_order": "payment_order_example",
"failed_reason": "failed_reason_example",
"outstanding_amount": 0,
"company": "Example Corp",
"party_account_currency": "USD",
"party_name": "party_name_example",
"phone_number": "phone_number_example"
}
],
"has_more": false,
"total": 1
} POST
/api/accounts/payment-request Create a payment request
Creates a new payment request object.
Body parameters
status string
Default: draft
payment_request_type string
Default: Inward
transaction_date string
mode_of_payment string
party_type string
party string
reference_doctype string
reference_name string
grand_total number required
is_a_subscription boolean
Default: false
currency string
bank_account string
bank string
bank_account_no string
account string
iban string
branch_code string
swift_number string
cost_center string
project string
print_format string
email_to string
subject string
payment_gateway_account string
make_sales_invoice boolean
Default: false
message string
mute_email boolean
Default: false
payment_url string
payment_gateway string
payment_account string
payment_channel string
payment_order string
failed_reason string
outstanding_amount number
company string
party_account_currency string
party_name string
phone_number string
Returns
Returns the newly created payment request object if the call succeeded.
POST /api/accounts/payment-request
curl https://api.overplane.dev/api/accounts/payment-request \
-H "Authorization: Bearer sk_test_..." \
-X POST \
-H "Content-Type: application/json" \
-d '{"grand_total":0}' Response
{
"id": "payment-request_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"payment_request_type": "Inward",
"transaction_date": "2024-01-15",
"mode_of_payment": "mode_of_payment_example",
"party_type": "party_type_example",
"party": "party_example",
"reference_doctype": "reference_doctype_example",
"reference_name": "reference_name_example",
"grand_total": 0,
"is_a_subscription": false,
"currency": "USD",
"bank_account": "bank_account_example",
"bank": "bank_example",
"bank_account_no": "bank_account_no_example",
"account": "account_example",
"iban": "iban_example",
"branch_code": "branch_code_example",
"swift_number": "swift_number_example",
"cost_center": "cost_center_example",
"project": "project_example",
"print_format": "print_format_example",
"email_to": "[email protected]",
"subject": "subject_example",
"payment_gateway_account": "payment_gateway_account_example",
"make_sales_invoice": false,
"message": "message_example",
"mute_email": false,
"payment_url": "payment_url_example",
"payment_gateway": "payment_gateway_example",
"payment_account": "payment_account_example",
"payment_channel": "payment_channel_example",
"payment_order": "payment_order_example",
"failed_reason": "failed_reason_example",
"outstanding_amount": 0,
"company": "Example Corp",
"party_account_currency": "USD",
"party_name": "party_name_example",
"phone_number": "phone_number_example"
} PATCH
/api/accounts/payment-request/{id} Update a payment request
Updates the specified payment request by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Path parameters
id string required
The identifier of the payment request to update.
Body parameters
status string
Default: draft
payment_request_type string
Default: Inward
transaction_date string
mode_of_payment string
party_type string
party string
reference_doctype string
reference_name string
grand_total number
is_a_subscription boolean
Default: false
currency string
bank_account string
bank string
bank_account_no string
account string
iban string
branch_code string
swift_number string
cost_center string
project string
print_format string
email_to string
subject string
payment_gateway_account string
make_sales_invoice boolean
Default: false
message string
mute_email boolean
Default: false
payment_url string
payment_gateway string
payment_account string
payment_channel string
payment_order string
failed_reason string
outstanding_amount number
company string
party_account_currency string
party_name string
phone_number string
Returns
Returns the updated payment request object.
PATCH /api/accounts/payment-request/{id}
curl https://api.overplane.dev/api/accounts/payment-request/payment-request_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X PATCH \
-H "Content-Type: application/json" \
-d '{"status":"draft","payment_request_type":"Inward"}' Response
{
"id": "payment-request_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"payment_request_type": "Inward",
"transaction_date": "2024-01-15",
"mode_of_payment": "mode_of_payment_example",
"party_type": "party_type_example",
"party": "party_example",
"reference_doctype": "reference_doctype_example",
"reference_name": "reference_name_example",
"grand_total": 0,
"is_a_subscription": false,
"currency": "USD",
"bank_account": "bank_account_example",
"bank": "bank_example",
"bank_account_no": "bank_account_no_example",
"account": "account_example",
"iban": "iban_example",
"branch_code": "branch_code_example",
"swift_number": "swift_number_example",
"cost_center": "cost_center_example",
"project": "project_example",
"print_format": "print_format_example",
"email_to": "[email protected]",
"subject": "subject_example",
"payment_gateway_account": "payment_gateway_account_example",
"make_sales_invoice": false,
"message": "message_example",
"mute_email": false,
"payment_url": "payment_url_example",
"payment_gateway": "payment_gateway_example",
"payment_account": "payment_account_example",
"payment_channel": "payment_channel_example",
"payment_order": "payment_order_example",
"failed_reason": "failed_reason_example",
"outstanding_amount": 0,
"company": "Example Corp",
"party_account_currency": "USD",
"party_name": "party_name_example",
"phone_number": "phone_number_example"
} DELETE
/api/accounts/payment-request/{id} Delete a payment request
Permanently deletes a payment request. This cannot be undone.
Path parameters
id string required
The identifier of the payment request to delete.
Returns
Returns a confirmation that the payment request has been deleted.
DELETE /api/accounts/payment-request/{id}
curl https://api.overplane.dev/api/accounts/payment-request/payment-request_abc123 \
-H "Authorization: Bearer sk_test_..." \
-X DELETE Response
{
"id": "payment-request_abc123",
"deleted": true
} POST
/api/accounts/payment-request/{id}/submit Submit a payment request
Submits a draft payment request, transitioning its status from draft to submitted.
Path parameters
id string required
The identifier of the payment request to act on.
Returns
Returns the payment request object with updated status.
POST /api/accounts/payment-request/{id}/submit
curl https://api.overplane.dev/api/accounts/payment-request/payment-request_abc123/submit \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "payment-request_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"payment_request_type": "Inward",
"transaction_date": "2024-01-15",
"mode_of_payment": "mode_of_payment_example",
"party_type": "party_type_example",
"party": "party_example",
"reference_doctype": "reference_doctype_example",
"reference_name": "reference_name_example",
"grand_total": 0,
"is_a_subscription": false,
"currency": "USD",
"bank_account": "bank_account_example",
"bank": "bank_example",
"bank_account_no": "bank_account_no_example",
"account": "account_example",
"iban": "iban_example",
"branch_code": "branch_code_example",
"swift_number": "swift_number_example",
"cost_center": "cost_center_example",
"project": "project_example",
"print_format": "print_format_example",
"email_to": "[email protected]",
"subject": "subject_example",
"payment_gateway_account": "payment_gateway_account_example",
"make_sales_invoice": false,
"message": "message_example",
"mute_email": false,
"payment_url": "payment_url_example",
"payment_gateway": "payment_gateway_example",
"payment_account": "payment_account_example",
"payment_channel": "payment_channel_example",
"payment_order": "payment_order_example",
"failed_reason": "failed_reason_example",
"outstanding_amount": 0,
"company": "Example Corp",
"party_account_currency": "USD",
"party_name": "party_name_example",
"phone_number": "phone_number_example"
} POST
/api/accounts/payment-request/{id}/cancel Cancel a payment request
Cancels a submitted payment request, transitioning its status to cancelled.
Path parameters
id string required
The identifier of the payment request to act on.
Returns
Returns the payment request object with updated status.
POST /api/accounts/payment-request/{id}/cancel
curl https://api.overplane.dev/api/accounts/payment-request/payment-request_abc123/cancel \
-H "Authorization: Bearer sk_test_..." \
-X POST Response
{
"id": "payment-request_abc123",
"created_at": "2024-01-15T09: 30: 00Z",
"updated_at": "2024-01-15T09: 30: 00Z",
"status": "draft",
"payment_request_type": "Inward",
"transaction_date": "2024-01-15",
"mode_of_payment": "mode_of_payment_example",
"party_type": "party_type_example",
"party": "party_example",
"reference_doctype": "reference_doctype_example",
"reference_name": "reference_name_example",
"grand_total": 0,
"is_a_subscription": false,
"currency": "USD",
"bank_account": "bank_account_example",
"bank": "bank_example",
"bank_account_no": "bank_account_no_example",
"account": "account_example",
"iban": "iban_example",
"branch_code": "branch_code_example",
"swift_number": "swift_number_example",
"cost_center": "cost_center_example",
"project": "project_example",
"print_format": "print_format_example",
"email_to": "[email protected]",
"subject": "subject_example",
"payment_gateway_account": "payment_gateway_account_example",
"make_sales_invoice": false,
"message": "message_example",
"mute_email": false,
"payment_url": "payment_url_example",
"payment_gateway": "payment_gateway_example",
"payment_account": "payment_account_example",
"payment_channel": "payment_channel_example",
"payment_order": "payment_order_example",
"failed_reason": "failed_reason_example",
"outstanding_amount": 0,
"company": "Example Corp",
"party_account_currency": "USD",
"party_name": "party_name_example",
"phone_number": "phone_number_example"
}Line items
Child objects that belong to this payment request. These are accessed via the parent's ID.
Payment Reference
Attributes
idx integer
payment_request_id string required
payment_term string
description string
due_date string
amount number
payment_schedule string
Endpoints
GET
/api/accounts/payment-reference?parent_id={id} POST
/api/accounts/payment-reference PATCH
/api/accounts/payment-reference/{id} DELETE
/api/accounts/payment-reference/{id} POST
/api/accounts/payment-reference/reorder Payment Reference object
{
"id": "payment-reference_abc123",
"idx": 1,
"payment_request_id": "payment_request_id_example",
"payment_term": "payment_term_example",
"description": "description_example",
"due_date": "2024-01-15",
"amount": 0,
"payment_schedule": "payment_schedule_example"
}