Amount Fields: submittedAmount and authAmount
Description
submittedAmount and authAmount fields are used to handle amounts in currency conversion scenarios. They ensure the system can process both the source and target amounts correctly, especially when foreign exchange (FX) is involved.
"submittedAmount": { "value": 0, "currency": "string" }
"authAmount": { "value": 0, "currency": "string" }
Purpose of Each Field
| Object | Description |
|---|---|
submittedAmount | The amount provided by the initiator in the source currency (the currency to be debited) |
authAmount | The amount to be delivered in the target currency (the currency to be credited) |
This separation is necessary for FX operations. Depending on your business logic:
Filling in the the four fields of these two objects give us the ability to support multiple business cases:
Case | Description | Sender | Receiver |
|---|---|---|---|
Case 1 | I want to send money without the Currency Exchange. KZT -> KZT | KZT 10,000.00 | KZT 10,000.00 |
Case 2 | Sender wants to send exact amount in KZT and receive X in USD | KZT 10,000.00 | USD X |
Case 2 | Sender wants a Receiver to get exact amount in USD, sending X KZT | KZT X | USD 20.00 |
Depending on the business case, you need to fill in the amount objects correctly:
There are 2 mandatory amount objects, but the platform will expect to get not all four fields in this objects, but only three and they will depend on the business case
| Property | Case 1 | Case 2 | Case 3 |
|---|---|---|---|
| submittedAmount.value | 10,000.00 | 10,000.00 | -- |
| submittedAmount.currency | KZT | KZT | KZT |
| authAmount.value | -- | -- | 20.00 |
| authAmount.currency | KZT | USD | USD |
Constraints
- Currency (currency): Always required in both objects. Use ISO 4217 codes in uppercase (e.g., KZT, USD, EUR).
- Value (value): Provide a non-zero value in only one of the objects in the request.
Updated 11 days ago