Server-to-server payments

Your PCI server creates the charge. Never put the card or secret key in a browser.

Sandbox and live

Key	Who processes the card
`sk_test_`	The ParuPay sandbox, with the standard test cards. Every merchant.
`sk_live_`	ParuPay live processing, for approved accounts with live server-to-server enabled. Contact support@parupay.com to enable it.

Create

POST /v1/s2s/payments with Authorization: Bearer sk_….

{
  "amount": 1000,
  "currency": "usd",
  "title": "Order 1042",
  "description": "Daypack",
  "customer_name": "Northline Buyer",
  "customer_email": "buyer@example.com",
  "customer_phone": "+971500000000",
  "card": {
    "number": "5555555555554444",
    "exp_month": 5,
    "exp_year": 2029,
    "cvc": "911"
  },
  "metadata": {
    "order_id": "1042",
    "return_url": "https://shop.example/orders/1042",
    "cancel_url": "https://shop.example/cart"
  }
}

This uses the 2D sandbox card. Every test card is on Testing cards.

Field	Required	Notes
`amount`	Yes	Minor units of the currency, greater than 0. 1000 is 10.00 USD; 3-decimal currencies such as KWD use 1000 for 1.000.
`currency`	No	Lowercase ISO code such as usd or aed. Stored on the payment and charged exactly as sent.
`title`	No	Stored on the payment. Used as description if description is omitted.
`description`	No	Shown on the payment.
`customer_name`, `customer_phone`	No	Stored on the payment.
`customer_email`	Yes for 3-D Secure	The payment is attached to this customer (created if new). Sandbox 3-D Secure emails the one-time password here.
`billing_country`	No	Two-letter country of the paying customer, e.g. AE. Shown as the payment country.
`card`	Yes	`number`, `exp_month`, `exp_year`, `cvc`. Sandbox cards are on Testing cards.
`metadata`	No	String key/value pairs, up to 50, keys up to 40 characters, values up to 500. Put your `order_id` here.
`metadata.return_url`	No	Where the customer goes after 3-D Secure.
`metadata.cancel_url`	No	Where the customer goes if they cancel 3-D Secure.

Response

Create returns three fields. 2D includes a charge. 3D includes next_action.

{
  "id": "pi_…",
  "status": "succeeded",
  "charge": "ch_…"
}

{
  "id": "pi_…",
  "status": "requires_action",
  "next_action": {
    "redirect_to_url": {
      "url": "https://pay.parupay.com/s2s/3ds/…"
    }
  }
}

Field	Use it for
`id`	Payment id, prefixed `pi_`. Store it on your order.
`status`	`succeeded` means paid. `requires_action` means send the customer to `next_action`. `requires_payment_method` means the card failed.
`charge`	2D only. Charge id, prefixed `ch_`.
`next_action.redirect_to_url.url`	3D only. Open this URL for 3-D Secure.

Only order_id from metadata is sent back on webhooks.

Read

Request	What it does
`GET /v1/s2s/payments`	Your S2S payments, with status filters.
`GET /v1/s2s/payments/:id`	One payment after 3-D Secure or for support.

Status values are in Payment statuses.

Start

Accept payments

Developers

Server-to-server payments

Sandbox and live

Create

Response

Read