Skip to main content
Tx authorization
This API MUST be implemented by the Partner. Platform’s backend will check for fund availability and business rules before processing a transaction.
Our backend will consume this service by performing a POST request to: [Base-URL]/TxAuthorization.
The path must be respected exactly as specified. The Partner defines only the [Base-URL]; the resource segment /TxAuthorization, 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.
Expected behavior: Authorization request to process a funds transaction between two parties (Sender and Recipient). The partner will internally validate the balance, limits, and compliance rules (e.g., AML, Velocity), responding whether the operation is Authorized (accompanied by a TrackingIdentifier) or denied for a specific reason in NonAuthorizedReason.

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 the request, used as an idempotency key. It is derived deterministically from the operation, the Partner and the action, so a retry of the same action arrives with the same value: the Partner MUST process it only once and return the original outcome on repeats.

SenderPersonalData
object
required

Personal Data of the sender of the transaction. For this role the address is always complete: Address1, City and ZipCode are guaranteed to be present in addition to CountryCode and StateCode.

ReceiverPersonalData
object
required

Personal Data of the Person where the funds of the transaction are destined. For this role at least one of PhoneNumber or Email is present, but the address may be partial: only CountryCode and StateCode are guaranteed — Address1, City and ZipCode may be absent.

Amount
number<double>
required

Amount of the transaction, with TWO decimals.

Currency
string
required

Currency of the transaction, per ISO 4217. String of 3 chars.

ExchangeRate
number<double>
required

Exchange rate applied to the transaction.

AccountIdentifier
string

An Id representing the External Account Object for the Partner. This field will be Null if Leap Financial does not have an External Account Object already associated.

TrackingNumber
string

Optional tracking number for the transaction, sent only when configured for the Partner.

Response

200 - application/json

Ok

Authorized
boolean
required

True if the Transaction is Authorized / False if it is not Authorized.

TrackingIdentifier
string
required

Identifier assigned by the Partner to this authorization. The Platform stores it and sends it back in the AuthTrackingIdentifier field of Credit Funds so the Partner can tie the credit to the authorization that preceded it.

AccountIdentifier
string

The Id representing the External Account Object for the Partner that was referenced in the request. Null or empty if the Account is not found in the Partner systems. If Null or empty, Authorized will be ignored.

DisplayName
string

A String with the displayName for the Account, to be presented to the end-user. Max 10 characters, only these chars -> [-_a-zA-Z0-9]. If Null, empty or invalid, it will be Partner Prefix (configured in backend) + last four Account numbers (e.g. PRTN-0141).

NonAuthorizedReason
enum<string>

If the Transaction is not Authorized, the reason should be sent, otherwise not sent. The text must be one of the fixed possible values.

  • None — no reason; the transaction was not denied for any of the reasons below
  • AccountBlocked — the transaction has been denied because the external account object is blocked
  • AccountBlockedByLaw — the transaction has been denied because the external account object is blocked by legal reasons (e.g. litigation)
  • AccountBlockedByGovernment — the transaction has been denied because the external account object is blocked due to government mandated reasons (e.g. fiscal)
  • ByVelocity — the transaction has been denied because the external account object has reached the velocity limit defined in the Partner, this is, the amount of transactions in a specific lapse of time allowed by the partner
  • ByAmountLimit — the transaction has been denied because the external account object has reached the transaction amount limit defined in the Partner system
  • ByAccumulateAmountLimit — the transaction has been denied because the external account object has reached the accumulated amount limit defined in the Partner system
  • InvalidAccount — the transaction has been denied because the account referenced is invalid
  • InvalidParameter — the transaction has been denied because a parameter of the request is invalid
  • InvalidCurrency — the transaction has been denied because the currency of the request is invalid
  • InvalidSenderData — the transaction has been denied because the sender's personal data is invalid
  • InvalidDestinationData — the transaction has been denied because the receiver's personal data is invalid
  • InvalidExchangeRate — the transaction has been denied because the exchange rate provided is invalid
  • InvalidAmount — the transaction has been denied because the amount is invalid
  • NonMatchingCurrencyAccount — the transaction has been denied because the currency does not match the account's currency
Available options:
None,
AccountBlocked,
AccountBlockedByLaw,
AccountBlockedByGovernment,
ByVelocity,
ByAmountLimit,
ByAccumulateAmountLimit,
InvalidAccount,
InvalidParameter,
InvalidCurrency,
InvalidSenderData,
InvalidDestinationData,
InvalidExchangeRate,
NonMatchingCurrencyAccount,
InvalidAmount