Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update customer endpoint #308

Merged
merged 4 commits into from
Apr 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
245 changes: 245 additions & 0 deletions documents/customers.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,251 @@ Customer customer = instance.customers.fetch(customerId);

-------------------------------------------------------------------------------------------------------


### Add Bank Account of Customer

```java
String customerId = "cust_N5mywh91sXB69O"

JSONObject customerRequest = new JSONObject();
customerRequest.put("ifsc_code","UTIB0000194");
customerRequest.put("account_number","916010082985661");
customerRequest.put("beneficiary_name","Pratheek");
customerRequest.put("beneficiary_address1","address 1");
customerRequest.put("beneficiary_address2","address 2");
customerRequest.put("beneficiary_address3","address 3");
customerRequest.put("beneficiary_address4","address 4");
customerRequest.put("beneficiary_email","random@email.com");
customerRequest.put("beneficiary_mobile","8762489310");
customerRequest.put("beneficiary_city","Bangalore");
customerRequest.put("beneficiary_state","KA");
customerRequest.put("beneficiary_country","IN");

BankAccount bankaccount = instance.customers.addBankAccount(customerId, customerRequest)
```

**Parameters:**

| Name | Type | Description |
|----------------------|----------|---------------------------------------------------------------|
| customerId* | string | Unique identifier of the customer. |
| account_number | string | Customer's bank account number. |
| beneficiary_name | string | The name of the beneficiary associated with the bank account. |
| beneficiary_address1 | string | The virtual payment address. |
| beneficiary_email | string | Email address of the beneficiary. |
| beneficiary_mobile | integer | Mobile number of the beneficiary. |
| beneficiary_city | string | The name of the city of the beneficiary. |
| beneficiary_state | string | The state of the beneficiary. |
| beneficiary_pin | interger | The pin code of the beneficiary's address. |
| ifsc_code | string | The IFSC code of the bank branch associated with the account. |

**Response:**
```json
{
"id" : "cust_1Aa00000000001",
"entity": "customer",
"name" : "Saurav Kumar",
"email" : "Saurav.kumar@example.com",
"contact" : "+919000000000",
"gstin":"29XAbbA4369J1PA",
"notes" : [],
"created_at ": 1234567890
}
```

-------------------------------------------------------------------------------------------------------

### Delete Bank Account of Customer

```java
String customerId = "cust_N5mywh91sXB69O"

String bankAccountId = "ba_N6aM8uo64IzxHu"

Customer customer = instance.customers.deleteBankAccount(customerId, bankaccountId)
```

**Parameters:**

| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| customerId* | string | Unique identifier of the customer. |
| bankAccountId | string | The bank_id that needs to be deleted. |

**Response:**
```json
{
"id": "ba_Evg09Ll05SIPSD",
"ifsc": "ICIC0001207",
"bank_name": "ICICI Bank",
"name": "Test R4zorpay",
"account_number": "XXXXXXXXXXXXXXX0434",
"status": "deleted"
}
```

-------------------------------------------------------------------------------------------------------

### Eligibility Check API

```java
JSONObject customerRequest = new JSONObject();
customerRequest.put("inquiry","affordability");
customerRequest.put("amount", 500);
customerRequest.put("currency","INR");
JSONObject customer = new JSONObject();
customer.put("id","elig_xxxxxxxxxxxxx")
customer.put("contact","+919999999999")
customer.put("ip","105.106.107.108")
customer.put("referrer","https://merchansite.com/example/paybill")
customer.put("user_agent","Mozilla/5.0")
customerRequest.put("customer",customer);

Customer customer = instance.customers.requestEligibilityCheck(customerRequest)
```

**Parameters:**

| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| inquiry | string | List of methods or instruments on which eligibility check is required. |
| amount* | string | The amount for which the order was created, in currency subunits. |
| currency* | string | A three-letter ISO code for the currency in which you want to accept the payment. |
| customer* | object | Customer details. [here](https://razorpay.com/docs/payments/payment-gateway/affordability/eligibility-check/#eligibility-check-api) |
| instruments | object | Payment instruments on which an eligibility check is required. [here](https://razorpay.com/docs/payments/payment-gateway/affordability/eligibility-check/#eligibility-check-api) |


**Response:**
```json
{
"amount": "500000",
"customer": {
"id": "KkBhM9EC1Y0HTm",
"contact": "+919999999999"
},
"instruments": [
{
"method": "emi",
"issuer": "HDFC",
"type": "debit",
"eligibility_req_id": "elig_xxxxxxxxxxxxx",
"eligibility": {
"status": "eligible"
}
},
{
"method": "paylater",
"provider": "getsimpl",
"eligibility_req_id": "elig_xxxxxxxxxxxxx",
"eligibility": {
"status": "eligible"
}
},
{
"method": "paylater",
"provider": "icic",
"eligibility_req_id": "elig_xxxxxxxxxxxxx",
"eligibility": {
"status": "eligible"
}
},
{
"method": "cardless_emi",
"provider": "walnut369",
"eligibility_req_id": "elig_xxxxxxxxxxxxx",
"eligibility": {
"status": "ineligible",
"error": {
"code": "GATEWAY_ERROR",
"description": "The customer has not been approved by the partner.",
"source": "business",
"step": "inquiry",
"reason": "user_not_approved"
}
}
},
{
"method": "cardless_emi",
"provider": "zestmoney",
"eligibility_req_id": "elig_xxxxxxxxxxxxx",
"eligibility": {
"status": "ineligible",
"error": {
"code": "GATEWAY_ERROR",
"description": "The customer has exhausted their credit limit.",
"source": "business",
"step": "inquiry",
"reason": "credit_limit_exhausted"
}
}
},
{
"method": "paylater",
"provider": "lazypay",
"eligibility_req_id": "elig_xxxxxxxxxxxxx",
"eligibility": {
"status": "ineligible",
"error": {
"code": "GATEWAY_ERROR",
"description": "The order amount is less than the minimum transaction amount.",
"source": "business",
"step": "inquiry",
"reason": "min_amt_required"
}
}
}
]
}
```

-------------------------------------------------------------------------------------------------------

### Fetch Eligibility by id

```java
String eligibilityId = "elig_xxxxxxxxxxxxx"
Customer customer = instance.customers.fetchEligibility(eligibilityId)
```

**Parameters:**

| Name | Type | Description |
|---------------|-------------|---------------------------------------------|
| eligibilityId | string | The unique identifier of the eligibility request to be retrieved. |
rohitcbr marked this conversation as resolved.
Show resolved Hide resolved

**Response:**
```json
{
"instruments": [
{
"method": "paylater",
"provider": "lazypay",
"eligibility_req_id": "elig_xxxxxxxxxxxxx",
"eligibility": {
"status": "eligible"
}
},
{
"method": "paylater",
"provider": "getsimpl",
"eligibility_req_id": "elig_xxxxxxxxxxxxx",
"eligibility": {
"status": "ineligible",
"error": {
"code": "GATEWAY_ERROR",
"description": "The customer has exhausted their credit limit",
"source": "gateway",
"step": "inquiry",
"reason": "credit_limit_exhausted"
}
}
}
]
}
```

-------------------------------------------------------------------------------------------------------

**PN: * indicates mandatory fields**
<br>
<br>
Expand Down
10 changes: 10 additions & 0 deletions src/main/java/com/razorpay/BankAccount.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package com.razorpay;

import org.json.JSONObject;

public class BankAccount extends Entity {

public BankAccount(JSONObject jsonObject) {
super(jsonObject);
}
}
13 changes: 13 additions & 0 deletions src/main/java/com/razorpay/BankAccountClient.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package com.razorpay;

import java.util.List;

import org.json.JSONObject;

public class BankAccountClient extends ApiClient {

BankAccountClient(String auth) {
super(auth);
}

}
7 changes: 7 additions & 0 deletions src/main/java/com/razorpay/Constants.java
Original file line number Diff line number Diff line change
Expand Up @@ -170,4 +170,11 @@ public class Constants {
static final String TOKEN = "/token";
static final String REVOKE = "/revoke";

static final String ADD_BANK_ACCOUNT = "customers/%s/bank_account";

static final String DELETE_BANK_ACCOUNT = "customers/%s/bank_account/%s";

static final String ELIGIBILITY = "customers/eligibility";

static final String ELIGIBILITY_FETCH = "customers/eligibility/%s";
}
16 changes: 16 additions & 0 deletions src/main/java/com/razorpay/CustomerClient.java
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,20 @@ public Token fetchToken(String id, String tokenId) throws RazorpayException {
public Customer deleteToken(String id, String tokenId) throws RazorpayException {
return delete(Constants.VERSION, String.format(Constants.TOKEN_DELETE, id, tokenId), null);
}

public BankAccount addBankAccount(String id, JSONObject request) throws RazorpayException {
return post(Constants.VERSION, String.format(Constants.ADD_BANK_ACCOUNT, id), request);
}

public Customer deleteBankAccount(String id, String bankId) throws RazorpayException {
return delete(Constants.VERSION, String.format(Constants.DELETE_BANK_ACCOUNT, id, bankId), null);
}

public Customer requestEligibilityCheck(JSONObject request) throws RazorpayException {
return post(Constants.VERSION, Constants.ELIGIBILITY, request);
}

public Customer fetchEligibility(String id) throws RazorpayException {
return get(Constants.VERSION, String.format(Constants.ELIGIBILITY_FETCH, id), null);
}
}
2 changes: 2 additions & 0 deletions src/main/java/com/razorpay/RazorpayClient.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ public class RazorpayClient {
public ProductClient product;
public WebhookClient webhook;
public TncMap tncMap;
public BankAccountClient bankAccount;
public RazorpayClient(String key, String secret) throws RazorpayException {
this(key, secret, false);
}
Expand Down Expand Up @@ -66,6 +67,7 @@ private void initializeResources(String auth, Boolean enableLogging) throws Razo
stakeholder = new StakeholderClient(auth);
product = new ProductClient(auth);
webhook = new WebhookClient(auth);
bankAccount = new BankAccountClient(auth);
}

public RazorpayClient addHeaders(Map<String, String> headers) {
Expand Down
Loading
Loading