# Blu Penguin Merchant API v1

Please find complete documentation from https://docs.transaction-monitor.io/.

Version: v1

## Servers

Blu Penguin Merchant API sandbox
```
https://api.sandbox.transaction-monitor.io
```

Blu Penguin Merchant API production
```
https://api.transaction-monitor.io
```

## Security

### bearerAuth

See [Authentication](https://docs.transaction-monitor.io/using_the_api#authentication).

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Blu Penguin Merchant API v1](https://docs.transaction-monitor.io/_bundle/blupenguin_openapi_v1.yaml)

## Payouts

### Request payout

 - [POST /payouts](https://docs.transaction-monitor.io/blupenguin_openapi_v1/payouts/createpayout.md)

### Request bulk payout

 - [POST /payouts/bulk](https://docs.transaction-monitor.io/blupenguin_openapi_v1/payouts/createpayouts.md)

### Check payout status

 - [GET /payouts/{payoutId}](https://docs.transaction-monitor.io/blupenguin_openapi_v1/payouts/getpayout.md)

### Resend payout callback

 - [POST /payouts/resend-callback](https://docs.transaction-monitor.io/blupenguin_openapi_v1/payouts/payoutsresendcallback.md)

### Cancel enqueued payout

 - [POST /payouts/fail-enqueued/{payoutId}](https://docs.transaction-monitor.io/blupenguin_openapi_v1/payouts/payoutsfailenqueued.md)

### Payout Status Callback

 - [POST payoutCallback](https://docs.transaction-monitor.io/blupenguin_openapi_v1/payouts/payoutwebhook.md): If you have configured callbacks, Blu Penguin will POST a callback to your configured callback URL for each payout when it reaches a final status. 
Read more about handling callbacks and callback URLs.

If you have not configured callbacks, you can always call our Check Payout Status endpoint to get the latest status and details of a specific payout request. 

__Headers related to signatures will only be included if you have enabled "Sign all callbacks" from the Blu Penguin Dashboard. Read more about it from the Blu Penguin Dashboard documentation.__

## Deposits

### Request deposit

 - [POST /deposits](https://docs.transaction-monitor.io/blupenguin_openapi_v1/deposits/createdeposit.md)

### Check deposit status

 - [GET /deposits/{depositId}](https://docs.transaction-monitor.io/blupenguin_openapi_v1/deposits/getdeposit.md)

### Resend deposit callback

 - [POST /deposits/resend-callback](https://docs.transaction-monitor.io/blupenguin_openapi_v1/deposits/depositsresendcallback.md)

### Deposit Status Callback

 - [POST depositCallback](https://docs.transaction-monitor.io/blupenguin_openapi_v1/deposits/depositwebhook.md): If you have configured callbacks, Blu Penguin will POST a callback to your configured callback URL for each deposit when it reaches a final status. 
Read more about handling callbacks and callback URLs.

If you have not configured callbacks, you can always call our Check Deposit Status endpoint to get the latest status and details of a specific deposit request. 

__Headers related to signatures will only be included if you have enabled "Sign all callbacks" from the Blu Penguin Dashboard. Read more about it from the Blu Penguin Dashboard documentation.__

## Refunds

### Request refund

 - [POST /refunds](https://docs.transaction-monitor.io/blupenguin_openapi_v1/refunds/createrefund.md)

### Check refund status

 - [GET /refunds/{refundId}](https://docs.transaction-monitor.io/blupenguin_openapi_v1/refunds/getrefund.md)

### Resend refund callback

 - [POST /refunds/resend-callback](https://docs.transaction-monitor.io/blupenguin_openapi_v1/refunds/refundsresendcallback.md)

### Refund Status Callback

 - [POST refundCallback](https://docs.transaction-monitor.io/blupenguin_openapi_v1/refunds/refundwebhook.md): If you have configured callbacks, Blu Penguin will POST a callback to your configured callback URL for each refund when it reaches a final status. 
Read more about handling callbacks and callback URLs.

If you have not configured callbacks, you can always call our Check Refund Status endpoint to get the latest status and details of a specific refund request. 

__Headers related to signatures will only be included if you have enabled "Sign all callbacks" from the Blu Penguin Dashboard. Read more about it from the Blu Penguin Dashboard documentation.__

## Payment Page

### Deposit via Payment Page

 - [POST /v1/widget/sessions](https://docs.transaction-monitor.io/blupenguin_openapi_v1/payment-page/create-session.md)

## Wallet balances

### Wallet balances

 - [GET /v1/wallet-balances](https://docs.transaction-monitor.io/blupenguin_openapi_v1/wallet-balances/wallet-balances.md)

### Wallet balances for country

 - [GET /v1/wallet-balances/{country}](https://docs.transaction-monitor.io/blupenguin_openapi_v1/wallet-balances/wallet-balances-for-country.md)

## Toolkit

### Correspondent Availability

 - [GET /availability](https://docs.transaction-monitor.io/blupenguin_openapi_v1/toolkit/availability.md)

### Active Configuration

 - [GET /active-conf](https://docs.transaction-monitor.io/blupenguin_openapi_v1/toolkit/active_conf.md)

### Predict Correspondent

 - [POST /v1/predict-correspondent](https://docs.transaction-monitor.io/blupenguin_openapi_v1/toolkit/predict-correspondent.md)

### Public Keys

 - [GET /public-key/http](https://docs.transaction-monitor.io/blupenguin_openapi_v1/toolkit/public_key_http.md)