Allow user to get their account’s payment informations

1 Table of Contents
2 Changelogs
3 Payment Information Resource
4 API Definition
- 4.1 Request
  - 4.1.1 Headers
  - 4.1.2 Query Parameters
- 4.2 Response
5 Rate limit
- 5.1 Rate Limiting Overview
  - 5.1.1 Global Policy
  - 5.1.2 Operation Policy
- 5.2 Rate Limit Details
- 5.3 Exceeding the Rate Limit
  - 5.3.1 Example Response When Rate Limit is Exceeded

Changelogs

Version	Date	Changes by	Description of change
V1.0	Oct 10, 2024	Tam Tran	Added Table of Contents. Added Changelogs.

Payment Information Resource

Id uuid

Payment unique identifier

IsActive boolean

Status of Payment (Active | InActive)

CreatedTime DateTime

Payment’s created time

BankAccountInformation:Currency text

Currency

BankAccountInformation:BankAccountNumber text

Bank Account Number

BankAccountInformation:BankAccountName text

Bank Account Name

BankAccountInformation:BankName text

Bank Name

BankAccountInformation:VerifiedStatus text

The status of Bank info (Verified | Failed)

BankAccountInformation:Comment text

Comment

BankAccountInformation:SwiftCode text

Bank Swift Code

BankAccountInformation:BankAddress text

Bank Address

BankAccountInformation:ACHRoutingNumber text

Bank ACH Routing Number

BankAccountInformation:BankCode text

Bank Code

BankAccountInformation:BranchCode text

Bank Branch Code

BankAccountInformation:TaxRegistrationNumber text

Bank Tax Registration Number

BankAccountInformation:PaymentType object

Value: Value of Enum
Description: Description of Enum

Payment Type (BankTransfer, WiredTransfer, Aba, SwiftCode, SingaporeLocalBank, SingaporePayNow, ChineseLocalBusiness, BrazilBusiness)

BankAccountInformation:BankAccountType object

Value: Value of Enum
Description: Description of Enum

Bank Account Type (Checking, Savings, None)

RecipientInformation:RecipientType object

Value: Value of Enum
Description: Description of Enum

Bank Account Type (Business, Personal)

RecipientInformation:Country text

Recipient country name

RecipientInformation:State text

Recipient state

RecipientInformation:CountryCode text

Recipient country code

RecipientInformation:StateCode text

Recipient state code

RecipientInformation:City text

Recipient city

RecipientInformation:Address text

Recipient address

RecipientInformation:PostCode text

Recipient post code

RecipientInformation:Email text

Recipient email

{
    "Id": "aff7a2fd-9643-4e25-1b4b-08dc124b6670",
    "IsActive": true,
    "CreatedTime": "2024-01-11T02:17:03.043",
    "BankAccountInformation": {
        "Currency": "USD",
        "BankAccountNumber": "1234gggg",
        "BankAccountName": "Tam",
        "BankName": "Tam",
        "VerifiedStatus": "Verified",
        "Comment": "bbb",
        "SwiftCode": "AAAABBBB",
        "BankAddress": null,
        "ACHRoutingNumber": null,
        "BankCode": null,
        "BranchCode": null,
        "TaxRegistrationNumber": null,
        "PaymentType": {
            "Value": "SwiftCode",
            "Description": "Outside US"
        },
        "BankAccountType": {
            "Value": "None",
            "Description": "None"
        }
    },
    "RecipientInformation": {
        "RecipientType": {
            "Value": "Business",
            "Description": "Business"
        },
        "Country": "Albania",
        "State": null,
        "CountryCode": "AL",
        "StateCode": null,
        "City": "Tam",
        "Address": "Tam",
        "PostCode": "123456",
        "Email": null
    }
}

API Definition

GET /public/v2/payments

Request

Headers

Content-Type	`application/json`
Authorization	`Bearer {{access_token}}`

Query Parameters

IsActive (optional) boolean

(true | false)

CurrentPage (optional) integer

The page number to retrieve the next set of inverters. The number has to be greater than 1, and will default to 1.

ItemsPerPage (optional) integer

The maximum number of inverter brands to return per page. This number can range from 10 to 100 and defaults to 100.

curl --location 'https://uat-api.redex.eco/public/v2/payments \
--header 'accept: application/json' \
--header 'Authorization: Bearer {{access_token}}'

Response

Response Body

Data object collection - Payment Information Resource

A collection of objects - Payment Information Resource

Errors list of error objects

Please see "Getting Started - #Error Object" for more details

请查看Getting Started - #Error Object以获得更多信息。

Meta pagination resource

Return Pagination Resource

返回分页信息

StatusCode integer

Http Status codes standard. Example 200, 201, 400, 422.

http状态码，如200，201，400, 422

Message text

Response message: Success or error message.

返回成功或错误的信息。

200 Success

{
  "Data": [
    {
      "Id": "da2da341-128c-49dc-86ef-2d6eab3df861",
      "IsActive": true,
      "CreatedTime": "2023-04-18T08:14:13.95",
      "BankAccountInformation": {
        "Currency": "USD",
        "BankAccountNumber": "6011191466843343",
        "BankAccountName": "PV Coconut Oil Company",
        "BankName": "Chase Bank",
        "VerifiedStatus": "Verified",
        "Comment": "",
        "SwiftCode": "BAIWMCJTXXXW",
        "BankAddress": null,
        "ACHRoutingNumber": null,
        "BankCode": null,
        "BranchCode": null,
        "TaxRegistrationNumber": null,
        "PaymentType": {
          "Value": "SwiftCode",
          "Description": "Outside US"
        },
        "BankAccountType": {
          "Value": "Checking",
          "Description": "Checking"
        }
      },
      "RecipientInformation": {
        "RecipientType": {
          "Value": "Business",
          "Description": "Business"
        },
        "Country": "Viet Nam",
        "State": null,
        "CountryCode": "VN",
        "StateCode": null,
        "City": "Ho Chi Minh ",
        "Address": "180 D. Nguyễn Văn Trỗi, Phường 8, Phú Nhuận, Thành phố Hồ Chí Minh",
        "PostCode": "70000",
        "Email": null
      }
    }
  ],
  "Meta": {
    "CurrentPage": 1,
    "TotalPage": 1,
    "TotalItems": 1,
    "ItemsPerPage": 100
  },
  "Errors": null,
  "StatusCode": 200,
  "Message": "Success"
}

400 Bad Request

422 Unprocessable Entity

Rate limit

Rate Limit Algorithm: Fixed Window

In fixed window rate limiting, a fixed time window (e.g., one minute, one hour) is used to track the number of requests or actions allowed within that window. Requests exceeding the limit are either rejected or throttled until the window resets.

Rate Limiting Overview

Our API employs rate limiting to ensure fair usage and protect the performance and availability of the service. Combination of Global Policy and Operation Policy

Global Policy

Rate Limit: 3000 requests per 5 minute(s)
Renewal Period: 300 second(s)
Key: IP Address
Increment Condition: Any Request

Operation Policy

Rate Limit: 10 requests per 10 seconds(s)
Renewal Period: 10 second(s)
Key: accound-id business account Id.
Increment Condition: Any Request.

Rate Limit Details

Rate Limit by Key:
1. Key: This ensures that rate limits are applied uniquely for each business account id.
2. Request Limit: Each key is allowed to make up to 10 requests per 10 seconds.
3. Reset Interval: The limit resets every 10 seconds.
Response Headers:
1. Retry-After: Sent when the rate limit is exceeded, indicating how long to wait before making another request.

Exceeding the Rate Limit

When the rate limit is exceeded, the API will return a 429 Too Many Requests status code. The response will include a Retry-After header specifying the number of seconds to wait before making a new request.

PUBLIC API Documentation

[GET] Query Account Payment Information

Table of Contents