Mobile SDK Authentisierung
1 About 1cs Mobile SDK Authentication
1.1 General information about 1cs Mobile SDK Authentication
2 1cs Online Payment System interface
1 About 1cs Mobile SDK Authentication
1.1 General information about 1cs Mobile SDK Authentication
This document describes the First Cash Solution SDK authentication method and the corresponding parameters for the request and the responses passed back. If a merchant develops an app of its own, this method is necessary so that secure authentication takes place via the First Cash Solution interface, independently of the app. The authentication is based on a one-off token that is exchanged between First Cash Solution and the merchant.
Further information about integration of the SDK can be found within GitHub repository at https://github.com/Computop.
1.2 Process flow chart
Process flow Mobile SDK Authentication
2 1cs Online Payment System interface
2.1 Definitions
2.1.1 Data formats
Format | Description |
a | alphabetical |
as | alphabetical with special characters |
n | numeric |
an | alphanumeric |
ans | alphanumeric with special characters |
ns | numeric with special characters |
bool | boolean expression (true or false) |
3 | fixed length with 3 digits/characters |
..3 | variable length with maximum 3 digits/characters |
enum | enumeration of allowed values |
dttm | ISODateTime (YYYY-MM-DDThh:mm:ss) |
2.1.2 Abbreviations
Abbreviation | Description | Comment |
CND | condition | |
M | mandatory | If a parameter is mandatory, then it must be present |
O | optional | If a parameter is optional, then it can be present, but it is not required |
C | conditional | If a parameter is conditional, then there is a conditional rule which specifies whether it is mandatory or optional |
Notice: Please note that the names of parameters can be returned in upper or lower case.
2.2 Mobile SDK authentication process
High level process overview:
1. Mobile SDK creates authentication request to merchant’s URL endpoint
2. Merchant’s URL endpoint generates AuthToken and AuthLabel
3. Merchant’s URL endpoint calls First Cash Solution interface with below defined parameters
4. Merchant’s URL endpoint receives First Cash Solution response
5. Merchant’s URL endpoint responds to Mobile SDK authentication request
For the authentication request, the merchant’s endpoint should accept a POST request with Content-Type: application/json and a JSON body like this:
{
"merchantID": <1cs_MerchantID>
}
The Mobile SDK expects a JSON object as response from merchant’s endpoint, so merchant’s endpoint needs to create a JSON object with attributes from the response and also the generated AuthToken and AuthLabel like this:
{
"AuthToken“: <generated_token>,
"AuthLabel": <generated_label>,
“ExpiryDate”: <expiry_date_of_token>
"Description": <description_from_computop_response>,
"Status": <status_from_computop_response>,
"Code": <code_from_computop_response>
}
2.2 Calling the interface
In order to register a one-off token for encryption the 1cs Online Payment System, the merchant must transmit the following parameters to First Cash Solution via a server-to-server connection. Enter the following URL to do this:
Notice: For security reasons, the 1cs Online Payment System rejects all payment requests with formatting errors. Therefore please use the correct data type for each parameter.
The following table describes the encrypted payment request parameters:
Parameter | Format | CND | Description |
MerchantID | ans..30 | M | MerchantID, assigned by First Cash Solution. Additionally this parameter has to be passed in plain language too. |
AuthToken | an16..56 | M | Unique token generated by merchant which is used to decrypt the payment request |
AuthLabel | an32..64 | M | Identifier for the AuthToken used to decrypt the payment request |
ExpiryDate | dttm | O | End time of token validity. The maximum period of validity amounts 24 hours. If the value is not specified the token expires after 15 minutes by default. |
Parameters for authentication request
The following table shows the 1cs Online Payment System response parameters:
pls. be prepared to receive additional parameters at any time and do not check the order of parameters
the key (e.g. MerchantId, RefNr) should not be checked case-sentive
Parameter | Format | CND | Description |
MID | ans..30 | M | MerchantID, assigned by First Cash Solution |
Status | a..30 | M | OK (URLSuccess) or FAILED (URLFailure) |
Description | ans..1024 | M | Further details in the event that payment is rejected. Please do not use the Description but the Code parameter for the transaction status analysis! |
Code | n8 | M | Error code according to the 1cs Online Payment System Response Codes Excel file |
ExpiryDate | dttm | M | End time of token validity. The maximum period of validity amounts 24 hours. If the value is not specified the token expires after 15 minutes by default. |
Response parameters for authentication request