Create reconciliation

post

https://sandbox.numeral.io/v1/reconciliations

Create a reconciliation by matching a transaction with a payment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

At least one of transaction_id or payment_id must be provided. Providing both reconciles the transaction with the payment. Providing only one (on an unreconciled object) excludes that object from reconciliation (reconciliation_status = excluded).

transaction_id

string

The ID of the transaction to be reconciled. If empty and the payment is unreconciled (reconciliation_status = unreconciled), will exclude the payment from reconciliation (reconciliation_status = excluded).

payment_id

string

The ID of the payment_order, incoming_payment, return, expected_payment or payment_capture to be reconciled. If empty and the transaction is unreconciled (reconciliation_status = unreconciled), will exclude the transaction from reconciliation (reconciliation_status = excluded).

amount

int32

The amount of the reconciliation, in the related payment and transaction currency’s smallest unit. For euro, the smallest unit is cents. €20 is represented as 2000. If unspecified, the system will try to create a reconciliation with the maximum amount possible. It must be left empty if payment_id is empty.

metadata

object

Additional client data in JSON format. See Metadata.

Headers

Idempotency-Key

string

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

415Unsupported Media Type.