Transfer Payout

post

https://mapi.pockyt.io/v3/payouts/pay

This endpoint triggers the transfer of the specified funds to the payee's account. This endpoint supports both Direct Merchant and Merchant of Record (MoR) flows. For MoR integrations, the system processes the payout according to the account's Payor configuration. The response structure remains the same for both flows.

Body Params

merchantNo

string

required

Defaults to 202333

Merchant ID in Pockyt's system. A unique value created and assigned by Pockyt’s support team during the onboarding process

storeNo

string

required

Defaults to 301854

Store Number in Pockyt's system. A unique value created and assigned by Pockyt’s support team during the onboarding process

verifySign

string

required

Defaults to 8b11e8f0d7f2a412f020f266110b57ba

The parameter signature. It is the calculated MD5 hash value of the API token used to encrypt the request message and authorize transaction requests. For more information, visit Signing API Parameters

customerNo

string

required

Defaults to 2000305228292319592008

The payee's ID in Pockyt system

accountToken

string

required

Defaults to 2010305228303182765718

The funding source account token, generated by Pockyt

invoiceId

string

required

Defaults to 9aae4c685d824c5da746f97620c59eb5

The payment unique ID in the merchant's system

amount

string

required

Defaults to 1.0

The payment amount in the specified currency

currency

string

required

Defaults to USD

The supported transaction currencies are "USD", "CNY", "PHP", "IDR", "KRW", "HKD", "THB", "MYR", "GBP", "BDT", "PKR"

ipnUrl

string

Defaults to https://example.com/webhooks

The merchant's webhook URL to receive transaction status notifications

processingChannel

string

Defaults to STANDARD_ACH

Possible values: STANDARD_ACH, SAME_DAY_ACH, REAL_TIME_PAY. Default is STANDARD_ACH

memo

string

Defaults to thank you

A public description for the payment

note

string

Defaults to Cold drink

An internal memo for the payment

subject

string

Defaults to Payouts

Subject for payment notifications to payee if configured

merGroupNo

string

Defaults to 100001

ISV (Independent Software Vendor) merchant group number. Required only for ISV integrations where the ISV manages sub-merchants through Pockyt. Direct Merchants and MoR merchants can omit this parameter.

Headers

Pockyt-Request-ID

string

Defaults to 41236589756324879

A unique key provided by the merchant for each payout transaction. (Only required if implementing idempotency keys in your system.)

Response

200200