# PayKKa-collection-openplatform

Open platform APIs for merchant onboarding (v2). See appendices for country codes, industries, and file upload flows.

Version: 1.0.0

## Servers

```
https://api.paykka.com
```

## Security

## Download OpenAPI description

 - [PayKKa-collection-openplatform](https://docs.paykka.com/_bundle/collection/apis/@v2/openapi.yaml)

## Merchant Onboarding

 - [POST /api/v2/merch/onboard/apply](https://docs.paykka.com/collection/apis/openapi/merchant-onboarding/apply_1.md): CreateMerchantInformation Special instructions: This API does not pass the Request header ParameterX-Merch-Id
 - [POST /api/v2/merch/onboard/update](https://docs.paykka.com/collection/apis/openapi/merchant-onboarding/update_1.md): MerchantInformationUpdate Special instructions: This API does not pass the Request header ParameterX-Merch-Id
 - [POST /api/v2/merch/onboard/inquiry](https://docs.paykka.com/collection/apis/openapi/merchant-onboarding/inquiry_2.md): MerchantOnboardingResultQuery Special instructions: This API does not pass the Request header ParameterX-Merch-Id
 - [POST /api/v2/merch/onboard/notify](https://docs.paykka.com/collection/apis/openapi/merchant-onboarding/notification_2.md): Merchant onboarding result notification
## Collection Account

 - [POST /api/v2/merch/va/apply](https://docs.paykka.com/collection/apis/openapi/collection-account/apply.md): Collection account application
 - [POST /api/v2/merch/va/inquiry](https://docs.paykka.com/collection/apis/openapi/collection-account/inquiry.md): Query collection account application result
 - [POST /api/v2/merch/va/notify](https://docs.paykka.com/collection/apis/openapi/collection-account/notification.md): Collection account application result notification
## Incoming Remittance

 - [POST /api/v2/remittance/notify](https://docs.paykka.com/collection/apis/openapi/incoming-remittance/notification_incoming_remittance.md): type=INCOMING_REMITTANCE
## Orders

 - [POST /api/v2/merch/contract/create](https://docs.paykka.com/collection/apis/openapi/orders/create_1.md)
 - [POST /api/v2/merch/contract/update](https://docs.paykka.com/collection/apis/openapi/orders/update_2.md): request_id must match the one from order creation
 - [POST /api/v2/merch/contract/inquiry](https://docs.paykka.com/collection/apis/openapi/orders/inquiry_4.md): request_id must match the one from order creation
 - [POST /api/v2/merch/contract/logistics/supplement](https://docs.paykka.com/collection/apis/openapi/orders/supplement_1.md): request_id must match the one from order creation
## Settlement

 - [POST /api/v2/trade-settle/apply](https://docs.paykka.com/collection/apis/openapi/settlement/relate_1.md): Application allowed when collection order status is [PENDING_RELATE|CHECK_REJECTED]
 - [POST /api/v2/trade-settle/inquiry](https://docs.paykka.com/collection/apis/openapi/settlement/inquiry_6.md)
 - [POST /api/v2/trade-settle/notify](https://docs.paykka.com/collection/apis/openapi/settlement/notification_5.md): Settlement result notification
## Account Balance

 - [POST /api/v2/merch/balance](https://docs.paykka.com/collection/apis/openapi/account-balance/query.md): If currency is not specified, all currencies will be returned
## Payee

 - [POST /api/v2/merch/beneficiary/create](https://docs.paykka.com/collection/apis/openapi/payee/create.md): Create payee information
 - [POST /api/v2/merch/beneficiary/update](https://docs.paykka.com/collection/apis/openapi/payee/update.md): Modify payee information
 - [POST /api/v2/merch/beneficiary/inquiry](https://docs.paykka.com/collection/apis/openapi/payee/inquiry_1.md): Query payee status
 - [POST /api/v2/merch/beneficiary/notify](https://docs.paykka.com/collection/apis/openapi/payee/notification_beneficiary.md): Payee creation result notification
## Foreign Exchange

 - [POST /api/v2/fx/conversion/preorder](https://docs.paykka.com/collection/apis/openapi/foreign-exchange/fx_preorder.md): Only one of sell or buy amount may be specified
 - [POST /api/v2/fx/conversion/confirm](https://docs.paykka.com/collection/apis/openapi/foreign-exchange/fx_confirm.md)
 - [POST /api/v2/fx/conversion/inquiry](https://docs.paykka.com/collection/apis/openapi/foreign-exchange/fx_inquiry.md)
 - [POST /api/v2/fx/conversion/notify](https://docs.paykka.com/collection/apis/openapi/foreign-exchange/fx_notify.md)
## Payment

 - [POST /api/v2/merch/pay/apply](https://docs.paykka.com/collection/apis/openapi/payment/inquiry_3.md): Only same-currency payments are supported: the payment currency must match the payee currency
 - [POST /api/v2/merch/pay/inquiry](https://docs.paykka.com/collection/apis/openapi/payment/status_inquiry.md): Query payment/payout confirmation result status
 - [POST /api/v2/merch/pay/notify](https://docs.paykka.com/collection/apis/openapi/payment/status_payment.md): Payment result notification
## File Service

 - [POST /api/file/upload](https://docs.paykka.com/collection/apis/openapi/file-service/upload.md)