Sign in
Order

Add payment to Order.

Add payment to Orders

post/rest/api/orders/{id}/payment/

Path parameters

idstring required

order number in Apilo system, e.g. <code>AL0012345</code>

Request body

idExternalstring

External payment ID

typeinteger required

<a href='#tag/Order/operation/get_rest_orders_payment_map'>Payment method ID</a>

paymentDatestring date-time nullable required

Date of payment

amountstring nullable required

Amount of payment

commentstring

Example request

{
  "idExternal": "PAY-123456",
  "type": 1,
  "paymentDate": "2022-03-08T20:00:00Z",
  "comment": "Credit card payment"
}

Response

Payment with the given idExternal already exists

{"stackTrail":"paths:/rest/api/orders/{id}/payment/:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 1 revision of this API.