An overview of the typical use case to add a payment for an order with an omnichannel payment method.
In case of Omnichannel payments, you can provide information about a payment which was received e.g. in one of your physical stores via this API to balance open positions.
When adding a payment, the following process steps will take place:
To add a payment, make a POST /accounting/{version}/businesses/{businessCode}/customers/{customerNumber}/orders/{orderReference}/payments
request, where {businessCode}
is the ID of the related business entity, {customerNumber}
is the identifier of the affected customer and {orderReference}
is the reference of the order where to add the payment to.
For more information, please refer to the related endpoint description within the API Explorer.
POST /accounting/v1/businesses/1000/customers/TFI2021072801/orders/ODE12345678901/payments HTTP/1.1
Host: api-uat.accounting.riverty.io
X-Subscription-Key: YOUR_API_SUBSCRIPTION_TOKEN
Content-Type: application/json
{
"authorizedAmount": 5.00,
"paymentProvider": "ACME Payment Services"
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"internalRequestId": "23c9579b-baaf-468f-a529-f876226e183c"
}