Loan

Partners must engage in discussions with support to configure the loan product. The product configuration process entails reaching agreements on the following elements:

Loan Amount (Fixed or Ranged)
Loan Duration
Number of Installments
Installment Cycle (Weekly or Monthly)
First Repayment Date
Subscriptions (If subscriptions are meant to be charged)
- Subscription Amount
- Subscription Cycle (Weekly or Monthly)
- First Subscription Repayment Date

Create Loan

post

This endpoint allows partner customers to create loan.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

emailstringRequired

The email of the customer.

Example: [email protected]

productCodestringRequired

The product code associated with the customer.

Example: ProductCode

amountnumberRequired

The loan amount requested for the loan.

Example: 300

Responses

200Success

application/json

400

The request could not be processed due to incorrect syntax, missing parameters, or invalid data. Please review and resubmit the request with correct information.

application/json

403

This can happen if the access token provided is invalid or expired.

application/json

409

The request could not be processed as customer currently has an active loan for same partner product.

application/json

500

An unexpected error occurred on the server side. Please try again later. If the issue persists, contact support for assistance.

application/json

post

/api/v2/partner/loan

POST /api/v2/partner/loan HTTP/1.1
Host: qa-api.steadypay.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "email": "[email protected]",
  "productCode": "ProductCode",
  "amount": 300
}

{
  "id": "46136eed-cde2-4513-85b0-c143c8f1d144",
  "issueDate": "2024-03-27T13:00:00.000",
  "endDate": "2024-06-27T23:59:59.000",
  "status": "ACTIVE",
  "productCode": "Product Code",
  "amount": 300,
  "amountRemaining": 300,
  "installments": [
    {
      "id": "56456456-45646-4644-8efd-45645645",
      "sequenceNumber": 1,
      "dueDate": "2024-04-27T23:59:59.000",
      "amount": 100,
      "amountRemaining": 100,
      "amountPaid": 0,
      "status": "Due"
    }
  ],
  "subscriptions": [
    {
      "subscriptionId": "56456456-45646-789-8efd-45645645",
      "paymentId": "56456456-45646-789-8efd-4545789",
      "dueDate": "2024-03-27T23:59:59.000",
      "amount": 10,
      "status": "Due"
    }
  ]
}

Loan Details

get

The end point allows to get loan details

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

loanIdstringRequiredExample: 46136eed-cde2-4513-85b0-c143c8f1d144

Responses

200Success

application/json

400

The request could not be processed due to incorrect syntax, missing parameters, or invalid data. Please review and resubmit the request with correct information.

application/json

403

This can happen if the access token provided is invalid or expired.

application/json

404

The request could not be processed as provided loanId was not found

application/json

500

An unexpected error occurred on the server side. Please try again later. If the issue persists, contact support for assistance.

application/json

get

/api/v2/partner/loan/{loanId}

GET /api/v2/partner/loan/{loanId} HTTP/1.1
Host: qa-api.steadypay.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "email": "[email protected]",
  "id": "46136eed-cde2-4513-85b0-c143c8f1d144",
  "issueDate": "2024-03-27T13:00:00.000",
  "endDate": "2024-06-27T23:59:59.000",
  "status": "ACTIVE",
  "productCode": "Product Code",
  "amount": 300,
  "amountRemaining": 300,
  "installments": [
    {
      "id": "56456456-45646-4644-8efd-45645645",
      "sequenceNumber": 1,
      "dueDate": "2024-04-27T23:59:59.000",
      "amount": 100,
      "amountRemaining": 100,
      "amountPaid": 0,
      "status": "Due"
    }
  ],
  "subscriptions": [
    {
      "subscriptionId": "56456456-45646-789-8efd-45645645",
      "paymentId": "56456456-45646-789-8efd-4545789",
      "dueDate": "2024-03-27T23:59:59.000",
      "amount": 10,
      "status": "Due"
    }
  ]
}

Loan Repayment

post

Notify SteadyPay that user has made the Repayment.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

loanIdstringRequiredExample: 46136eed-cde2-4513-85b0-c143c8f1d144

Body

transactionIdstringRequired

The transactionId is a GUID associated with the transaction.

Example: c17b088d-2226-4760-bdd4-607eebc23340

amountnumberRequired

The repayment amount.

Example: 100

Responses

200Success

application/json

400

The request could not be processed due to incorrect syntax, missing parameters, or invalid data. Please review and resubmit the request with correct information.

application/json

403

This can happen if the access token provided is invalid or expired.

application/json

404

The request could not be processed as provided loanId was not found

application/json

500

An unexpected error occurred on the server side. Please try again later. If the issue persists, contact support for assistance.

application/json

post

/api/v2/partner/loan/{loanId}/repayment

POST /api/v2/partner/loan/{loanId}/repayment HTTP/1.1
Host: qa-api.steadypay.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "transactionId": "c17b088d-2226-4760-bdd4-607eebc23340",
  "amount": 100
}

{
  "id": "46136eed-cde2-4513-85b0-c143c8f1d144",
  "issueDate": "2024-03-27T13:00:00.000",
  "endDate": "2024-06-27T23:59:59.000",
  "status": "ACTIVE",
  "productCode": "Product Code",
  "amount": 300,
  "amountRemaining": 300,
  "installments": [
    {
      "id": "56456456-45646-4644-8efd-45645645",
      "sequenceNumber": 1,
      "dueDate": "2024-04-27T23:59:59.000",
      "amount": 100,
      "amountRemaining": 0,
      "amountPaid": 100,
      "status": "PAID"
    }
  ],
  "subscriptions": [
    {
      "subscriptionId": "56456456-45646-789-8efd-45645645",
      "paymentId": "56456456-45646-789-8efd-4545789",
      "dueDate": "2024-03-27T23:59:59.000",
      "amount": 10,
      "status": "Due"
    }
  ]
}

Loan Subscription Payment

post

Notify SteadyPay that user has made the subscription payment for the loan product.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

loanIdstringRequiredExample: 46136eed-cde2-4513-85b0-c143c8f1d144

Body

transactionIdstringRequired

The transactionId is a GUID associated with the transaction.

Example: c17b088d-2226-4760-bdd4-607eebc23340

amountnumberRequired

The repayment amount.

Example: 100

Responses

200Success

application/json

400

The request could not be processed due to incorrect syntax, missing parameters, or invalid data. Please review and resubmit the request with correct information.

application/json

403

This can happen if the access token provided is invalid or expired.

application/json

404

The request could not be processed as provided loanId was not found

application/json

500

An unexpected error occurred on the server side. Please try again later. If the issue persists, contact support for assistance.

application/json

post

/api/v2/partner/loan/{loanId}/subscription/payment

POST /api/v2/partner/loan/{loanId}/subscription/payment HTTP/1.1
Host: qa-api.steadypay.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "transactionId": "c17b088d-2226-4760-bdd4-607eebc23340",
  "amount": 100
}

{
  "id": "46136eed-cde2-4513-85b0-c143c8f1d144",
  "issueDate": "2024-03-27T13:00:00.000",
  "endDate": "2024-06-27T23:59:59.000",
  "status": "ACTIVE",
  "productCode": "Product Code",
  "amount": 300,
  "amountRemaining": 300,
  "installments": [
    {
      "id": "56456456-45646-4644-8efd-45645645",
      "sequenceNumber": 1,
      "dueDate": "2024-04-27T23:59:59.000",
      "amount": 100,
      "amountRemaining": 100,
      "amountPaid": 0,
      "status": "DUE"
    }
  ],
  "subscriptions": [
    {
      "subscriptionId": "56456456-45646-789-8efd-45645645",
      "paymentId": "56456456-45646-789-8efd-4545789",
      "dueDate": "2024-03-27T23:59:59.000",
      "amount": 10,
      "status": "PAID"
    }
  ]
}

Get All Loans

get

The end point allows to get all loans for the given customer and product code

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

emailstringRequiredExample: [email protected]

productCodestringRequiredExample: PI3

Responses

200Success

application/json

400

The request could not be processed due to incorrect syntax, missing parameters, or invalid data. Please review and resubmit the request with correct information.

application/json

403

This can happen if the access token provided is invalid or expired.

application/json

404

The request could not be processed as provided customer was not found

application/json

500

An unexpected error occurred on the server side. Please try again later. If the issue persists, contact support for assistance.

application/json

get

/api/v2/partner/loan/GetAllLoans/{email}/{productCode}

GET /api/v2/partner/loan/GetAllLoans/{email}/{productCode} HTTP/1.1
Host: qa-api.steadypay.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "46136eed-cde2-4513-85b0-c143c8f1d144",
    "status": "ACTIVE"
  }
]

PreviousV1 (Deprecated)NextV1 (Deprecated)

Last updated 1 year ago