/

Create cashier session

OMNO API Documentation (2.0.0)

Download OpenAPI description

openapi_final_casefixed.json

openapi_final_casefixed.yaml

Overview

E-mail support@omno.com

Servers

Mock server

https://omno-api.redocly.app/_mock/openapi_final_casefixed/

Production

https://api.omno.com/

Sandbox

https://api.stagingsseu.com/

Cashier

Cashier API

Operations

Update cashier session balance

Request

Updates cashier session balance for customer.

Path

sessionIdstringrequired

Cashier Session ID

curl -i -X PUT \
  'https://omno-api.redocly.app/_mock/openapi_final_casefixed/public/cashier/session/{sessionId}/balance' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Cashier session balance updated

Response

No content

Create cashier session

Request

Creates cashier session for customer.

Bodyapplication/jsonrequired

Create Cashier Request

customerobject(CustomerRequest)required

Customer information

customer.externalUserIdstringrequired

Your defined unique identifier for this customer.

Example: "example_externaluserid"

customer.firstNamestringrequired

Customer first name

Example: "example_firstname"

customer.lastNamestringrequired

Customer last name

Example: "example_lastname"

customer.emailstringrequired

Customer email

Example: "example_email"

customer.phoneNumberstringrequired

Customer phone number

Example: "example_phonenumber"

customer.dateOfBirthstring(date)required

Customer date of birth

Example: "example_dateofbirth"

customer.billingobject(CustomerBilling)required

Customer billing information

customer.billing.addressstringrequired

Customer billing address

Example: "example_address"

customer.billing.citystringrequired

Customer billing city

Example: "example_city"

customer.billing.statestringrequired

Customer billing state

Example: "example_state"

customer.billing.countryCodestringrequired

Customer billing country code (ISO 3166-1 alpha-2). Ex: GE for Georgia

Example: "example_countrycode"

customer.billing.postalCodestringrequired

Customer billing postal code

Example: "example_postalcode"

returnUrlsobject(ReturnUrls)required

returnUrls.successstringrequired

Url where user will be redirected after successful transaction.

Example: "example_success"

returnUrls.failurestringrequired

Url where user will be redirected after failed transaction.

Example: "example_failure"

currencystringrequired

Currency for the cashier session, in which all payin/payout transaction will be created

Example: "example_currency"

kycVerifiedbooleanrequired

Whether or not this customer is KYC verified in your system.

Example: true

previousTransactionCountinteger(int32)required

Number of previous transactions in different payment system.

Example: 0

balancenumber

Current balance of the customer. Balance will be shown on withdrawal widget.

Example: 0

curl -i -X POST \
  https://omno-api.redocly.app/_mock/openapi_final_casefixed/public/cashier/session \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "customer": {
      "externalUserId": "example_externaluserid",
      "firstName": "example_firstname",
      "lastName": "example_lastname",
      "email": "example_email",
      "phoneNumber": "example_phonenumber",
      "dateOfBirth": "example_dateofbirth",
      "billing": {
        "address": "example_address",
        "city": "example_city",
        "state": "example_state",
        "countryCode": "example_countrycode",
        "postalCode": "example_postalcode"
      }
    },
    "returnUrls": {
      "success": "example_success",
      "failure": "example_failure"
    },
    "currency": "example_currency",
    "kycVerified": true,
    "previousTransactionCount": 0,
    "balance": 0
  }'

Responses

Cashier session created

Bodyapplication/json

sessionIdstringrequired

Session ID

Example: "example_sessionid"

checkoutUrlstringrequired

Checkout URL

Example: "example_checkouturl"

Response

application/json

{
  "sessionId": "example_sessionid",
  "checkoutUrl": "example_checkouturl"
}

PayIn

PayIn API

Operations

Payout

Payout API

Operations