Payments
An order can have one or more payments linked to it.
These payments can have one of the following states:
- OPEN
- OK
- ERROR
- REFUND
- CBACK
On creation of a payment the default state is 'OPEN'.
Payments can be from different payment methods.
API calls
Endpoint: /payments
Endpoint | Method | Payload |
---|---|---|
/payments/:payment |
GET |
|
/payments | POST |
payment payload |
/payments/:payment |
PUT |
update payment payload |
Payment payload
{
method_id*: (method/id)**,
status*: string,
order_id*: (order/id)**,
amount*: num,
transactionid: nullable|string,
transaction_fee: nullable|float,
transaction_cost: nullable|float,
}
*required ** must exist in table/column
Update payment payload
{
status: nullable|string,
}
*required