FAQ
-
As I understand, a Bearer token should be used for API requests. What is the URL to obtain an Okta token?
To obtain an Okta token, you can use the following URL for the test environment: https://login.dev.circlek.eu/oauth2/aus4rsuc5khAjfflB0x7/v1/token
-
What is serviceProviderReference, and where can I find it?
serviceProviderReference is the identification number of your company in Circle K systems and you should receive this during the integration phase. In case you did not recieve serviceProvider please contact Circle K.
-
What is siteReference, and where can I find it?
Your company might have several sites, for example, a few parking lots. SiteReference is the identification number of one of your company’s sites in Circle K systems. You should receive this during the integration phase, and it can typically be found in the information provided to you during that process. In case you did not recieve SiteReference please contact Circle K.
-
Are all fields required in siteIdentification, and is it acceptable to set them all to null?
The siteIdentification section requires fields only if you need to provide an alternativeSiteName. When no alternativeSiteName is necessary, setting all fields to "null" is acceptable.
-
What is my paymentMethodId, and where can I find it?
You should receive your paymentMethodId during the integration phase. In case you did not recieve paymentMethodId please contact Circle K.
-
What is the meaning of numberOfTrans and totalAmount in the /serviceProviders/{serviceProviderReference}/sites/{siteReference}/batches/{batchReference} request?
The numberOfTrans represents the count of both "sale" and "refund" transactions, while totalAmount signifies the cumulative amount of both "sale" and "refund" transactions.
-
What should be aggregated in the "total" and "count" counters for the "transaction" and "payment" sections in batches?
For the "transaction" section:
total - sum of amounts for "sale" transactions
count - total number of "sale" transactions
For the "payment" section:
total - sum of amounts for "refund" transactions
count - total number of "refund" transactions
-
Transaction.lineItems issuingCurrency and supplyingCurrency - is it ok, that they contain the same data?
Yes
-
Refund transaction amounts in reconciliation requests - are these values positive? So when we have in a batch 100€ purchase and 10€ refund transactions, should deliveryNotes.paymentMethod.homeCurrency.totalAmount contain 110€?
In Acquirer Batch Reconciliation you will have separate field: transaction.total - as a sum of transactions and payment.total as a sum of revoke transactions.
In Pos Batch Reconciliation it will be 90 €. A real value of transaction. -
What exactly is stan? How it is different from posStan? How should I set those fields?
stan is short for Systems Trace Audit Number - value is required and it is used for better requests tracking - which means it should be unique (for whole acquirer or acquirer Point of Sale - for posStan).
-
Is refund the same thing as reversal?
No, reversal is a separate endpoint and it is related to authorization. It is used to "cancel" the authorization and release the funds on the card.
refund, however is one of two possible values (the other one is purchase) of type field in the transaction-capture endpoint. refund request is used to return funds to the card. -
How the refund request should look like?
refund request looks almost exactly the same as typical transaction-capture request except for the type field. For standard transaction the type field has value of purchase but in this case, when a refund is to be made to the card, the type field have to has value of refund. Depending on the configuration, refund request may (but doesn't have to) require authorization.
-
How can I perform POS reconciliation with refund?
POS reconciliation requires only two fields when it comes to the information about transactions. numberOfTrans is a number of total transaction request either it is purchase or refund. totalAmount is a total value of all purchases minus all refunds. So basically it looks like this:
numberOfTrans = transactions(purchase) + transaction(refund)
totalAmount = transaction( purchase) - transaction(refund)
-
How can I perform Acquirer reconciliation with refund?
In order to perform Acquirer reconciliation with refund it is required to fill four fields in request in summary object :
transaction.total - total amount of all transactions with payment type in batch
transaction.count - total count of all transactions with payment type in batch
payment.total - total amount of all transactions with refund type in batch
payment.count - total count of all transactions with refund type in batch
-
What if reconciliation fail? Should I retry the request?
No, if reconciliation request fail (either aquirerer or site) it is most likely in status Failed to close and it should be closed manually. In that case please contact Circle K local Business Unit to clarify any inconsistencies that have arisen
-
Is authorization required before performing refund?
It depends on configuration
-
Is authorization.token required before performing refund?
It depends on configuration
-
In /transactions endpoint what should be the value of the type field if I want to perform refund?
"type": "refund"
-
If I provide the same transactionReference when making a refund, will the amount of the original transaction be refunded?
No, refund is a new transaction and it is not connected in any way to transactions wit purchase type. transactionReference has to be always unique.
-
Should I use negative values in “amount” fields?
No, all “amount” fields should have positive values.