latestOpenAPI 3.0.02026-08-101010.0 KB

dc2fd4cd3140

Deposits

Creates a deposit request

post/deposits

Headers

Content-Typestring required

Media type of the body sent to the API.

X-Datestring date-time required

ISO8601 Datetime with Timezone: yyyy-MM-dd'T'HH:mm:ssZ

X-Loginstring required

Merchant X-Login API Key.

Authorizationstring required

Authorization control hash.

X-Idempotency-Keystring

Unique idempotency key for ensuring that the same request is not processed more than once.

Request body

countrystring required

Country of the deposit.

amountnumber required

Amount of the deposit.

invoice_idstring required

Unique deposit ID on your side.

currencystring required

Currency of the deposit.

request_payer_data_on_validation_failureboolean

Flag specifying if you want to ignore errors because of invalid phone, zip_code and/or city's state.

payerobject required

Object containing details about the customer. See 'Payer object' section for details.

payment_methodstring required

Payment method code.

payment_typesstring[]

Array of payment methods' types to show the customer on our Hosted Checkout.

reported_infoobject

Object containing details about the bank account from which the deposit will be made. Used in ONE_SHOT mode to auto-detect user's payment.

bank_accountobject

Object containing details about the customer's bank account. Used to enforce a close-loop policy.

bonus_amountnumber

Used to show the customer a bonus amount (Pay 100, receive 120).

bonus_relativeboolean

Used to define if the bonus_amount was specified as an absolute value or as a percentage.

strikethrough_pricenumber

Used to show the customer a strikethrough amount.

descriptionstring

Description of the deposit.

client_ipstring

Valid IPv4/6 Address of the customer.

device_idstring

Unique customer's device ID created using our JS library.

languagestring

Language of the view page.

back_urlstring

HTTPS URL used to redirect the customer in case of cancelling the deposit.

success_urlstring

HTTPS URL used to redirect the customer in case of success.

error_urlstring

HTTPS URL used to redirect the customer in case of error while generating the payment.

notification_urlstring

HTTPS URL used to send the notifications about deposit's change of status.

logostring

HTTPS URL used as the Merchant logo on our cashier page.

testboolean

Used to mark a deposit as test. If true, the deposit will not affect the merchant's balance.

mobileboolean

Used to specify if the redirection will be made on a mobile device.

early_releaseboolean

Used to specify if the deposit should be released earlier.

fee_on_payerboolean

Used to specify if you want to let the customer assume the deposit fee.

Example request

{
  "invoice_id": "1000000001",
  "amount": "5000",
  "country": "NG",
  "currency": "NGN",
  "payment_method": "TR",
  "payer": {
    "id": "1122",
    "document": "84932568207",
    "first_name": "John",
    "last_name": "Doe",
    "email": "Johndoe@hotmail.com",
    "phone": "+2348123457856",
    "address": {
      "street": "Lekki 13",
      "city": "Lagos",
      "state": "LG",
      "zip_code": 100200
    }
  },
  "description": "test description",
  "client_ip": "123.123.123.123",
  "device_id": "00000000-00000000-01234567-89ABCDEF",
  "back_url": "https://www.lime-pay.com/deposit_cancelled",
  "success_url": "https://www.lime-pay.com/deposit_completed",
  "error_url": "https://www.lime-pay.com/deposit_error",
  "notification_url": "https://www.lime-pay.com/limepay/notify",
  "logo": "https://www.lime-pay.com/limepay.png",
  "test": true,
  "mobile": false,
  "language": "en"
}

Response

Successful creation of the transaction

checkout_typestring

redirect_urlstring

deposit_idinteger

user_idstring

merchant_invoice_idstring

Example response

{
  "checkout_type": "ONE_SHOT",
  "redirect_url": "https://checkout-stg.lime-pay.com/v1/gateway/show?id_payment=56578849&signature=fff0e0a6a98066c19caf",
  "deposit_id": 300000025,
  "user_id": "1122",
  "merchant_invoice_id": "postmanTest123456",
  "payment_info": {
    "type": "BANK_TRANSFER",
    "payment_method": "TR",
    "payment_method_name": "Bank Transfer",
    "amount": 5000,
    "currency": "NGN",
    "expiration_date": "2020-06-17 07:04:16",
    "created_at": "2020-06-16 19:04:16",
    "metadata": {
      "Beneficiary_name": "LimePay",
      "Bank": "Test Bank",
      "provider_reference": "MockFLWRef-1722395586437"
    }
  }
}