Sofort - Custom Integration

INFO

Feature Request

This is an on-demand feature. Please raise a request with our Support team to get this feature activated on your Razorpay account.

to get this feature activated on your account.

Prerequisites

1. Step 1

   Sign up for a Razorpay account.

2. Step 2

   Generate API Keys from the Dashboard.

3. Step 3

   Integrate Razorpay Custom Checkout on your website, Android app or iOS App.

Integrate Sofort on Custom Checkout

• Create an Order.
• Pass method and provider parameters in Create Payment Method.

Create an Order

Order is an important step in the payment process.

1. Step 1

   An order should be created for every payment.

2. Step 2

   You can create an order using the Orders API. It is a server-side API call. Know how to authenticate Orders API.

3. Step 3

   Pass the order_id received in response to the checkout. This ties the Order with the payment and secures the request from being tampered.

API Sample Code

The following is a sample API request and response for creating an order:

Curl

curl -X POST https://api.razorpay.com/v1/orders
-u [YOUR_KEY_ID]:[YOUR_KEY_SECRET]
-H 'content-type:application/json'
-d '{
    "amount": 50000,
    "currency": "INR",
    "receipt": "rcptid_11"
}'
```java: Java
try {
  JSONObject orderRequest = new JSONObject();
  orderRequest.put("amount", 50000); // amount in the smallest currency unit
  orderRequest.put("currency", "INR");
  orderRequest.put("receipt", "order_rcptid_11");

  Order order = razorpay.Orders.create(orderRequest);
} catch (RazorpayException e) {
  // Handle Exception
  System.out.println(e.getMessage());
}
```Python: Python
import razorpay
client = razorpay.Client(auth=("api_key", "api_secret"))

DATA = {
    "amount": 100,
    "currency": "INR",
    "receipt": "receipt#1",
    "notes": {
        "key1": "value3",
        "key2": "value2"
    }
}
client.order.create(data=DATA)
```php: PHP
$order  = $client->order->create([
  'receipt'         => 'order_rcptid_11',
  'amount'          => 50000, // amount in the smallest currency unit
  'currency'        => 'INR'// [See the list of supported currencies](/payments/international-payments#supported-currencies).)
]);
```csharp: .NET
Dictionary options = new Dictionary();
options.Add("amount", 50000); // amount in the smallest currency unit
options.add("receipt", "order_rcptid_11");
options.add("currency", "INR");
Order order = client.Order.Create(options);
```ruby: Ruby
options = amount: 50000, currency: 'INR', receipt: ''
order = Razorpay::Order.create
```javascript: Node.js
var options = {
  amount: 50000,  // amount in the smallest currency unit
  currency: "INR",
  receipt: "order_rcptid_11"
};
instance.orders.create(options, function(err, order) {
  console.log(order);
});
```json: Response
{
    "id": "order_DBJOWzybf0sJbb",
    "entity": "order",
    "amount": 50000,
    "amount_paid": 0,
    "amount_due": 50000,
    "currency": "INR",
    "receipt": "rcptid_11",
    "status": "created",
    "attempts": 0,
    "notes": [],
    "created_at": 1566986570
}

Request Parameters

Here is the list of parameters and their description for creating an order:

amount mandatory : integer The transaction amount, expressed in the currency subunit. For example, for an actual amount of 299.35 , the value of this field should be 29935.

currency mandatory : string The currency in which the transaction should be made. See the list of supported currencies. Length must be 3 characters.

receipt optional : string Your receipt id for this order should be passed here. Maximum length is 40 characters.

notes optional : json object Key-value pair that can be used to store additional information about the entity. Maximum 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

partial_payment optional : boolean Indicates whether the customer can make a partial payment. Possible values:

• true: The customer can make partial payments.
• false (default): The customer cannot make partial payments.

id mandatory : string Unique identifier of the customer. For example, cust_1Aa00000000004.

Know more about Orders API.

Error Response Parameters

The error response parameters are available in the API Reference Guide.

Pass method and provider Parameters During Payment Creation

The following is a sample API to create a payment.

Sofort

razorpay.createPayment({
  "amount": 500,
  "currency": "INR",
  "email": "[e-mail]",
  "contact": 9111145678,
  "order_id": "order_EAbtuXPh24LrEc",
  "method": "app",
  "provider": "sofort"
});

Response

{
  "razorpay_payment_id": "pay_xxxx",
  "next": [
    {
      "action": "poll",
      "url": "https://api.razorpay.com/v1/payments/pay_xxx/status"
    }
  ]
}

Request Parameters

Along with the other checkout options, you must pass:

method mandatory : string The method used to make the payment. Here, it should be app.

provider mandatory if method=app : string Name of the PSP app. Here, it should be sofort.