Skip to main content

Bank Transfers - All Accounts

POST /api/v1/BankTransfers/all-account

Description

This endpoint is used to retrieve bank transfers for all accounts.

Headers:

  • None

ApiKey:

  • No API key required

Content-Type:

  • text/plain

  • application/json

  • text/json

Query Parameters:

  • version: string, required

  • PageNumber: integer, optional, default is 1

  • PageSize: integer, optional, default is 10

Request Body:

  • No request body is required

URL:
{{baseUrl API url}}/api/v1/BankTransfers/all-account?PageNumber=1&PageSize=10

Response:

  • A BankTransferResponseListPagedResponse object.

Error Codes:

  • 400: Bad Request

  • 404: Resource not found

  • 500: Internal server error

Example:

GET /api/v1/BankTransfers/all-account?PageNumber=1&PageSize=10

Response:

HTTP/1.1 200 OK
{
"BankTransfers": [
{
"transactionId": "1234567890",
"amount": 1000
},
{
"transactionId": "1234567891",
"amount": 500
}
],
"TotalCount": 2
}

Method: GET

/api/v1/BankTransfers/all-account?PageNumber=<integer>&PageSize=<integer>

Headers

Content-TypeValue
Accepttext/plain

Query Params

Paramvalue
PageNumber<integer>
PageSize<integer>

Response: 200

{
"pageNumber": "<integer>",
"pageSize": "<integer>",
"total": "<integer>",
"succeeded": "<boolean>",
"message": "<string>",
"errors": [
"<string>",
"<string>"
],
"data": [
{
"id": "<uuid>",
"reference": "<string>",
"amount": "<double>",
"account": {
"accountName": "<string>",
"accountNumber": "<string>",
"bankName": "<string>"
},
"beneficiary": {
"accountName": "<string>",
"accountNumber": "<string>",
"bankName": "<string>"
},
"status": "<string>",
"date": "<dateTime>",
"tenantId": "<uuid>",
"email": "<string>",
"currency": "<string>"
},
{
"id": "<uuid>",
"reference": "<string>",
"amount": "<double>",
"account": {
"accountName": "<string>",
"accountNumber": "<string>",
"bankName": "<string>"
},
"beneficiary": {
"accountName": "<string>",
"accountNumber": "<string>",
"bankName": "<string>"
},
"status": "<string>",
"date": "<dateTime>",
"tenantId": "<uuid>",
"email": "<string>",
"currency": "<string>"
}
]
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request POST \ 
--url /api/v1/BankTransfers/all-account \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!