Payments
All Payments
GET
https://yoursite.mavenseed.com/api/v1/payments
Retrieve all payments
Path Parameters
page
integer
Results are paginated.
Headers
Authorization
string
Auth token
[
{
"id": 1,
"customer_id": null,
"currency": "USD",
"transaction_id": "ch_EbQTtKjku1fMQJ",
"created_at": "2019-02-26T16:37:51.829-05:00",
"updated_at": "2019-02-26T16:37:51.829-05:00",
"payable_type": "Order",
"payable_id": null,
"sub_total_cents": 2995,
"tax_cents": 0,
"total_cents": 2995,
"paid": true,
"attempts": 0,
"payment_method": "stripe",
"tax_type": "no_tax",
"tax_rate": null
},
{
"id": 1744,
"customer_id": 1972,
"currency": "USD",
"transaction_id": "ch_G0HvNO6YQLdvT9",
"created_at": "2019-10-16T14:35:44.049-04:00",
"updated_at": "2019-10-16T14:35:44.049-04:00",
"payable_type": "Subscription",
"payable_id": 40,
"sub_total_cents": 2900,
"tax_cents": 0,
"total_cents": 2900,
"paid": true,
"attempts": 0,
"payment_method": "stripe",
"tax_type": "no_tax",
"tax_rate": null
}
]
Show Payment
GET
https://yoursite.mavenseed.com/api/v1/payments/:id
Retrieve a single payment
Headers
Authorization
string
Auth token
{
"id": 1745,
"customer_id": 1973,
"currency": "USD",
"transaction_id": "ch_G0JWRJXBLJ0VEF",
"created_at": "2019-10-16T16:14:47.103-04:00",
"updated_at": "2019-10-16T16:14:47.103-04:00",
"payable_type": "Subscription",
"payable_id": 41,
"sub_total_cents": 2900,
"tax_cents": 0,
"total_cents": 2900,
"paid": true,
"attempts": 0,
"payment_method": "stripe",
"tax_type": "no_tax",
"tax_rate": null
}
Create Payment
POST
https://yoursite.mavenseed.com/api/v1/payments
Create a payment.
Headers
Authorization
string
Auth Token
Request Body
customer_id
integer
ID of customer to attach the payment to
currency
string
Defaults to USD
transaction_id
string
Typically the Stripe charge id
payable_type
string
Subscription, Order
payable_id
integer
ID of the Subscription or Order
sub_total_cents
integer
Sub total in cents
tax_cents
integer
Tax amount in cents
total_cents
integer
Total amount in cents
paid
boolean
Whether or not the payment is paid
attempts
integer
Attempts made to pay this payment
payment_method
integer
0 - stripe, 1 - manual
tax_type
string
0 - no_tax, 1 - sales, 2 - vat
tax_rate
number
tax rate if tax_type is set as vat
{
"id": 1745,
"customer_id": 1973,
"currency": "USD",
"transaction_id": "ch_G0JWRJXBLJ0VEF",
"created_at": "2019-10-16T16:14:47.103-04:00",
"updated_at": "2019-10-16T16:14:47.103-04:00",
"payable_type": "Subscription",
"payable_id": 41,
"sub_total_cents": 2900,
"tax_cents": 0,
"total_cents": 2900,
"paid": true,
"attempts": 0,
"payment_method": "stripe",
"tax_type": "no_tax",
"tax_rate": null
}
Update Payment
PATCH
https://yoursite.mavenseed.com/api/v1/payments/:id
Update a single payment. All of the above properties in create payment are valid.
Headers
Authorization
string
Auth token
{
"id": 1745,
"customer_id": 1973,
"currency": "USD",
"transaction_id": "ch_G0JWRJXBLJ0VEF",
"created_at": "2019-10-16T16:14:47.103-04:00",
"updated_at": "2019-10-16T16:14:47.103-04:00",
"payable_type": "Subscription",
"payable_id": 41,
"sub_total_cents": 2900,
"tax_cents": 0,
"total_cents": 2900,
"paid": true,
"attempts": 0,
"payment_method": "stripe",
"tax_type": "no_tax",
"tax_rate": null
}
Delete a Payment
DELETE
https://yoursite.mavenseed.com/api/v1/payments/:id
Delete a payment.
Headers
Authorization
string
Auth toke
Last updated
Was this helpful?