Skip to main content
POST
Submit a payment action

Headers

Authorization
enum<string>
default:NONE
required

Reserved for PCX-managed applications. External API integrations must always send the literal string NONE — this is the only accepted value.

Available options:
NONE
Example:

"NONE"

X-Api-Key
string
default:NONE
required

Your API key. This is the only supported credential.

Example:

"pcx_abc123_xxxx"

Path Parameters

payment_id
string
required

ID of the payment awaiting action.

Body

application/json
action
enum<string>
required

The action to perform on the pending payment.

Available options:
submit_otp,
verify,
cancel
action_data
object
required

Action-specific data. submit_otp requires reference and otp. verify requires reference.

Response

Action processed

statusCode
integer
Example:

200

response
object

When the provider returns funding instructions (for example a bank transfer flow), the instruction fields are merged into this object at the top level alongside the fields below.