Payment Session and Webhooks

As payments progress through the process, you can always see its current status and with webhooks from Pay.com you'll automatically receive payment updates, so you can keep your business running smoothly.

(i) Webhooks are user defined HTTP callbacks which are triggered by specific events related to Payment or Payout objects. For example, when payment gets captured our system sees the event, collects the data, and sends it to the URL specified by you in the form of an HTTP request.

Payment Session

Payment Session encapsulates all events involved in the process of collecting a payment from your customer.

Webhook name
Description
Status
open
The payment session was created in the system, but no action has been taken.
OPEN
completed
The payment session was completed and all available funds were captured.
completed
expired
The payment session has expired without successful  charge. Expired session could have declined transactions.
expired

Charge

Charge object represents a charge from selected payment method (credit card, debit card, or APM).

Webhook name
Description
Status
charge.pending
Charge created and is pending approval.
pending
charge.succeeded
Charge successful
succeeded
requires_authentication
A charge requires authentication when it’s created using the Pay API and requires 3DS check.
charge.failed
Charge was declined
failed

Hold

Hold object holds details of card payment method and authorization amount and is used to authorize requested amount before actual charge.

Webhook name
Description
Status
hold.succeeded
hold.captured - A charge requires authentication when it’s created using the Pay API and requires 3DS check.
The amount held is successfully captured (fully or partially) and the Hold is linked to at least one successful capture.
succeeded
A hold requires authentication when it’s created using the Pay API and requires 3DS check.
requires_authentication
hold.requires_capture
The requested authorization amount is approved and funds are held before actual charge takes place. In other words, pending capture.
requires_capture
hold.canceled
Hold on funds has been canceled via the API, or Hold expired.
canceled
hold.failed
Charge was declined
failed

Refund

Refund object allows you to refund a charge that has previously been created. Funds will be refunded to the payment method that was originally charged.

Webhook name
Description
Status
refund.pending
The refund has been created and is pending a response.
pending
refund.succeeded
charge.refunded- (partially or fully)
The payment has been successfully refunded for requested amount.
succeeded
refund.failed
The refund was declined.
failed
On this page