← Scheduled Merchant-Initiated Transaction scenario Get payer by email →

# Unscheduled Merchant-Initiated scenario

Merchant can initiate payment transaction using stored credentials on a non-fixed schedule and/or using a variable amount. Below, decribes a possible scenario

# Step 1 - Initial payment
- Cardholder decide to open a wallet account with a provider and top-up an initial amount. The cardholder agrees to place their card on file with the merchant and activate the automatic top-ups feature. (When the cardholder balance drops below a certain threshold the account is automatically top-up to a certain amount.)
- The cardholder performs a payment by entering full card details.
- If the merchant is PCI SAQ-D Compliant, he can perform a full card payment else he should perform the payment using a payment-nonce.
- As it is the initial payment, the transaction is initiated by the cardholder. (set the flag merchant_initiated to false).

TIP

For more information on payment using full card details, please refer to this page.
For more information on payment using payment nonce, please refer to this page.

Request example

Shell
JavaScript

curl -X POST \
  https://api.ompay.com/v1/merchants/w3z8dfhkzvfq0j9n/payment \
  -H 'authorization: Basic ODZidWQ0Y2JremlxOXZmYzoweHI1ZDkwOHo2bmo4a2h6' \
  -H 'content-type: application/json' \
  -d '{
		"intent": "auth",
		"merchant_initiated": false,
		"payer": {
			"payment_type": "CC",
			"funding_instrument": {
				"credit_card": {
					"number": "4005520201264821",
					"expire_month": 12,
					"expire_year": 2020,
					"cvv2": "123",
					"name": "Tom Hanks",
				}
			},
			"payer_info": {
				"email": "TomHanks@gmail.com",
				"billing_address": {
					"line1": "18 Avenue",
					"line2": "cassidy",
					"city": "Rose-Hill",
					"country_code": "mu",
					"postal_code": "72101",
					"state": "",
					"phone": {
						"country_code": "230",
						"number": "57976041"
					}
				}
			}
		},
		"payee": {
			"email": "mail@test.com",
			"merchant_id": "w3z8dfhkzvfq0j9n"
		},
		"transaction": {
			"type": 2,
			"amount": {
				"currency": "USD",
				"total": "300",
				"details": {
					"subtotal": "",
					"shipping": ""
				}
			},
			"description": "purchase",
			"items": [{
					"sku": "100299S",
					"name": "Ultrawatch",
					"description": "Smart watch",
					"quantity": "1",
					"price": "500",
					"shipping": "20",
					"currency": "USD",
					"url": "",
					"image": "",
					"tangible": "true"
				},
				{
					"sku": "100269S",
					"name": "Drone",
					"description": "drone x",
					"quantity": "1",
					"price": "500",
					"shipping": "20",
					"currency": "USD",
					"url": "",
					"image": "",
					"tangible": "true"
				}
			],
			"shipping_address": {
				"recipient_name": "Tom Hanks"
			},
			"soft_descriptor": {
				"text": "test.com",
				"city": "london"
			},
			"invoice_number": "123455"
		},
		"custom": {

		},
		"capture_delay": 0.05,
		"metadata": {
			"CMS": "WooCommerce"
		}
	}'

Response example

	{
		"id": "2JHY1CB6CR8N0FZK43WU",
		"reference_id": "2JHY1CB6CR8N0FZK43WU",
		"state": "authorised",
		"result": {
			"authorisation_code": "590622",
			"code": "0000",
			"description": "Approved"
		},
		"intent": "AUTH",
		"payer": {
			"payment_type": "CC",
			"funding_instrument": {
				"credit_card": {
					"id": "20abc6eb-35fd-427e-b57e-c7eea99dd423",
					"type": "Visa",
					"expire_month": 6,
					"expire_year": 2025,
					"name": "Tom Hanks",
					"cvv_check": "Y",
					"avs_check": "S",
					"last4": "9996",
					"bin": "454347",
					"bin_data": {
						"bin": "454347",
						"country_code": "MU",
						"country_name": "Mauritius",
						"bank_name": "MCB",
						"card_scheme": "Visa",
						"card_type": "Credit",
						"card_category": "1"
					}
				}
			},
			"payer_info": {
				"id": "35d4d1ec-4f9d-416d-acdc-d12f4bf0c6df",
				"email": "tomhank@gmail.com",
				"name": "Tom Hanks",
				"billing_address": {
					"phone": {
						"country_code": "230",
						"number": "57976041"
					},
					"line1": "18 Avenue",
					"line2": "cassidy",
					"city": "Rose-Hill",
					"country_code": "MU",
					"postal_code": "72101",
					"state": ""
				}
			}
		},
		"transaction": {
			"amount": {
				"currency": "USD",
				"total": "300"
			},
			"type": "1",
			"mode": "1",
			"items": [
				{
					"sku": "100299S",
					"name": "Ultrawatch",
					"description": "Smart watch",
					"quantity": "1",
					"price": "500",
					"shipping": "",
					"url": ""
				},
				{
					"sku": "100269S",
					"name": "Drone",
					"description": "drone x",
					"quantity": "1",
					"price": "500",
					"shipping": "",
					"url": ""
				}
			],
			"shipping_address": {
				"phone": {}
			},
			"invoice_number": "123455"
		},
		"custom": {},
		"risk_check": true,
		"three_d": {},
		"create_time": "2023-06-09T18:07:37Z",
		"subscriptions": null
	}

# Step 2 - Save card or card ID

If the merchant is going to perform Merchant-Initiated Transaction, he must save the reference_id for future use.

For PCI SAQ-D merchants, they might choose to save the full card details on their servers.
For non PCI merchants, they might choose to save the Payer details and associated payer.funding_instrument.credit_card.id.
# Step 3 - Recurring payment

Cardholder account drops below a certain amount. An automatic topup is triggered by the merchant to recharge the cardholder account without his interaction.

To initiate subsequent unscheduled merchant initiated transaction, we need to flag the transaction as merchant_initiated by setting its value to true and referencing the initial payment by using the saved reference_id. (payload attribute previous_payment_id:<reference_id>)

Note

For more information on Merchant-Initiated Transaction, please refer to this page.

← Scheduled Merchant-Initiated Transaction scenario Get payer by email →

# Unscheduled Merchant-Initiated scenario

# Step 1 - Initial payment

# Step 2 - Save card or card ID

# Step 3 - Recurring payment