Skip to main content
Get credit status
This API MUST be implemented by the Partner when the credit is applied asynchronously. Platform’s backend will query the status of a previous credit operation.
This endpoint is only required when applying the credit is not immediate. If the Partner applies the credit synchronously — that is, the Credit Funds response already carries the final outcome — that response is sufficient and this endpoint is not implemented at all.Which of the two models applies (the CreditResponseType configuration) must be agreed during the planning phase of the integration, before development starts.
Our backend will consume this service by performing a POST request to: [Base-URL]/GetCreditStatus.
The path must be respected exactly as specified. The Partner defines only the [Base-URL]; the resource segment /GetCreditStatus, the POST method and the JSON body are fixed by this contract and are case-sensitive.Every request travels signed. It carries the X-Timestamp and X-Signature headers with the HMAC-SHA256 signature of the raw body. The Partner must validate the signature before processing the request.
Our backend will perform this request every CreditStatusQueryRepetitionsInMinutes minutes. Expected behavior: Asynchronous query of the status of a previous funds credit order. With the tracking number (CreditTrackingNumber), the partner will report if the credit is in progress (InProgress), approved (Approved), or if it ended in an error (Failed).
Never cache this response. This is the only read-only endpoint of the integration: the Platform is asking for the status right now, and it polls precisely because it expects that status to change. Each poll therefore carries a different TransactionId — it is a correlation identifier for that individual query, not an idempotency key like on the other five endpoints. A Partner that deduplicates by TransactionId here would keep replaying the first InProgress answer, the transition to Approved or Failed would never be observed, and the operation would stay open indefinitely.CreditStatus is mandatory and must be one of InProgress, Approved or Failed. If it is omitted or carries any other value, the Platform rejects the response and the operation stays open.

Headers

X-Timestamp
string
required

UTC timestamp in ISO-8601 format with milliseconds (yyyy-MM-ddTHH:mm:ss.fffZ), generated at send time. Its exact string value is part of the signed message, so it cannot be altered, and it lets the Partner reject stale requests (replay protection). See Data Integrity.

X-Signature
string
required

HMAC-SHA256 signature of the request, Base64-encoded (standard alphabet). It is computed over bytes(X-Timestamp) + bytes(".") + rawBodyBytes using the shared secret agreed for the integration. The Partner MUST validate it — with a constant-time comparison and over the raw body, before any deserialization — and reject the request if it does not match. See Data Integrity.

User-Agent
string
required

Fixed value VNA. Sent on every request. Some Partners' WAFs reject requests without a User-Agent, so the Platform always sets it explicitly; if the Partner filters by this header, this is the value to allow.

Body

application/json
TransactionId
string
required

Unique identifier of this particular query. Unlike the other endpoints, a new value is generated on every poll, because this is a read of current state and not an operation to be deduplicated. The Partner must not use it as a cache key: every call must return the status at that moment.

AccountIdentifier
string
required

An Id representing the External Account Object for the Partner.

CreditTrackingNumber
string
required

The TrackingIdentifier the Partner returned in the Credit Funds response — that is, the identifier of the credit movement being referred to.

Response

200 - application/json

Ok

CreditStatus
enum<string>
required

The status of the credit order.

  • InProgress — the credit is still being processed by the Partner
  • Approved — the credit was applied successfully
  • Failed — the credit ended in an error; see ResponseDescription for details

This field is mandatory. If it is omitted, or carries a value outside the three above, the Platform rejects the response and keeps the operation open.

Available options:
InProgress,
Approved,
Failed
ResponseDescription
string

Additional details about the status, mainly used when CreditStatus is Failed.