Initiate an independent credit

Credits a customer's card with no original transaction — the cash-register equivalent of a payout.

Sits alongside POST /ecr/{serialNumber}/payment/{paymentId}/refund, which reverses a payment you already took; this one has no original transaction and therefore no payment id.

Requires API version 1.19 or higher; earlier versions return 404.

Available on NexGo terminals only; Newland terminals return 501. The credit must be enabled for the account (KYC setting "Independent Credit") and is checked against a per-transaction limit and the account balance before the terminal is contacted, so a decline costs no terminal interaction.

referenceId is required here and acts as the idempotency key: a second call using a referenceId this terminal has already credited returns that first credit and its current status rather than crediting the card again. A new credit needs a new referenceId, including after a decline.

If the card is credited but the status read that follows it fails, the call still answers 200 with the paymentId and status: IN_PROGRESS instead of an error — poll GET /ecr/{serialNumber}/payment/{paymentId} for the outcome.

A credit cannot be reversed: void and refund against it return 400.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
string
required

Your Payrexx instance name

Body Params
integer
required

Amount to credit, in cents. Must be positive.

string

ISO 4217 alpha-3. Defaults to the terminal's configured currency. CHF only.

string

Optional free-text descriptor for the transaction. API version 1.18 and later; up to version 1.17 this field is called transactionDescriptor.

string

CARD only for now.

string
required

Your own reference for this credit, and the idempotency key for this endpoint. Repeating the call with a referenceId this terminal has already used returns that first credit instead of taking a second one, so a retry after a lost response is safe. A new credit needs a new referenceId, including after a decline. Passed on to the terminal provider as the client transaction id.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json