NAV

getDeposit

GET /v2/deposit/{deposit_id}

SimplePin allows companies to deposit accumulated funds to their bank accounts. Every time that a company withdraws funds, SimplePin creates a unique deposit ID associated to this event along with a list of transactions.

This API endpoint allows the developer to obtain more information about a specific deposit within SimplePin.

Parameters
Name
Description
deposit_id integer (required)

This is a unique deposit ID which was previously created during manual or automated deposit.

Response Messages
Code
Description
200
OK
401
Unauthorized
403
Forbidden
404
Not Found
             {
    "country_code": 0,
    "deposit_preview_model": {
        "amount": 1.01,
        "bank_account_number": "string",
        "currency_code": "AED",
        "deposit_id": 0,
        "deposit_number": "string",
        "deposited_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
        "options": "string",
        "schedule": "WEEKLY",
        "settled_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
        "status_code": "SETTLED",
        "transactions_count": 0
    },
    "settlement_period_end": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "settlement_period_start": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
    "transaction_reports": [
        {
            "account_holder": "string",
            "all_installment_ids": [],
            "amount": 1.01,
            "currency_code": "AED",
            "customer_id": "string",
            "fees": 1.01,
            "invoice_due_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
            "invoice_number": "string",
            "paid_installment_ids": [],
            "payout_amount": 1.01,
            "transaction_date": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
            "transaction_id": 0,
            "transaction_number": "string",
            "transaction_type": "DB"
        }
    ],
    "transaction_summary_models": [
        {
            "amount": 1.01,
            "count": 0,
            "fee": 1.01,
            "type": "DB"
        }
    ],
    "type": "WIRE"
}
             
          
{ } DepositReportV2Model
country_code (optional) integer
deposit_preview_model (optional) DepositPreviewV2Model
settlement_period_end (optional) string
settlement_period_start (optional) string
transaction_reports (optional) array|TransactionReportV2Model
transaction_summary_models (optional) array|TransactionSummaryReportV2Model
type (optional) string
{ } DepositPreviewV2Model
amount (optional) number
bank_account_number (optional) string
currency_code (optional) string
deposit_id (optional) integer
deposit_number (optional) string
deposited_date (optional) string
options (optional) string
schedule (optional) string
settled_date (optional) string
status_code (optional) string
transactions_count (optional) integer
{ } TransactionReportV2Model
account_holder (optional) string
all_installment_ids (optional) array
amount (optional) number
currency_code (optional) string
customer_id (optional) string
fees (optional) number
invoice_due_date (optional) string
invoice_number (optional) string
paid_installment_ids (optional) array
payout_amount (optional) number
transaction_date (optional) string
transaction_id (optional) integer
transaction_number (optional) string
transaction_type (optional) string
{ } TransactionSummaryReportV2Model
amount (optional) number
count (optional) integer
fee (optional) number
type (optional) string
             <deposit_report_model>
  <country_code>0</country_code>
  <deposit_preview_model/>
  <settlement_period_end>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</settlement_period_end>
  <settlement_period_start>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</settlement_period_start>
  <transaction_reports>
    <transaction_report>
      <account_holder>string</account_holder>
      <all_installment_ids/>
      <amount>1.01</amount>
      <currency_code>AED</currency_code>
      <customer_id>string</customer_id>
      <fees>1.01</fees>
      <invoice_due_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</invoice_due_date>
      <invoice_number>string</invoice_number>
      <paid_installment_ids/>
      <payout_amount>1.01</payout_amount>
      <transaction_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</transaction_date>
      <transaction_id>0</transaction_id>
      <transaction_number>string</transaction_number>
      <transaction_type>DB</transaction_type>
    </transaction_report>
    <transaction_report>
      <account_holder>string</account_holder>
      <all_installment_ids/>
      <amount>1.01</amount>
      <currency_code>AED</currency_code>
      <customer_id>string</customer_id>
      <fees>1.01</fees>
      <invoice_due_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</invoice_due_date>
      <invoice_number>string</invoice_number>
      <paid_installment_ids/>
      <payout_amount>1.01</payout_amount>
      <transaction_date>yyyy-MM-dd'T'HH:mm:ss.SSSXXX</transaction_date>
      <transaction_id>0</transaction_id>
      <transaction_number>string</transaction_number>
      <transaction_type>DB</transaction_type>
    </transaction_report>
  </transaction_reports>
  <transaction_summary_models>
    <transaction_summary_model>
      <amount>1.01</amount>
      <count>0</count>
      <fee>1.01</fee>
      <type>DB</type>
    </transaction_summary_model>
    <transaction_summary_model>
      <amount>1.01</amount>
      <count>0</count>
      <fee>1.01</fee>
      <type>DB</type>
    </transaction_summary_model>
  </transaction_summary_models>
  <type>WIRE</type>
</deposit_report_model>

             
          
{ } DepositReportV2Model
country_code (optional) integer
deposit_preview_model (optional) DepositPreviewV2Model
settlement_period_end (optional) string
settlement_period_start (optional) string
transaction_reports (optional) array|TransactionReportV2Model
transaction_summary_models (optional) array|TransactionSummaryReportV2Model
type (optional) string
{ } DepositPreviewV2Model
amount (optional) number
bank_account_number (optional) string
currency_code (optional) string
deposit_id (optional) integer
deposit_number (optional) string
deposited_date (optional) string
options (optional) string
schedule (optional) string
settled_date (optional) string
status_code (optional) string
transactions_count (optional) integer
{ } TransactionReportV2Model
account_holder (optional) string
all_installment_ids (optional) array
amount (optional) number
currency_code (optional) string
customer_id (optional) string
fees (optional) number
invoice_due_date (optional) string
invoice_number (optional) string
paid_installment_ids (optional) array
payout_amount (optional) number
transaction_date (optional) string
transaction_id (optional) integer
transaction_number (optional) string
transaction_type (optional) string
{ } TransactionSummaryReportV2Model
amount (optional) number
count (optional) integer
fee (optional) number
type (optional) string