POST api/Payment/DoPayment?OrderId={OrderId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OrderId

string

Default value is

Body Parameters

MakePayment
NameDescriptionTypeAdditional information
account_number

string

None.

fund_account_id

string

None.

amount

integer

None.

currency

string

None.

mode

string

None.

purpose

string

None.

queue_if_low_balance

boolean

None.

reference_id

string

None.

narration

string

None.

notes

Notes

None.

Request Formats

application/json, text/json

Sample:
{
  "account_number": "sample string 1",
  "fund_account_id": "sample string 2",
  "amount": 3,
  "currency": "sample string 4",
  "mode": "sample string 5",
  "purpose": "sample string 6",
  "queue_if_low_balance": true,
  "reference_id": "sample string 8",
  "narration": "sample string 9",
  "notes": {
    "note_key": "sample string 1"
  }
}

application/xml, text/xml

Sample:
<MakePayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BuyBackWebApi.Models">
  <account_number>sample string 1</account_number>
  <amount>3</amount>
  <currency>sample string 4</currency>
  <fund_account_id>sample string 2</fund_account_id>
  <mode>sample string 5</mode>
  <narration>sample string 9</narration>
  <notes>
    <note_key>sample string 1</note_key>
  </notes>
  <purpose>sample string 6</purpose>
  <queue_if_low_balance>true</queue_if_low_balance>
  <reference_id>sample string 8</reference_id>
</MakePayment>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PaymentRes
NameDescriptionTypeAdditional information
id

string

None.

entity

string

None.

fund_account_id

string

None.

amount

integer

None.

currency

string

None.

notes

Notes

None.

fees

integer

None.

tax

integer

None.

status

string

None.

utr

Object

None.

mode

string

None.

purpose

string

None.

reference_id

string

None.

narration

string

None.

batch_id

Object

None.

failure_reason

Object

None.

created_at

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "id": "sample string 1",
  "entity": "sample string 2",
  "fund_account_id": "sample string 3",
  "amount": 4,
  "currency": "sample string 5",
  "notes": {
    "note_key": "sample string 1"
  },
  "fees": 6,
  "tax": 7,
  "status": "sample string 8",
  "utr": {},
  "mode": "sample string 10",
  "purpose": "sample string 11",
  "reference_id": "sample string 12",
  "narration": "sample string 13",
  "batch_id": {},
  "failure_reason": {},
  "created_at": 16
}

application/xml, text/xml

Sample:
<PaymentRes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BuyBackWebApi.Models">
  <amount>4</amount>
  <batch_id />
  <created_at>16</created_at>
  <currency>sample string 5</currency>
  <entity>sample string 2</entity>
  <failure_reason />
  <fees>6</fees>
  <fund_account_id>sample string 3</fund_account_id>
  <id>sample string 1</id>
  <mode>sample string 10</mode>
  <narration>sample string 13</narration>
  <notes>
    <note_key>sample string 1</note_key>
  </notes>
  <purpose>sample string 11</purpose>
  <reference_id>sample string 12</reference_id>
  <status>sample string 8</status>
  <tax>7</tax>
  <utr />
</PaymentRes>