Payment Requests
Pay a payment request
POST
/
payment-requests
/
{id}
/
pay
curl --request POST \
--url https://api.plane.com/v1/payment-requests/{id}/pay \
--header 'Authorization: <authorization>'
{
"id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX",
"worker": "wr_anqRSFcK36ie85",
"amount": "1200.00",
"currency": "EUR",
"status": "processed",
"reference": "EV1S3GDM",
"note": "Payment for July",
"period": {
"starts": "2023-07-01",
"ends": "2023-07-31"
},
"documents": [],
"approvals": ["apr_YzmQ5oxQE78bDV3fZwEU3vGr"],
"payment": "pt_Wc5P4C53EwD485EFE2HWAwVV"
}
Approving a Payment Request
doesn’t automatically create a Payment
, to allow
multi-step approvals.
When you are ready to complete a request, whether or not you collected any approvals, you can use this endpoint.
Parameters
id
string
requiredThe ID of the payment request you are paying.
Returns
Returns the Payment Request object with the Payment ID.
Was this page helpful?
curl --request POST \
--url https://api.plane.com/v1/payment-requests/{id}/pay \
--header 'Authorization: <authorization>'
{
"id": "ptr_ogdEjSnSqNYxtW1sd3pC3hFX",
"worker": "wr_anqRSFcK36ie85",
"amount": "1200.00",
"currency": "EUR",
"status": "processed",
"reference": "EV1S3GDM",
"note": "Payment for July",
"period": {
"starts": "2023-07-01",
"ends": "2023-07-31"
},
"documents": [],
"approvals": ["apr_YzmQ5oxQE78bDV3fZwEU3vGr"],
"payment": "pt_Wc5P4C53EwD485EFE2HWAwVV"
}