> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidoc-v1.maniscloud.com/llms.txt.
> For full documentation content, see https://apidoc-v1.maniscloud.com/llms-full.txt.

# Get payout in manis

GET https://api/v1/payouts

**Request Params**

| **Field** | **type** | **Require** | **Description** |
| --- | --- | --- | --- |
| pspPayoutId | string | No | id of payout from psp |
| status | string | No | One of values:  <br>INITIAL  <br>PENDING  <br>INFO_REQUESTED  <br>COMPLETED  <br>FAILED  <br>PROCESSING_TIMEOUT  <br>EXCEPTION  <br>EXPIRED  <br>REFUNDED |
| page | string | No |  |
| pageSize | string | No |  |

Response Body

200 OK

| Field | Type | **Description** |
| --- | --- | --- |
| `data` | array object |  |
| └─`manisTransactionId` | string | Id of payout request in manis |
| └─`pspPayoutId` | string | Payout request id in PSP |
| └─`beneficiaryId` | string | Beneficiary id |
| └─walletType | string | Specifies the type of wallet supported for the payment method. It depends on the country and currency, with different wallets available for each country |
| └─`createdBy` | string |  |
| └─`createdAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |  |
| └─`updatedBy` | string |  |
| └─`updatedAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |  |
| └─`transaction` | object |  |
| └─└─`id` | string | ID of transaction in Manis |
| └─└─`requestId` | string | The client specifies a unique request ID in the request. |
| └─└─`pspId` | string | ID of the PSP |
| └─└─`merchantId` | string | ID of the merchant |
| └─└─`customerId` | string | ID of the customer |
| └─└─`paymentType` | string | The method used for the payout  <br>Enum: WALLET  <br>CARD  <br>CASH  <br>GLOBAL_TRANSFER  <br>LOCAL_TRANSFER  <br>GLOBAL_TRANSFER_FAST  <br>LOCAL_TRANSFER_FAST  <br>SWIFT  <br>PROXY |
| └─└─`status` | string | status of payout  <br>PENDING  <br>COMPLETED  <br>FAILED  <br>EXPIRED  <br>REFUNDED  <br>CANCELLED |
| └─└─`currency` | string | currency |
| └─└─`amount` | decimal | Amount of transaction |
| └─└─`description` | string | Description |
| └─└─`lastStatusUpdatedDate` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | Last time update status |
| └─└─`createdBy` | string |  |
| └─└─`createdAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |  |
| └─└─`updatedBy` | string |  |
| └─└─`updatedAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |  |
| `currentPage` | number |  |
| `totalItem` | number |  |
| `totalPage` | number |  |

400 BAD REQUEST

| **Field** | **Type** |
| --- | --- |
| `type` | string |
| `status` | number |
| `timestamp` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
| `title` | string |
| `soaCode` | string |
| `fieldErrors` | array |
| └─ `object` | string |
| └─ `field` | string |
| └─ `rejectedValue` | string |
| └─ `message` | string |

401 UNAUTHORIZED

Reference: https://apidoc-v1.maniscloud.com/manis-unified-api-v-1-0/payout/get-payout-in-manis

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /api/v1/payouts:
    get:
      operationId: get-payout-in-manis
      summary: Get payout in manis
      description: >-
        **Request Params**


        | **Field** | **type** | **Require** | **Description** |

        | --- | --- | --- | --- |

        | pspPayoutId | string | No | id of payout from psp |

        | status | string | No | One of values:  <br>INITIAL  <br>PENDING 
        <br>INFO_REQUESTED  <br>COMPLETED  <br>FAILED  <br>PROCESSING_TIMEOUT 
        <br>EXCEPTION  <br>EXPIRED  <br>REFUNDED |

        | page | string | No |  |

        | pageSize | string | No |  |


        Response Body


        200 OK


        | Field | Type | **Description** |

        | --- | --- | --- |

        | `data` | array object |  |

        | └─`manisTransactionId` | string | Id of payout request in manis |

        | └─`pspPayoutId` | string | Payout request id in PSP |

        | └─`beneficiaryId` | string | Beneficiary id |

        | └─walletType | string | Specifies the type of wallet supported for the
        payment method. It depends on the country and currency, with different
        wallets available for each country |

        | └─`createdBy` | string |  |

        | └─`createdAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |  |

        | └─`updatedBy` | string |  |

        | └─`updatedAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |  |

        | └─`transaction` | object |  |

        | └─└─`id` | string | ID of transaction in Manis |

        | └─└─`requestId` | string | The client specifies a unique request ID in
        the request. |

        | └─└─`pspId` | string | ID of the PSP |

        | └─└─`merchantId` | string | ID of the merchant |

        | └─└─`customerId` | string | ID of the customer |

        | └─└─`paymentType` | string | The method used for the payout  <br>Enum:
        WALLET  <br>CARD  <br>CASH  <br>GLOBAL_TRANSFER  <br>LOCAL_TRANSFER 
        <br>GLOBAL_TRANSFER_FAST  <br>LOCAL_TRANSFER_FAST  <br>SWIFT  <br>PROXY
        |

        | └─└─`status` | string | status of payout  <br>PENDING  <br>COMPLETED 
        <br>FAILED  <br>EXPIRED  <br>REFUNDED  <br>CANCELLED |

        | └─└─`currency` | string | currency |

        | └─└─`amount` | decimal | Amount of transaction |

        | └─└─`description` | string | Description |

        | └─└─`lastStatusUpdatedDate` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
        Last time update status |

        | └─└─`createdBy` | string |  |

        | └─└─`createdAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |  |

        | └─└─`updatedBy` | string |  |

        | └─└─`updatedAt` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |  |

        | `currentPage` | number |  |

        | `totalItem` | number |  |

        | `totalPage` | number |  |


        400 BAD REQUEST


        | **Field** | **Type** |

        | --- | --- |

        | `type` | string |

        | `status` | number |

        | `timestamp` | date(yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |

        | `title` | string |

        | `soaCode` | string |

        | `fieldErrors` | array |

        | └─ `object` | string |

        | └─ `field` | string |

        | └─ `rejectedValue` | string |

        | └─ `message` | string |


        401 UNAUTHORIZED
      tags:
        - subpackage_payout
      parameters:
        - name: pspPayoutId
          in: query
          required: false
          schema:
            type: string
        - name: status
          in: query
          required: false
          schema:
            type: string
        - name: page
          in: query
          required: false
          schema:
            type: string
        - name: pageSize
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payout_Get payout in manis_Response_200'
servers:
  - url: https:/
components:
  schemas:
    ApiV1PayoutsGetResponsesContentApplicationJsonSchemaDataItemsTransaction:
      type: object
      properties:
        id:
          type: string
          format: uuid
        pspId:
          type: string
        amount:
          type: integer
        status:
          type: string
        currency:
          type: string
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
          format: uuid
        customerId:
          type: string
          format: uuid
        merchantId:
          type: string
          format: uuid
        description:
          type: string
        paymentType:
          type: string
        lastStatusUpdatedAt:
          type: string
          format: date-time
      required:
        - id
        - pspId
        - amount
        - status
        - currency
        - createdAt
        - createdBy
        - customerId
        - merchantId
        - description
        - paymentType
        - lastStatusUpdatedAt
      title: ApiV1PayoutsGetResponsesContentApplicationJsonSchemaDataItemsTransaction
    ApiV1PayoutsGetResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
          format: uuid
        pspPayoutId:
          type: string
        transaction:
          $ref: >-
            #/components/schemas/ApiV1PayoutsGetResponsesContentApplicationJsonSchemaDataItemsTransaction
        beneficiaryId:
          type: string
          format: uuid
        paymentMethod:
          type: string
        manisTransactionId:
          type: string
          format: uuid
      required:
        - createdAt
        - createdBy
        - pspPayoutId
        - transaction
        - beneficiaryId
        - paymentMethod
        - manisTransactionId
      title: ApiV1PayoutsGetResponsesContentApplicationJsonSchemaDataItems
    Payout_Get payout in manis_Response_200:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: >-
              #/components/schemas/ApiV1PayoutsGetResponsesContentApplicationJsonSchemaDataItems
        totalItem:
          type: integer
        totalPage:
          type: integer
        currentPage:
          type: integer
      required:
        - data
        - totalItem
        - totalPage
        - currentPage
      title: Payout_Get payout in manis_Response_200

```

## SDK Code Examples

```python Payout_Get payout in manis_example
import requests

url = "https://https/api/v1/payouts"

querystring = {"pspPayoutId":"{{pspPayoutId}}","status":"{{status}}","page":"{{page}}","pageSize":"{{pageSize}}"}

response = requests.get(url, params=querystring)

print(response.json())
```

```javascript Payout_Get payout in manis_example
const url = 'https://https/api/v1/payouts?pspPayoutId=%7B%7BpspPayoutId%7D%7D&status=%7B%7Bstatus%7D%7D&page=%7B%7Bpage%7D%7D&pageSize=%7B%7BpageSize%7D%7D';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Payout_Get payout in manis_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://https/api/v1/payouts?pspPayoutId=%7B%7BpspPayoutId%7D%7D&status=%7B%7Bstatus%7D%7D&page=%7B%7Bpage%7D%7D&pageSize=%7B%7BpageSize%7D%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Payout_Get payout in manis_example
require 'uri'
require 'net/http'

url = URI("https://https/api/v1/payouts?pspPayoutId=%7B%7BpspPayoutId%7D%7D&status=%7B%7Bstatus%7D%7D&page=%7B%7Bpage%7D%7D&pageSize=%7B%7BpageSize%7D%7D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java Payout_Get payout in manis_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://https/api/v1/payouts?pspPayoutId=%7B%7BpspPayoutId%7D%7D&status=%7B%7Bstatus%7D%7D&page=%7B%7Bpage%7D%7D&pageSize=%7B%7BpageSize%7D%7D")
  .asString();
```

```php Payout_Get payout in manis_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://https/api/v1/payouts?pspPayoutId=%7B%7BpspPayoutId%7D%7D&status=%7B%7Bstatus%7D%7D&page=%7B%7Bpage%7D%7D&pageSize=%7B%7BpageSize%7D%7D');

echo $response->getBody();
```

```csharp Payout_Get payout in manis_example
using RestSharp;

var client = new RestClient("https://https/api/v1/payouts?pspPayoutId=%7B%7BpspPayoutId%7D%7D&status=%7B%7Bstatus%7D%7D&page=%7B%7Bpage%7D%7D&pageSize=%7B%7BpageSize%7D%7D");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift Payout_Get payout in manis_example
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://https/api/v1/payouts?pspPayoutId=%7B%7BpspPayoutId%7D%7D&status=%7B%7Bstatus%7D%7D&page=%7B%7Bpage%7D%7D&pageSize=%7B%7BpageSize%7D%7D")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```