Skip to content
Payments API
/
Cashier

OMNO API Documentation (2.0.0)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
E-mail

support@omno.com

Languages
Servers
Production

https://api.omno.com/

Sandbox

https://api.omno.dev/

Cashier

Cashier API

Operations

Update cashier session balance

Request

Updates cashier session balance for customer.

Security
bearerAuth
Path
sessionIdstringrequired

Cashier Session ID

Example: 944732c4608c441aa91379478b91f76e
curl -i -X PUT \
  https://api.omno.com/public/cashier/session/944732c4608c441aa91379478b91f76e/balance \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Cashier session balance updated

Response
No content

Create cashier session

Request

Creates cashier session for customer.

Security
bearerAuth
Bodyapplication/jsonrequired

Create Cashier Request

customerobject(CustomerRequest)required

Customer information

customer.​externalUserIdstringrequired

Your defined unique identifier for this customer.

Example: "123456789"
customer.​firstNamestringrequired

Customer first name

Example: "John"
customer.​lastNamestringrequired

Customer last name

Example: "Doe"
customer.​emailstringrequired

Customer email

Example: "john.doe@example.com"
customer.​phoneNumberstringrequired

Customer phone number

Example: "1 1234567890"
customer.​dateOfBirthstring(date)required

Customer date of birth

Example: "1990-12-01"
customer.​billingobject(CustomerBilling)required

Customer billing information

customer.​billing.​addressstringrequired

Customer billing address

Example: "123 Main St"
customer.​billing.​citystringrequired

Customer billing city

Example: "Atlanta"
customer.​billing.​statestringrequired

Customer billing state

Example: "GA"
customer.​billing.​countryCodestringrequired

Customer billing country code (ISO 3166-1 alpha-2)

Example: "US"
customer.​billing.​postalCodestringrequired

Customer billing postal code

Example: "30308"
customer.​kycobject(CustomerKyc)

Customer KYC information

returnUrlsobject(ReturnUrls)required

Return URLs after transaction is finished.

returnUrls.​successstringrequired

Url where user will be redirected after successful transaction.

Example: "https://example.com/success"
returnUrls.​failurestringrequired

Url where user will be redirected after failed transaction.

Example: "https://example.com/failure"
currencystringrequired

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

Example: "USD"
kycVerifiedbooleanrequired

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

Example: false
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: 100
curl -i -X POST \
  https://api.omno.com/public/cashier/session \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "customer": {
      "externalUserId": "123456789",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phoneNumber": "1 1234567890",
      "dateOfBirth": "1990-12-01",
      "billing": {
        "address": "123 Main St",
        "city": "Atlanta",
        "state": "GA",
        "countryCode": "US",
        "postalCode": "30308"
      },
      "kyc": {
        "idType": "string",
        "idNumber": "string",
        "idCountry": "string",
        "idExpirationDate": "2019-08-24",
        "nationality": "string",
        "countryOfBirth": "string"
      }
    },
    "returnUrls": {
      "success": "https://example.com/success",
      "failure": "https://example.com/failure"
    },
    "currency": "USD",
    "kycVerified": false,
    "previousTransactionCount": 0,
    "balance": 100
  }'

Responses

Cashier session created

Bodyapplication/json
sessionIdstringrequired

Session ID

Example: "944732c4608c441aa91379478b91f76e"
checkoutUrlstringrequired

Checkout URL

Example: "https://checkout.omno.com/payments/cashier/<sessionId>"
Response
application/json
{
  "sessionId": "944732c4608c441aa91379478b91f76e",
  "checkoutUrl": "https://checkout.omno.com/payments/cashier/<sessionId>"
}

PayIn

PayIn API

Operations

Payout

Payout API

Operations