Payment Operations

This page provides an overview of the main operations available in the Purse Payment API, with direct access to their technical reference and global explanation of their features.

Capture

A capture operation finalizes an authorized payment by transferring funds from the customer to the merchant.

See definition in glossary

Capture API

• Method: POST
• Endpoint: /v2/payments/{id}/captures
• View API Reference

Refund

A refund operation returns funds to the customer after a payment has been captured.

See definition in glossary

Refund API

• Method: POST
• Endpoint: /v2/payments/{id}/refunds
• View API Reference

Void

A void operation cancels a previously authorized payment before it is captured.

See definition in glossary

Void API

• Method: POST
• Endpoint: /v2/payments/{id}/voids
• View API Reference

Default Processing Order

caution

For Capture Operations :

1. Gift card methods are processed first.
2. Other payment solutions follow.

For Refund Operations :

1. Credit card methods are processed first.
2. Other payment solutions follow.

We allow the merchant to customize this behaviour by setting a priority list in their operation requests.

Example: Processing Priority

[
    { "partner": "*", "method": "creditcard" },
    { "partner": "*", "method": "*" },
    { "partner": "illicado", "method": "*" }
]

In this example, we process first all the remaining transactions that is a creditcard method. Using the wildcards in the solution attributes allow the merchant to be generic about the partner or the method.

When the merchant decide to use the wildcards in both partner and method, we gather all the remaining transactions that have a solution that doesn't match one of the solutions that are set in the priority list.

With those operation priorities, the illicado partner payment method will be processed last.

Operation statuses

Each payment operation has a status :

Status	Description
SUCCESS	The operation was successfully completed.
PENDING	The final status from all partners is not yet available.
FAILURE	A technical error occurred during the operation.
CONFLICT	Some transactions succeeded while others failed.
UNCERTAIN	The PSP response attempts were unsatisfactory or unknown.