Skip to navigation
API OverviewPayments

Create a charge

View as Markdown

Create a durable charge attempt from the card and security-code references returned by collection events. Supply an optional Idempotency-Key to make charge admission safely replayable. Without one, retrying the request can create another charge attempt. Select any seven-digit Nedarim terminal number except 7005838, which the vault reserves for explicitly enabled non-production ILS 1 tests. When supplied, the idempotency record stores a fingerprint of validated non-sensitive charge fields and the sanitized HTTP result, not the request body, card digits, or security code. A charge can be attempted only while the Session remains connected. After disconnect, the call-scoped card and security-code references are no longer usable. The Gateway stores only safe metadata and never receives card digits, a security code, provider credentials, or raw provider details. A provider timeout or uncertain submission is terminally reported as indeterminate and is never automatically submitted again.

See the generated payment.* webhook operations for complete payload schemas and examples.

Authentication

AuthorizationBearer

Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.

Path parameters

uuidstringRequired

Session identifier.

Headers

Idempotency-KeystringOptionalformat: "^[a-zA-Z0-9._-]*$"<=128 characters
Optional key for safely replaying charge admission. Use one unique key per logical charge and reuse it for retries.
Operation-IdstringOptionalformat: "uuid"

optional client-supplied lowercase RFC-4122 v4 UUID returned as operation_uuid; platform generates one when omitted; correlation metadata distinct from Idempotency-Key.

Request

This endpoint expects an object.
amountdoubleRequired
Charge amount in whole ILS units.
card_uuidstringRequired

Card reference starting with card_, returned by payment.card.collected. Use the complete returned value.

categorystringRequired<=128 characters

Merchant transaction category, forwarded to Nedarim as Groupe. May be empty. Required so the caller supplies it explicitly.

currencyenumRequired
Allowed values:
customer_addressstringRequired<=128 characters

Customer address, forwarded to Nedarim as Adresse. May be empty, subject to the same fraud check as customer_name.

customer_namestringRequired<=128 characters

Customer name, forwarded to Nedarim as ClientName. May be empty, but Nedarim’s fraud check rejects data-center charges without a real value.

cvv_uuidstringRequired

Security-code reference starting with cvv_, returned by payment.cvv.collected. Use the complete returned value.

exp_monthintegerRequired1-12
exp_yearintegerRequired2000-9999
providerenumRequired
Allowed values:
terminal_numberstringRequiredformat: "^[0-9]{7}$"

Seven-digit Nedarim Mosad terminal number for this charge.

customer_emailstringOptional<=128 characters

Optional customer email, forwarded to Nedarim as Mail.

customer_phonestringOptional<=128 characters

Optional customer phone, forwarded to Nedarim as Phone.

notestringOptional<=128 characters

Optional free-text note, forwarded to Nedarim as Avour.

Response headers

traceparentstringOptionalformat: "^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$"=55 characters

Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. A valid incoming traceparent is linked to, but never becomes, the server-owned trace identifier.

Response

Command accepted for async execution
operation_uuidstring
statusenum
Allowed values:
already_endedtrueOptional

Optional. Set to true on idempotent terminal commands when the session was already in a terminal state at the time the request was received. Absent otherwise.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
406
Not Acceptable Error
409
Conflict Error
413
Content Too Large Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error