OmanNET
Beta

Last updated: June 7, 2023

Start accepting payments with OmanNET, Oman’s domestic payment network.

For payments processed with OmanNET, you can require your customers to authenticate via a one-time password (OTP) before you complete the payment. Contact your Account Manager for more information.

OmanNET payments follow a two-step process:

You can request a payment using:

a token
a payment instrument
full card details, if you are SAQ D PCI compliant

All payment requests processed through OmanNET are authorized and captured simultaneously. If you need to return funds to the cardholder, you must process a full refund instead.

For the full API specification, see the API reference.

post

https://api.checkout.com/payments


1{
2  "source": {
3    "type": "card",
4    "number": "4837915625977889",
5    "expiry_month": 8,
6    "expiry_year": 2025,
7    "stored": false,
8    "name": "John",
9    "cvv": "806"
10  },
11  "amount": 5,
12  "currency": "OMR",
13  "success_url": "https://www.checkout.com/",
14  "failure_url": "https://www.checkout.com/404",
15  "processing_channel_id": "pc_lmdzwouw4ffenmkzyqenzwske4"
16}

If you receive a 202 Success response with a payment id and a status field set to Pending, your request was successful.


1{
2  "id": "pay_ogvedu6ney7utmcikacddpyeuq",
3  "status": "Pending",
4  "_links": {
5    "self": {
6      "href": "https://gwc.ckotech.co/payments/pay_ogvedu6ney7utmcikacddpyeuq"
7    },
8    "actions": {
9      "href": "https://gwc.ckotech.co/gateway/payments/pay_ogvedu6ney7utmcikacddpyeuq/actions"
10    },
11    "redirect": {
12      "href": "http://tpa-qa.ckotech.co/omannet/payment/9cf244e0-f582-42bf-8578-4e4b333d26d2"
13    }
14  }
15}

Redirect your customer to the redirect.href link from the response. The subsequent steps vary depending on whether you've enabled OTP for authentication.

If you have enabled OTP authentication for payments, your customer will be prompted to authorize the payment via a password. Once they've completed authentication, they will be redirected to the success_url or failure_url you supplied in the payment request.

If you have not enabled OTP authentication, your customer will be redirected to the success_url or failure_url without any further user action required.

Retrieve details about an existing OmanNET payment with the following endpoint:

get

https://api.checkout.com/payments/{id}


1{
2  "id": "pay_artwfmgguv7uvi2wuv6mq4o3mu",
3  "requested_on": "2023-05-10T08:44:24.3754671Z",
4  "source": {
5    "id": "src_baqgk6yhjspe5gpotvpjx72kqe",
6    "type": "card",
7    "expiry_month": 8,
8    "expiry_year": 2025,
9    "name": "John",
10    "scheme": "Visa",
11    "scheme_local": "omannet",
12    "local_schemes": [
13      "omannet"
14    ],
15    "last4": "7889",
16    "fingerprint": "0BD3C37E91933EE417E7205B454E6E4617B1F858B25C15219E6EA7CE1D1EF093",
17    "bin": "483791",
18    "card_type": "DEBIT",
19    "card_category": "CONSUMER",
20    "issuer": "Bank Muscat",
21    "issuer_country": "OM",
22    "product_id": "F"
23    },
24  "amount": 5,
25  "currency": "OMR",
26  "payment_type": "Regular",
27  "status": "Captured",
28  "balances": {
29    "total_authorized": 5,
30    "total_voided": 0,
31    "available_to_void": 0,
32    "total_captured": 5,
33    "available_to_capture": 0,
34    "total_refunded": 5,
35    "available_to_refund": 0
36  },
37  "risk": {
38    "flagged": false
39  },
40  "_links": {
41    "self": {
42      "href": "https://api.checkout.com/payments/pay_artwfmgguv7uvi2wuv6mq4o3mu"
43    },
44    "actions": {
45      "href": "https://api.checkout.com/payments/pay_artwfmgguv7uvi2wuv6mq4o3mu/actions"
46    },
47    "refund": {
48      "href": "https://api.checkout.com/payments/pay_artwfmgguv7uvi2wuv6mq4o3mu/refunds"
49    }
50  }
51}

When using OmanNET, you may receive the following webhooks:

Webhook	Description
`payment_pending`	Occurs when a payment request has successfully initiated.
`payment_declined`	Occurs when a payment request has been rejected.
`payment_capture_pending`	Occurs when the customer has approved the payment on the banking page.
`payment_captured`	Occurs when a capture is successful.
`payment_capture_declined`	Occurs when a capture is declined.
`payment_refund_pending`	Occurs when a refund request has successfully initiated.
`payment_refunded`	Occurs when a refund is successful.
`payment_refund_declined`	Occurs when a refund is declined.

OmanNET only supports full refunds. You can refund a payment through the Dashboard, or by using our refund API.

Create an OmanNET transaction and use the details from one of the test cards.
Follow the redirect link provided in the response.
If an OTP is required to complete the payment, enter the code sent to the email address you configured with your Account Manager. You should then be redirected to your predefined success URL. If an OTP is not required, you will be redirected immediately without an OTP prompt.

Card number	Card type
4837915090070004	OmanNET, co-branded Visa Classic Debit
4837915090073321	OmanNET, co-branded Visa Classic Debit

We've made some changes to our API

OmanNET
Beta

Overview

Request a payment

Request example

Response example

Redirect the customer

Get details about a payment

Response example

Webhooks

Refund a payment

Test OmanNET

Test cards