### Get Payment Setup Reference

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/ruby/v1.14.0/OrbipayPaymentsapiClient/OrbipayPaymentsapiClientModels/PaymentSetupResponse.html

Retrieves the unique identifier in the client system for the payment setup.

```Ruby
def payment_setup_reference
  @payment_setup_reference
end
```

--------------------------------

### Get Payment Setup API

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/java/v1.14.0/com/orbipay/paymentsapi/internal/api/PaymentSetupApi.html

Builds the call for retrieving payment setup details.

```APIDOC
## GET /websites/developers_orbipay/getPaymentSetup

### Description
Retrieves the details of a specific payment setup.

### Method
GET

### Endpoint
/websites/developers_orbipay/getPaymentSetup

### Parameters
#### Path Parameters
- None

#### Query Parameters
- **channel** (string) - Required - The channel through which the API is invoked.
- **clientKey** (string) - Required - The unique identifier assigned by EBPP to the client.
- **product** (string) - Required - The product identifier corresponding to the API.
- **timestamp** (string) - Required - The timestamp for the moment when the API request is created.
- **idempotentRequestKey** (string) - Required - The unique token that clients can generate and maintain in order to identify an API request.
- **requestorType** (string) - Required - Type of the requestor of the API.
- **ID_PAYMENT_SETUP** (string) - Required - The unique identifier assigned by EBPP to the payment setup.
- **ID_CUSTOMER** (string) - Required - The unique identifier assigned by EBPP to the customer.
- **requestor** (string) - Optional - The identifier for the requestor of the API.
- **xOPAYHeaders** (string) - Optional - Intended for future use.
- **traceId** (string) - Optional - The unique reference that can be used for tracing and debugging an API call.

### Request Example
(No request body for GET requests, parameters are typically in query string)

### Response
#### Success Response (200)
- **PaymentSetupResponse** (object) - Contains the details of the payment setup.

#### Response Example
```json
{
  "paymentSetupId": "setup_123",
  "customerId": "customer_abc",
  "status": "active",
  "recurringDetails": { ... }
}
```

### Throws
- `ApiException` - If fail to serialize the request body object.
```

--------------------------------

### Build Get Payment Setup Call (Java)

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/java/v1.14.0/com/orbipay/paymentsapi/internal/api/PaymentSetupApi.html

Builds a synchronous call object for retrieving payment setup details. This method is part of the OkHttp integration and supports progress listeners.

```java
com.squareup.okhttp.Call getPaymentSetupCall​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_PAYMENT_SETUP, java.lang.String ID_CUSTOMER, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)
```

--------------------------------

### GET /payment-setups

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/csharp/v1.14.0/classOrbipay_1_1PaymentsApi_1_1Client_1_1Wrappers_1_1PaymentSetups.html

Retrieves a paginated list of payment setups based on customer, account, and date range criteria.

```APIDOC
## GET /payment-setups

### Description
Retrieves a list of payment setups matching the provided search criteria, including support for pagination using index markers.

### Method
GET

### Endpoint
/payment-setups

### Parameters
#### Query Parameters
- **idCustomer** (string) - Optional - Unique identifier for the customer.
- **idFundingAccount** (string) - Optional - Unique identifier for the funding account.
- **idCustomerAccount** (string) - Optional - Unique identifier for the customer account.
- **fromDate** (string) - Optional - Start date for recurring payments retrieval.
- **toDate** (string) - Optional - End date for recurring payments retrieval.
- **pageSize** (string) - Optional - Maximum number of objects to return.
- **after_object** (string) - Optional - ID to fetch the next set of results.
- **before_object** (string) - Optional - ID to fetch the previous set of results.

### Request Example
GET /payment-setups?idCustomer=12345&pageSize=10

### Response
#### Success Response (200)
- **TotalResultsCount** (string) - Total number of matching records.
- **HasMoreResults** (string) - Boolean indicating if more pages exist.
- **Url** (string) - URL for the next or previous result set.
- **PaymentSetup** (List) - Array of payment setup objects.

#### Response Example
{
	"TotalResultsCount": "50",
	"HasMoreResults": "true",
	"Url": "/payment-setups?after_object=abc123",
	"PaymentSetup": []
}
```

--------------------------------

### GET /customers/{ID_CUSTOMER}/paymentsetups/{ID_PAYMENT_SETUP}

Source: https://developers.orbipay.com/paymentsapi/references/v1.10.0

Retrieves the details of a specific payment setup using the customer ID and payment setup ID.

```APIDOC
## GET /customers/{ID_CUSTOMER}/paymentsetups/{ID_PAYMENT_SETUP}

### Description
Retrieves the payment setup configuration with the provided ID.

### Method
GET

### Endpoint
https://api.orbipay.com/payments/v1/customers/{ID_CUSTOMER}/paymentsetups/{ID_PAYMENT_SETUP}

### Parameters
#### Path Parameters
- **ID_CUSTOMER** (string) - Required - The unique identifier assigned by EBPP to the customer.
- **ID_PAYMENT_SETUP** (string) - Required - The unique identifier assigned by EBPP to the payment setup.

#### Header Parameters
- **channel** (string) - Required - The channel through which the API is invoked.
- **client_key** (string) - Required - The unique identifier assigned by EBPP to the client.
- **product** (string) - Required - The product identifier (e.g., "orbipay_payments").
- **timestamp** (string) - Required - The timestamp for the moment when the API request is created.
- **idempotent_request_key** (string) - Required - The unique token to identify an API request.
- **requestor_type** (string) - Required - Type of the requestor (customer, external_user, client_agent, system).
- **requestor** (string) - Optional - The identifier for the requestor.

### Response
#### Success Response (200)
- **id** (string) - The payment setup ID.
- **status** (string) - Current status of the payment setup.
- **amount** (string) - Payment amount.

#### Response Example
{
  "id": "123456789",
  "status": "scheduled",
  "amount": "101.05"
}
```

--------------------------------

### Get Payment Setup Details

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/csharp/v1.14.0/interfaceOrbipay_1_1PaymentsApi_1_1Client_1_1Api_1_1IPaymentSetupApi.html

Retrieves the details of a specific payment setup. Returns a PaymentSetupResponse containing the configuration of the requested setup.

```csharp
ApiResponse<PaymentSetupResponse> GetPaymentSetup(string channel, string clientKey, string product, string timestamp, string idempotentRequestKey, string requestorType, string ID_PAYMENT_SETUP, string ID_CUSTOMER, string requestor=null, string xOPAYHeaders=null, string traceId=null);
```

--------------------------------

### GET /customers/{ID_CUSTOMER}/paymentsetups/{ID_PAYMENT_SETUP}

Source: https://developers.orbipay.com/paymentsapi/references/v1.10.0

Retrieves details of a specific payment setup for a customer.

```APIDOC
## GET /customers/{ID_CUSTOMER}/paymentsetups/{ID_PAYMENT_SETUP}

### Description
Retrieves the details of a specific payment setup associated with a customer. This endpoint allows you to fetch information about a particular payment configuration.

### Method
GET

### Endpoint
`/customers/{ID_CUSTOMER}/paymentsetups/{ID_PAYMENT_SETUP}`

### Parameters
#### Path Parameters
- **ID_CUSTOMER** (string) - Required - The unique identifier assigned by EBPP to the customer.
- **ID_PAYMENT_SETUP** (string) - Required - The unique identifier assigned by EBPP to the payment setup.

### Response
#### Success Response (200)
- **list** (array) - A list containing payment setup objects.
  - **id** (string) - The unique identifier for the payment setup.
  - **url** (string) - The API endpoint for this payment setup.
  - **fee** (object) - Information about associated fees.
    - **fee_type** (string) - The type of fee.
    - **fee_amount** (string) - The amount of the fee.
    - **id** (string) - The unique identifier for the fee.
    - **url** (string) - The API endpoint for this fee.
  - **status** (string) - The current status of the payment setup.
  - **payment_method** (string) - The method used for payment.
  - **payment_setup_schedule_type** (string) - The type of schedule for the payment setup.
  - **confirmation_number** (string) - The confirmation number for the payment setup.
  - **custom_fields** (object) - Custom fields associated with the payment setup.
    - **property1** (string) - Example custom field.
    - **property2** (string) - Example custom field.
  - **currency_code3d** (string) - The 3-digit currency code.
  - **amount** (string) - The payment amount.
  - **card_cvv_number** (string) - CVV number for card payments (if applicable).
  - **next_payment_date** (string) - The date of the next scheduled payment.
  - **payment_setup_reference** (string) - A reference identifier for the payment setup.
  - **payment_schedule** (object) - Details about the payment schedule.
    - **payment_recurring_type** (string) - The type of recurring payment.
    - **payment_recurring_count** (string) - The number of recurring payments.
    - **payment_amount_type** (string) - The type of payment amount.
    - **payment_start_date** (string) - The start date of the payment schedule.
    - **payment_end_date** (string) - The end date of the payment schedule.
    - **payment_limit_amount** (string) - The limit amount for the payment schedule.
    - **payment_plan_id** (string) - The ID of the payment plan.
    - **payment_defer_days** (string) - The number of deferred days for payment.
  - **payment_setup_entry_date** (string) - The date the payment setup was entered.
  - **comments** (string) - Comments related to the payment setup.
  - **customer** (object) - Information about the customer.
    - **id** (string) - The customer's unique identifier.
    - **url** (string) - The API endpoint for the customer.
    - **customer_reference** (string) - A reference identifier for the customer.
    - **first_name** (string) - The customer's first name.
    - **last_name** (string) - The customer's last name.
    - **middle_name** (string) - The customer's middle name.
    - **email** (string) - The customer's email address.
    - **home_phone** (string) - The customer's home phone number.
    - **address** (object) - The customer's address.
      - **address_line1** (string) - The first line of the address.
      - **address_line2** (string) - The second line of the address.
      - **address_city** (string) - The city of the address.
      - **address_state** (string) - The state of the address.
      - **address_country** (string) - The country of the address.
      - **address_zip1** (string) - The first part of the ZIP code.
      - **address_zip2** (string) - The second part of the ZIP code.
  - **funding_account** (object) - Information about the funding account.
    - **id** (string) - The unique identifier for the funding account.
    - **url** (string) - The API endpoint for the funding account.
    - **account_number** (string) - The funding account number.
    - **account_type** (string) - The type of the funding account.
    - **account_subtype** (string) - The subtype of the funding account.
    - **aba_routing_number** (string) - The ABA routing number.
    - **issuer_name** (string) - The name of the issuer.
    - **nickname** (string) - A nickname for the funding account.
  - **customer_account** (object) - Information about the customer's account.
    - **account_number** (string) - The customer's account number.
    - **id** (string) - The unique identifier for the customer account.
    - **url** (string) - The API endpoint for the customer account.
  - **payment_network_response** (object) - Response details from the payment network.
    - **payment_auth_code** (string) - The authorization code from the payment network.
    - **payment_response_code** (string) - The response code from the payment network.
    - **payment_response_msg** (string) - The response message from the payment network.
  - **audit_info** (object) - Audit information for the payment setup.
    - **created** (object) - Information about when the record was created.
      - **channel** (string) - The channel through which the record was created.
      - **requestor_type** (string) - The type of requestor.
      - **requestor** (string) - The identifier of the requestor.
      - **timestamp** (string) - The timestamp of creation.
    - **last_modified** (object) - Information about when the record was last modified.
      - **channel** (string) - The channel through which the record was last modified.
      - **requestor_type** (string) - The type of requestor.
      - **requestor** (string) - The identifier of the requestor.
      - **timestamp** (string) - The timestamp of last modification.

#### Response Example
```json
{
  "list": [
    {
      "id": "123456789",
      "url": "/customers/{ID_CUSTOMER}/paymentsetups/{ID_PAYMENT_SETUP}",
      "fee": {
        "fee_type": "add_to_principal",
        "fee_amount": "5.00",
        "id": "123456789",
        "url": "/customers/{ID_CUSTOMER}/fees/{ID_FEE}"
      },
      "status": "scheduled",
      "payment_method": "ach",
      "payment_setup_schedule_type": "variable_recurring_enrollment",
      "confirmation_number": "A12N12I12L",
      "custom_fields": {
        "property1": "string",
        "property2": "string"
      },
      "currency_code3d": "USD",
      "amount": "101.05",
      "card_cvv_number": "",
      "next_payment_date": "stringstri",
      "payment_setup_reference": "1aQVAZ3kXTF0ocGgi_1212121",
      "payment_schedule": {
        "payment_recurring_type": "monthly",
        "payment_recurring_count": "10",
        "payment_amount_type": "other",
        "payment_start_date": "stringstri",
        "payment_end_date": "",
        "payment_limit_amount": "1000000",
        "payment_plan_id": "",
        "payment_defer_days": ""
      },
      "payment_setup_entry_date": "stringstri",
      "comments": "creating a payment setup",
      "customer": {
        "id": "12684515",
        "url": "/customers/{ID_CUSTOMER}",
        "customer_reference": "IkdphX8DsEtOeOI_73823121",
        "first_name": "Michael",
        "last_name": "Smith",
        "middle_name": "S",
        "email": "userid@example.com",
        "home_phone": "1234567890",
        "address": {
          "address_line1": "1551 South Washington Ave",
          "address_line2": "Suite 130 Piscataway",
          "address_city": "Piscataway",
          "address_state": "NJ",
          "address_country": "USA",
          "address_zip1": "12345",
          "address_zip2": "1234"
        }
      },
      "funding_account": {
        "id": "123456789",
        "url": "/customers/{ID_CUSTOMER}/fundingaccounts/{ID_FUNDING_ACCOUNT}",
        "account_number": "xxxxx0206",
        "account_type": "bank",
        "account_subtype": "savings",
        "aba_routing_number": "123456789",
        "issuer_name": "BANK ISSUER NAME",
        "nickname": "Smith"
      },
      "customer_account": {
        "account_number": "478E4385e604B685",
        "id": "123456789",
        "url": "/customers/{ID_CUSTOMER}/customeraccounts/{ID_CUSTOMER_ACCOUNT}"
      },
      "payment_network_response": {
        "payment_auth_code": "",
        "payment_response_code": "",
        "payment_response_msg": ""
      },
      "audit_info": {
        "created": {
          "channel": "Independent Agent",
          "requestor_type": "external_user",
          "requestor": "1234567",
          "timestamp": "2019-08-13T09:21:34.359+0000"
        },
        "last_modified": {
          "channel": "Independent Agent",
          "requestor_type": "external_user",
          "requestor": "1234567",
          "timestamp": "2019-08-13T09:21:34.359+0000"
        }
      }
    }
  ],
  "total_results_count": "1",
  "has_more_results": "false",
  "url": "/paymentsetups?query_id=vu68cakbhjaksgasd",
  "from_index": "1",
  "to_index": "1",
  "query_id": "vu68cakbhjaksgasd"
}
```
```

--------------------------------

### GET /payments/v1/mpa/paymentsetups/{ID_PAYMENT_SETUP}

Source: https://developers.orbipay.com/ebppapi/mpa/reference

Retrieves the details of a payment setup using its unique identifier.

```APIDOC
## GET /payments/v1/mpa/paymentsetups/{ID_PAYMENT_SETUP}

### Description
The Get Payment Setup API is used to retrieve the details of the payment setup based on the id.

### Method
GET

### Endpoint
/payments/v1/mpa/paymentsetups/{ID_PAYMENT_SETUP}

### Parameters
#### Path Parameters
- **ID_PAYMENT_SETUP** (string) - Required - The unique identifier assigned by EBPP to the payment setup.

#### Header Parameters
- **channel** (string) - Required - The channel through which the API is invoked.
- **client_key** (string) - Required - The unique identifier assigned by EBPP to the client.
- **product** (string) - Required - Value: "orbipay_payments" - The product identifier corresponding to the API.
- **timestamp** (string) - Required - The timestamp for the moment when the API request is created.
- **idempotent_request_key** (string) - Required - The unique token that clients can generate and maintain in order to identify an API request.
- **requestor_type** (string) - Required - Enum: "customer", "external_user" - Type of the requestor of the API.
- **requestor** (string) - Optional - The identifier for the requestor of the API.
- **X-OPAY-Headers** (string) - Optional - Intended for future use.
- **trace_id** (string) - Optional - The unique reference that can be used for tracing and debugging an API call.
- **Authorization** (string) - Required - The authentication information as per the documentation in Authentication section. This is a standard HTTP header.
- **Content-Type** (string) - Required - The content type of the API. It will be 'application/json' for this API.

### Responses
#### Success Response (200)
- **payment_due_date** (string) - The date when the payment is due.
- **statement_date** (string) - The date of the statement.
- **payoff_amount** (string) - The amount required for payoff.
- **payoff_expiry_date** (string) - The expiry date for the payoff amount.
- **association_type** (string) - The type of association (e.g., "primary_borrower").
- **payment_holiday** (string) - Indicates if payment holiday is enabled.
- **payment_holiday_end_date** (string) - The end date of the payment holiday.
- **category_code** (string) - The code for the payment category.
- **category_description** (string) - The description of the payment category.
- **description** (string) - A description of the payment setup.
- **id** (string) - The unique identifier of the payment setup.
- **url** (string) - The URL associated with the payment setup.
- **status** (string) - The current status of the payment setup.
- **audit_info** (object) - Information about the creation and modification of the payment setup.
  - **created** (object)
    - **channel** (string) - The channel through which the record was created.
    - **requestor_type** (string) - The type of the requestor.
    - **requestor** (string) - The identifier of the requestor.
    - **timestamp** (string) - The timestamp of creation.
  - **last_modified** (object)
    - **channel** (string) - The channel through which the record was last modified.
    - **requestor_type** (string) - The type of the requestor.
    - **requestor** (string) - The identifier of the requestor.
    - **timestamp** (string) - The timestamp of the last modification.
- **client_key** (string) - The client key associated with the payment setup.
- **custom_fields** (object) - Custom fields associated with the payment setup.
  - **property1** (string) - Example custom field.
  - **property2** (string) - Example custom field.
- **comments** (string) - Comments related to the payment setup.
- **payment_network_response** (object) - Response details from the payment network.
  - **payment_auth_code** (string) - Authorization code from the payment network.
  - **payment_response_code** (string) - Response code from the payment network.
  - **payment_response_msg** (string) - Response message from the payment network.

#### Error Responses
- **400** - The request was unacceptable, often due to missing a required parameter.
- **401** - Unauthorized
- **403** - Forbidden
- **404** - The requested resource doesn't exist.
- **409** - Conflict
- **422** - The parameters were valid but the request failed.
- **500** - Something went wrong and the request could not be processed.

### Request Example
(No request body for GET request)

### Response Example (200)
```json
{
  "payment_due_date": "2018-11-11T00:00:00.000Z",
  "statement_date": "2018-11-01T00:00:00.000Z",
  "payoff_amount": "10000.00",
  "payoff_expiry_date": "2020-06-01T00:00:00.000Z",
  "association_type": "primary_borrower",
  "payment_holiday": "enabled",
  "payment_holiday_end_date": "2018-11-01",
  "category_code": "0021",
  "category_description": "Used Auto",
  "description": "signature loan",
  "id": "123456789",
  "url": "/payments/v1/mpa/customeraccounts/{ID_CUSTOMER_ACCOUNT}",
  "status": "active",
  "audit_info": {
    "created": {
      "channel": "Independent Agent",
      "requestor_type": "external_user",
      "requestor": "1234567",
      "timestamp": "2019-08-13T09:21:34.359+0000"
    },
    "last_modified": {
      "channel": "Independent Agent",
      "requestor_type": "external_user",
      "requestor": "1234567",
      "timestamp": "2019-08-13T09:21:34.359+0000"
    }
  },
  "client_key": "string",
  "custom_fields": {
    "property1": "string",
    "property2": "string"
  },
  "comments": "creating customer Smith",
  "payment_network_response": {
    "payment_auth_code": "",
    "payment_response_code": "",
    "payment_response_msg": ""
  }
}
```
```

--------------------------------

### Get Payment Setup (Java)

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/java/v1.14.0/com/orbipay/paymentsapi/internal/api/PaymentSetupApi.html

Retrieves details of a specific payment setup. This API requires channel, client key, product, timestamp, idempotency key, requestor type, and the IDs for both the payment setup and the customer. It returns a PaymentSetupResponse upon successful retrieval.

```java
public ApiResponse<PaymentSetupResponse> getPaymentSetup​(
                                                         java.lang.String channel,
                                                         java.lang.String clientKey,
                                                         java.lang.String product,
                                                         java.lang.String timestamp,
                                                         java.lang.String idempotentRequestKey,
                                                         java.lang.String requestorType,
                                                         java.lang.String ID_PAYMENT_SETUP,
                                                         java.lang.String ID_CUSTOMER)
```

--------------------------------

### GET /payment-setups/{ID_PAYMENT_SETUP}

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/java/v1.14.0/com/orbipay/paymentsapi/internal/class-use/ApiResponse.html

Retrieves the details of a specific recurring payment setup by its unique identifier.

```APIDOC
## GET /payment-setups/{ID_PAYMENT_SETUP}

### Description
The API is used to retrieve the details of a recurring payment setup by id.

### Method
GET

### Endpoint
/payment-setups/{ID_PAYMENT_SETUP}

### Parameters
#### Path Parameters
- **ID_PAYMENT_SETUP** (string) - Required - The unique identifier for the payment setup.
- **ID_CUSTOMER** (string) - Required - The unique identifier for the customer.

#### Request Headers
- **channel** (string) - Required - The channel identifier.
- **clientKey** (string) - Required - The client authentication key.
- **product** (string) - Required - The product identifier.
- **timestamp** (string) - Required - ISO timestamp.
- **idempotentRequestKey** (string) - Required - Key to ensure request idempotency.
- **requestorType** (string) - Required - Type of the requestor.
- **requestor** (string) - Required - The identity of the requestor.
- **xOPAYHeaders** (string) - Required - Custom OPAY headers.
- **traceId** (string) - Required - Unique trace identifier.

### Response
#### Success Response (200)
- **PaymentSetupResponse** (object) - The details of the recurring payment setup.
```

--------------------------------

### GET /disbursements/v1/disbursementsetups/lists

Source: https://developers.orbipay.com/payoutsapi/reference

Retrieves a paginated list of disbursement setups based on specified query parameters and headers.

```APIDOC
## GET /disbursements/v1/disbursementsetups/lists

### Description
This API is used to paginate through the list of disbursement setups returned in the Retrieve Disbursement Setups API. It allows for efficient retrieval of large datasets by providing controls for page size and indexing.

### Method
GET

### Endpoint
https://api.orbipay.com/disbursements/v1/disbursementsetups/lists

### Parameters
#### Query Parameters
- **page_size** (string) - Required - The maximum number of objects returned in the query.
- **query_id** (string) - Required - [ 1 .. 50 ] characters. The query ID of the Retrieve/Search Accounts lookup.
- **from_index** (string) - Required - The ID of the object after which the next set of objects are to be retrieved.
- **to_index** (string) - Optional - The ID of the object before which the previous set of objects are to be retrieved.
- **id_payee** (string) - Required - [ 1 .. 20 ] characters. The unique identifier assigned by Digital Disbursements to the payee.

#### Header Parameters
- **client_key** (string) - Required - [ 1 .. 50 ] characters. The unique identifier assigned by Digital Disbursements to the client.
- **channel** (string) - Required - The channel through which the API is invoked.
- **idempotent_request_key** (string) - Required - [ 1 .. 50 ] characters. The unique token that clients can generate and maintain to identify an API request. This is used by Digital Disbursements to identify duplicate requests and retries.
- **product** (string) - Required - Value: "orbipay_disbursements". The product identifier corresponding to the API.
- **requestor_type** (string) - Required - Enum: "payee", "external_user". Type of the requestor of the API.
- **requestor** (string) - Required - [ 1 .. 50 ] characters. The identifier for the requestor of the API.
- **timestamp** (string) - Required - The timestamp for the moment when the API call is made, in the format **yyyy-MM-dd HH:mm:ss.SSSZ**. For example, _2018-07-13 11:41:17.422+00:00_. Please ensure that consecutive spaces are not used in the timestamp.
- **trace_id** (string) - Optional - [a-zA-Z0-9_=-]{1,50}. The unique reference that can be used for tracing and debugging an API call.
- **X-OPAY-Headers** (string) - Optional - Intended for future use.

### Responses
#### Success Response (200)
List of disbursements matching the criteria provided, the total results count and the URLs to get the next/previous pages.
- **total_results_count** (string) - The total number of results available.
- **has_more_results** (string) - Indicates if there are more results to fetch.
- **from_index** (string) - The starting index for the current page of results.
- **to_index** (string) - The ending index for the current page of results.
- **query_id** (string) - The unique identifier for the query.

#### Error Responses
- **400** - The request was unacceptable, often due to missing a required parameter.
- **401** - Unauthorized
- **403** - Forbidden
- **404** - The requested resource doesn't exist.
- **422** - The parameters were valid but the request failed.
- **500** - Something went wrong at the Digital Disbursements Server

### Request Example
```json
{
  "channel": "string",
  "requestor_type": "payee",
  "requestor": "string",
  "timestamp": "string"
}
```

### Response Example
```json
{
  "total_results_count": "10",
  "has_more_results": "true",
  "from_index": "1",
  "to_index": "10",
  "query_id": "cakbhjaksgasdjy5r67rfuf"
}
```
```

--------------------------------

### GET /customers/{ID_CUSTOMER}/paymentsetups/{ID_PAYMENT_SETUP}

Source: https://developers.orbipay.com/paymentsapi/references/v1.10.0

Retrieves the full details of a specific recurring payment setup.

```APIDOC
## GET /customers/{ID_CUSTOMER}/paymentsetups/{ID_PAYMENT_SETUP}

### Description
Retrieves the details of a recurring payment setup by its unique identifier.

### Method
GET

### Endpoint
https://api.orbipay.com/payments/v1/customers/{ID_CUSTOMER}/paymentsetups/{ID_PAYMENT_SETUP}

### Parameters
#### Path Parameters
- **ID_CUSTOMER** (string) - Required - The unique identifier assigned to the customer.
- **ID_PAYMENT_SETUP** (string) - Required - The unique identifier assigned to the payment setup.

### Response
#### Success Response (200)
- **id** (string) - The payment setup ID.
- **status** (string) - The status of the setup.
- **customer** (object) - Customer details associated with the setup.
- **funding_account** (object) - Funding account details.

#### Response Example
{
  "id": "123456789",
  "status": "scheduled",
  "payment_method": "ach"
}
```

--------------------------------

### Get Payment Start Date (string)

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/csharp/v1.14.0/classOrbipay_1_1PaymentsApi_1_1Client_1_1Wrappers_1_1PaymentSchedule.html

Retrieves the start date for the first payment in a recurring setup, formatted as YYYY-MM-DD. This function returns a string representing the payment start date.

```csharp
string GetPaymentStartDate ();
```

--------------------------------

### Build Payment Setups Retrieval Call (Java)

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/java/v1.14.0/com/orbipay/paymentsapi/internal/class-use/ProgressRequestBody.ProgressRequestListener.html

Constructs an OkHttp call for retrieving payment setups. Requires various parameters including channel, client key, product, timestamps, idempotency keys, requestor details, and optional filtering parameters like status and schedule types. Includes progress listeners for request and response.

```java
com.squareup.okhttp.Call | PaymentSetupApi.`retrievePaymentSetupsCall​(java.lang.String channel,
                          java.lang.String clientKey,
                          java.lang.String product,
                          java.lang.String timestamp,
                          java.lang.String idempotentRequestKey,
                          java.lang.String requestorType,
                          java.lang.String requestor,
                          java.lang.String xOPAYHeaders,
                          java.lang.String traceId,
                          java.lang.String idCustomer,
                          java.lang.String idFundingAccount,
                          java.lang.String idCustomerAccount,
                          java.lang.String confirmationNumber,
                          java.util.List<java.lang.String> status,
                          java.util.List<java.lang.String> paymentSetupScheduleType,
                          java.lang.String fromDate,
                          java.lang.String toDate,
                          java.lang.String pageSize,
                          java.lang.String queryId,
                          java.lang.String fromIndex,
                          java.lang.String toIndex,
                          ProgressResponseBody.ProgressListener progressListener,
                          ProgressRequestBody.ProgressRequestListener progressRequestListener)`
```

--------------------------------

### GET /payment_setups

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/ruby/v1.14.0/OrbipayPaymentsapiClient/OrbipayPaymentsapiClientApis/PaymentSetupApi.html

Retrieves a list of recurring and autopay payment setups based on provided filters. Results are sorted by payment start date and modification time.

```APIDOC
## GET /payment_setups

### Description
Retrieve recurring and autopay payment setups made against a customer account. Supports filtering by confirmation number, customer account, funding account, status, schedule type, and date range.

### Method
GET

### Endpoint
/payment_setups

### Parameters
#### Query Parameters
- **channel** (String) - Required - The channel through which the API is invoked.
- **client_key** (String) - Required - The unique identifier assigned by EBPP to the client.
- **product** (String) - Required - The product identifier corresponding to the API.
- **timestamp** (String) - Required - The timestamp for the moment when the API request is created.
- **idempotent_request_key** (String) - Required - The unique token for identifying an API request.
- **requestor_type** (String) - Required - Type of the requestor of the API.
- **id_customer** (String) - Optional - Unique identifier for the customer.
- **from_date** (String) - Optional - Start date for retrieval.
- **to_date** (String) - Optional - End date for retrieval.
- **status** (Array<String>) - Optional - Filter by payment status.

### Request Example
GET /payment_setups?channel=WEB&client_key=12345&product=PAYMENTS&timestamp=2023-10-27T10:00:00Z

### Response
#### Success Response (200)
- **PaymentSetupsResponse** (Object) - The collection of payment setup objects.
- **headers** (Object) - Response headers.

#### Response Example
{
  "payment_setups": [
    {
      "confirmation_number": "CN123456",
      "status": "ACTIVE",
      "payment_start_date": "2023-11-01"
    }
  ]
}
```

--------------------------------

### Create Payment Setup (Java)

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/java/v1.14.0/com/orbipay/paymentsapi/internal/api/PaymentSetupApi.html

Asynchronously sets up recurring payments for a customer account. Requires channel, clientKey, product, timestamp, idempotentRequestKey, requestorType, ID_CUSTOMER, and createPaymentSetupRequest. Optional parameters include requestor, xOPAYHeaders, traceId, and callback. Throws ApiException on failure.

```Java
public void createPaymentSetup(
    String channel,
    String clientKey,
    String product,
    String timestamp,
    String idempotentRequestKey,
    String requestorType,
    String ID_CUSTOMER,
    Object createPaymentSetupRequest,
    String requestor,
    String xOPAYHeaders,
    String traceId,
    Object callback
) throws ApiException;
```

--------------------------------

### Get From Date for Recurring Payments (Java)

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/java/v1.14.0/com/orbipay/paymentsapi/client/wrappers/PaymentSetups.html

Retrieves the start date for recurring payments setup. This parameter is used to filter recurring payments based on their initiation date.

```java
public java.lang.String getFromDate()

```

--------------------------------

### Create Recurring Payment Setup (Java)

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/java/v1.14.0/com/orbipay/paymentsapi/internal/class-use/ApiResponse.html

Sets up recurring payments for a customer account. Requires channel, clientKey, product, timestamp, idempotentRequestKey, requestorType, ID_CUSTOMER, CreatePaymentSetupRequest, requestor, xOPAYHeaders, and traceId.

```java
PaymentSetupApi.createRecurringPaymentSetupWithHttpInfo​(java.lang.String channel, java.lang.String clientKey, java.lang.String product, java.lang.String timestamp, java.lang.String idempotentRequestKey, java.lang.String requestorType, java.lang.String ID_CUSTOMER, CreatePaymentSetupRequest createPaymentSetupRequest, java.lang.String requestor, java.lang.String xOPAYHeaders, java.lang.String traceId)
```

--------------------------------

### Configure PHPUnit Test Fixture

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/php/v1.14.0/classes/CoverageMethodOneLineAnnotationTest.html

Demonstrates how to initialize test fixture state by overriding the setUp method in a PHPUnit_Framework_TestCase subclass. This ensures each test starts with a clean state.

```PHP
protected function setUp() {
  $this->value1 = 2;
  $this->value2 = 3;
}
```

--------------------------------

### Initialize PaymentSetup Instance

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/ruby/v1.14.0/OrbipayPaymentsapiClient/PaymentSetup.html

Constructor for the PaymentSetup class. It accepts an optional id_payment_setup string to initialize the object state.

```ruby
def initialize(id_payment_setup: nil)
    @id_payment_setup = id_payment_setup
    @id = id_payment_setup
end
```

--------------------------------

### GET /websites/developers_orbipay/payment-setups

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/csharp/v1.14.0/interfaceOrbipay_1_1PaymentsApi_1_1Client_1_1Api_1_1IPaymentSetupApi.html

Retrieves recurring and autopay payment setups for a customer account. Supports filtering by confirmation number, customer account, funding account, status, schedule type, and date range. Results are sorted by payment start date and last modified time.

```APIDOC
## GET /websites/developers_orbipay/payment-setups

### Description
Retrieves recurring and autopay payment setups for a customer account. Supports filtering by confirmation number, customer account, funding account, status, schedule type, and date range. Results are sorted by payment start date and last modified time.

### Method
GET

### Endpoint
/websites/developers_orbipay/payment-setups

### Parameters
#### Query Parameters
- **channel** (string) - Required - The channel through which the API is invoked.
- **clientKey** (string) - Required - The unique identifier assigned by EBPP to the client.
- **product** (string) - Required - The product identifier corresponding to the API.
- **timestamp** (string) - Required - The timestamp for the moment when the API request is created.
- **idempotentRequestKey** (string) - Required - The unique token that clients can generate and maintain in order to identify an API request.
- **requestorType** (string) - Required - Type of the requestor of the API.
- **requestor** (string) - Optional - The identifier for the requestor of the API.
- **xOPAYHeaders** (string) - Optional - Intended for future use.
- **traceId** (string) - Optional - The unique reference that can be used for tracing and debugging an API call.
- **idCustomer** (string) - Optional - The unique identifier assigned by EBPP to the customer.
- **idFundingAccount** (string) - Optional - The unique identifier assigned by EBPP to the funding account.
- **idCustomerAccount** (string) - Optional - The unique identifier assigned by EBPP to the customer account.
- **confirmationNumber** (string) - Optional - The confirmation number or reference provided to the customer for the successful payment.
- **status** (List<string>) - Optional - The status of the payment. This can take multiple values in the format key=value1&key=value2....
- **paymentSetupScheduleType** (List<string>) - Optional - The schedule type for the payment setup. This can take multiple values in the format key=value1&key=value2....
- **fromDate** (string) - Optional - The date from which recurring payments setup, matching the criteria specified, need to be retrieved.
- **toDate** (string) - Optional - The date upto which recurring payments setup, matching the criteria specified, need to be retrieved.
- **pageSize** (string) - Optional - The maximum number of objects returned in the query.
- **queryId** (string) - Optional - query id of the Retrieve/Search Customers lookup.
- **fromIndex** (string) - Optional - To fetch the next set of objects that start after this object.
- **toIndex** (string) - Optional - To fetch the previous set of objects that end at this object.

### Response
#### Success Response (200)
- **PaymentSetupsResponse** (object) - Contains the list of payment setups.

#### Response Example
```json
{
  "paymentSetups": [
    {
      "confirmationNumber": "CONF12345",
      "customerAccount": "CUSTACC987",
      "fundingAccount": "FUNDACC654",
      "status": "ACTIVE",
      "paymentSetupScheduleType": "RECURRING",
      "paymentStartDate": "2023-10-26",
      "lastModifiedTime": "2023-10-25T10:00:00Z"
    }
  ],
  "totalCount": 1
}
```

### Exceptions
- **Orbipay.PaymentsApi.Client.Client.ApiException** - Thrown when fails to make API call.
```

--------------------------------

### Initialize PaymentSetupApi (Java)

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/java/v1.14.0/com/orbipay/paymentsapi/internal/api/PaymentSetupApi.html

Constructs a new PaymentSetupApi instance with the provided ApiClient. This is the entry point for interacting with the payment setup API.

```java
public PaymentSetupApi(ApiClient apiClient)
```

--------------------------------

### PHPUnit setUp() Method Example

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/php/v1.14.0/classes/CoverageClassTest.html

Example of implementing the setUp() method in a PHPUnit TestCase to initialize test fixture state. This method is called before each test method.

```php
protected function setUp() {     $this->value1 = 2;     $this->value2 = 3; }
```

--------------------------------

### Implement PaymentSetup Configuration Methods

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/node/v1.14.0/wrappers_PaymentSetup.js.html

Provides chainable prototype methods to configure the PaymentSetup instance, such as setting the client key, channel, and payment details.

```javascript
exports.prototype.forClient = function (client_key) {
	var _this = this;
	Base.prototype.forClient.call(_this, client_key);
	return _this;
};

exports.prototype.videChannel = function (channel) {
	var _this = this;
	Base.prototype.videChannel.call(_this, channel);
	return _this;
};

exports.prototype.withDetails = function (amount, card_cvv_number, payment_setup_schedule_type) {
	var _this = this;
	_this['amount'] = amount;
	_this['card_cvv_number'] = card_cvv_number;
	return _this;
};
```

--------------------------------

### Get Payment Setup Call (Java)

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/java/v1.14.0/com/orbipay/paymentsapi/internal/api/PaymentSetupApi.html

Builds the API call for retrieving payment setup details. This method constructs an OkHttp Call object, requiring channel, client details, product, timestamps, idempotency keys, requestor types, payment and customer IDs, and optional headers. It supports progress listeners for monitoring the request.

```java
public com.squareup.okhttp.Call getPaymentSetupCall​(
                                                    java.lang.String channel,
                                                    java.lang.String clientKey,
                                                    java.lang.String product,
                                                    java.lang.String timestamp,
                                                    java.lang.String idempotentRequestKey,
                                                    java.lang.String requestorType,
                                                    java.lang.String ID_PAYMENT_SETUP,
                                                    java.lang.String ID_CUSTOMER,
                                                    java.lang.String requestor,
                                                    java.lang.String xOPAYHeaders,
                                                    java.lang.String traceId,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException
```

--------------------------------

### Create HTTP Client Options

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/php/v1.14.0/classes/Orbipay-PaymentsApi-Client-Api-FundingAccountApi.html

Initializes the configuration array for the HTTP client. It may throw a RuntimeException if there is a failure during file opening.

```php
protected function createHttpClientOption() : array
```

--------------------------------

### Get Process Start Time - PHP

Source: https://developers.orbipay.com/paymentsapi/sdk-docs/php/v1.14.0/classes/Symfony-Component-Process-Process.html

Retrieves the start time of the process. Returns the start time as a float. Throws a LogicException if the process has not started.

```PHP
public getStartTime() : float
```