Payments Gateway » Development » Rest API
Account Endpoints
This section describes endpoints for Account management.
Table below provides a quick summary:
AccountController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/[?/admin]/account/service-agreement | POST | serviceAgreement | ||||||
| /api/[?/admin]/account | GET | listAccounts | AccountFilter PageOptions | |||||
| /api/[?/admin]/account | POST | createAccount | Account | |||||
| /api/[?/admin]/account//card/ | DELETE | deleteCard | ||||||
| /api/[?/admin]/account/user | PUT | updateAccount | Account | |||||
| /api/[?/admin]/account/ | PUT | updateAccount | Account | |||||
| /api/[?/admin]/account/user | GET | getUserAccount |
Cards Endpoints
This section describes endpoints for Card management.
Table below provides a quick summary:
AccountController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/[?/admin]/account//card /api/admin/account//card | POST | createCard | Card |
BankAccount Endpoints
This section describes endpoints for BankAccount management.
Table below provides a quick summary:
AccountRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
DELETE | /api/[?/admin]/account/account/ | deleteAccount | ||||||
PUT | /api/[?/admin]/account//bankaccount/ | updateBankAccount | BankAccount | |||||
POST | /api/[?/admin]/account//bankaccount//charge | setBankAccountChargeable | ||||||
GET | /api/[?/admin]/account/ | getAccount | ||||||
POST | /api/[?/admin]/account//bankaccount | createBankAccount | BankAccountPlaidAccount | |||||
DELETE | /api/[?/admin]/account//bankaccount/ | deleteBankAccount | ||||||
POST | /api/[?/admin]/account//bankaccount//transfer | setBankAccountTransferDefault |
Payments Endpoints
This section describes endpoints for Payment management.
Table below provides a quick summary:
PaymentRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
PUT | /api/[?/admin]/payment//update | Payment update | Payment | |||||
DELETE | /api/[?/admin]/payment/ | Payment DELETE | ||||||
GET | /api/[?/admin]/payment | PagePayment list | PaymentFilter PageOptions | |||||
POST | /api/[?/admin]/payment | submit | Payment | |||||
GET | /api/[?/admin]/payment/history | PagePayment history | PaymentFilter PageOptions | |||||
POST | /api/[?/admin]/payment//charge | Payment charge | ||||||
DELETE | /api/[?/admin]/payment | deleteMany | [] | |||||
GET | /api/[?/admin]/payment/ | getPayment |
Tax Endpoints
This section describes endpoints for Tax management.
TaxRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
GET | /api/[?/admin]/tax/ | Tax | getTax | |||||
POST | /api/[?/admin]/tax | createTax | Tax | |||||
PUT | /api/[?/admin]/tax/ | updateTax | Tax | |||||
DELETE | /api/[?/admin]/tax/ | deleteTax |
Related Publications
Follow Us
Stay updated with latest news!
Subscribe to our newsletter...
Comments and Discussion