urembo-hub-api
Preparing search index...
escrow/escrow.controller
EscrowController
Class EscrowController
Index
Constructors
constructor
Methods
create
Vendor
Subaccount
get
Escrow
Stats
initialize
Escrow
process
Auto
Release
refund
Escrow
release
Escrow
Constructors
constructor
new
EscrowController
(
escrowService
:
EscrowService
)
:
EscrowController
Parameters
escrowService
:
EscrowService
Returns
EscrowController
Methods
create
Vendor
Subaccount
createVendorSubaccount
(
vendorData
:
{
accountNumber
:
string
;
bankCode
:
string
;
businessName
:
string
;
contactName
:
string
;
email
:
string
;
percentageCharge
?:
number
;
phone
:
string
;
}
,
)
:
Promise
<
PaystackSubaccount
>
Parameters
vendorData
:
{
accountNumber
:
string
;
bankCode
:
string
;
businessName
:
string
;
contactName
:
string
;
email
:
string
;
percentageCharge
?:
number
;
phone
:
string
;
}
Returns
Promise
<
PaystackSubaccount
>
get
Escrow
Stats
getEscrowStats
()
:
Promise
<
{
pendingOrders
:
number
;
totalHeld
:
number
;
totalRefunded
:
number
;
totalReleased
:
number
;
}
,
>
Returns
Promise
<
{
pendingOrders
:
number
;
totalHeld
:
number
;
totalRefunded
:
number
;
totalReleased
:
number
;
}
,
>
initialize
Escrow
initializeEscrow
(
orderId
:
string
,
body
:
{
paymentReference
:
string
}
,
)
:
Promise
<
EscrowTransaction
>
Parameters
orderId
:
string
body
:
{
paymentReference
:
string
}
Returns
Promise
<
EscrowTransaction
>
process
Auto
Release
processAutoRelease
()
:
Promise
<
void
>
Returns
Promise
<
void
>
refund
Escrow
refundEscrow
(
orderId
:
string
,
body
:
{
reason
:
string
}
)
:
Promise
<
boolean
>
Parameters
orderId
:
string
body
:
{
reason
:
string
}
Returns
Promise
<
boolean
>
release
Escrow
releaseEscrow
(
orderId
:
string
,
body
:
{
reason
?:
string
}
)
:
Promise
<
boolean
>
Parameters
orderId
:
string
body
:
{
reason
?:
string
}
Returns
Promise
<
boolean
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
create
Vendor
Subaccount
get
Escrow
Stats
initialize
Escrow
process
Auto
Release
refund
Escrow
release
Escrow
urembo-hub-api
Loading...