OmanNET
Beta
Last updated: October 18, 2023
OmanNET enables customers to perform online payments with their OmanNET debit card.
Information
Depending on your acquirer MID configuration, your customers may be required to authenticate their payments via a one-time password (OTP). Contact your Account Manager for more information about your MID configuration.
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 purchase payments. This means that payments are authorized and captured simultaneously, regardless of the capture
value you pass in your request.
If you need to return funds to the cardholder, you must process a full refund instead.
Warning
3D Secure (3DS) is not applicable to payments made through OmanNET. To avoid unexpected declines, you should explicitly set the 3ds.enabled
field in your payment request to false
.
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"3ds": {12"enabled": false13},14"amount": 5,15"currency": "OMR",16"success_url": "https://www.checkout.com/",17"failure_url": "https://www.checkout.com/404",18"processing_channel_id": "pc_lmdzwouw4ffenmkzyqenzwske4"19}
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://api.checkout.com/payments/pay_ogvedu6ney7utmcikacddpyeuq"7},8"actions": {9"href": "https://api.checkout.com/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 your acquirer MID configuration requires additional authentication, your customer will be prompted for additional information before they can be redirected to the success_url
or failure_url
. They will be redirected to the OmanNET website and prompted for an OTP code to authorize the payment.
If additional authentication is not required, your customer will be redirected directly to the success_url
or failure_url
without any further action from your customer required.
Information
Confirmation of an OmanNET payment is only communicated via webhooks. To receive notifications, set up your webhook receiver.
Regardless of whether you performed OTP authentication or not, you'll receive a payment_captured
webhook when the transaction has completed successfully. Until you receive this webhook, the payment will be labeled as Pending
.
Retrieve details about an existing OmanNET payment with the following endpoint:
Information
If you attempt to retrieve details about a payment that is labeled as Pending
, you'll receive a 404
.
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": 036},37"risk": {38"flagged": false39},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}
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 |
When using OmanNET, you may receive the following webhooks:
Webhook | Description |
---|---|
| Occurs when an asynchronous payment request has successfully initiated. Asynchronous payments require an additional action before the payment can be completed. For example, if the cardholder must be redirected to a payment method-specific checkout page. |
| Occurs when a payment authorization request times out, or is rejected. For example, due to an |
| Occurs when the customer has approved the payment on the banking page. |
| Occurs when a capture is successful. |
| Occurs when a capture is declined. |
| Occurs when a refund request has successfully initiated. |
| Occurs when a refund is successful. |
| Occurs when a refund is declined. |