Skip to content

Payment

Request

Only same-currency payments are supported: the payment currency must match the payee currency

Headers
X-Merch-Idstring
Default:"M24061911365700670"
Example:M24061911365700670
Bodyapplication/json
request_idstringrequired

Requestid

amountinteger, (int64), >= 1required

PaymentAmount(CurrencyMinimum Unit)

currencystringrequired

Currency: EUR - Euro, USD - United States dollar, CNY - Chinese yuan, GBP - British pound, JPY - Japanese yen, AUD - Australian dollar, CAD - Canadian dollar, SGD - Singapore dollar, HKD - Hong Kong dollar, PHP - Philippine peso, CNH - offshore Chinese yuan

Enum:"EUR""USD""CNY""GBP""JPY""AUD""CAD""SGD""HKD""PHP"
beneficiary_idstring, [ 0 .. 32 ] charactersrequired

Collection person id

postscriptstring or null, <= 64 characters

P.S.

POST
/api/v2/merch/pay/apply
curl -i -X POST \
  https://api.paykka.com/api/v2/merch/pay/apply \
  -H 'Content-Type: application/json' \
  -H 'X-Merch-Id: M24061911365700670'

Responses

OK

Headers
any
Body*/*
statusstringrequired

Status

Enum:"PROCESSING""SUCCEEDED""FAILED"
fee_amountinteger, (int64)required

Fee (Currency is the Payment currency, the CurrencyMinimum Unit)

beneficiary_typestringrequired

CollectionPeopleType

Enum:"PAY""WITHDRAW"
Response
{
  "status": "PROCESSING",
  "fee_amount": 0,
  "beneficiary_type": "PAY"
}