Register reconciliation

/reseller/register_reconciliation

Target audience: Developers

Register reconciliation¶

Introduction¶

This endpoint allows Resellers of Payway to register a reconciliation payment on a given order.

URI¶

Environment	URI
Stage	https://payway-api.stage.adeprimo.se/external/api/v1/reseller/register_reconciliation
Production	https://backend.worldoftulo.com/external/api/v1/reseller/register_reconciliation

Requirements¶

Identity	Scope
No	`/external/reseller/w`

Parameters¶

Name	Type	Description
order_id	String	The ID of the order that the reconciliation should be registered for
payment_amount	Float	The full amount of the reconciliation payment
payment_date	DateTime	The date that the reconciliation payment has been received by the customer
payment_reference	String	A free-text reference that should be appended to the payment
payment_message	String	A free-text message that should be appended to the payment
client_info	Object	Object containing information about the client that has submitted the request
user_agent	String
language	String
ip_address	String

Curl Example¶

curl --request POST \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/reseller/register_reconciliation \
  --header 'accept: application/json' \
  --header 'authorization: Bearer token' \
  --header 'content-type: application/json' \
  --data '{
            "order_id": "ADEPRIMO-1",
            "payment_amount": 100.0,
            "payment_date": "2025-01-01T00:00:00",
            "payment_reference": "REF-123",
            "payment_message": "Test Payment",
            "client_info": {
                "user_agent": "Google Chrome",
                "language": "sv-SE",
                "ip_address": "127.0.0.1"
            }
          }'

Response¶

Successful response¶

HTTP 201 Created

{
    "id": "64623c3017c0f863e8997e2d"
}

Errors¶

This API uses the common error conventions of the Payway API

See common error responses