PPppro
Capture Endpoints

Create capture

Capture all or part of an authorization on a payment charge.

post/v1/payment-charges/{paymentChargeId}/captures

Request

  • Base URL
    https://api.sandbox.eu.ppro.com
  • URL
    https://api.sandbox.eu.ppro.com/v1/payment-charges/{paymentChargeId}/captures
  • Auth
    HTTP bearer

Path parameters

paymentChargeIdstring required

Headers

Merchant-Idstring required

The merchant identifier.

Request-Referencestring

Unique request reference to facilitate debugging.

Request-Idempotency-Keystring

Optional Idempotency Key for the request. Sending duplicate requests will result in 409 HTTP status code.

Request body

merchantCaptureReferencestring

The merchant-defined reference for the capture.

amountinteger required

The amount to capture, in the payment charge currency's smallest unit. It can be less than the authorized amount to capture part of the authorization.

labelsobject

Custom labels associated with the capture.

Example request

{
  "merchantCaptureReference": "merch_capture_ref_123",
  "amount": 1000,
  "labels": {
    "consumer_origin": "GTM_Campaign"
  }
}

Response

OK

idstring

The unique identifier of the capture.

amountinteger

The captured amount, in the payment charge currency's smallest unit.

status'CAPTURED' | 'FAILED'

The status of the capture. CAPTURED means the capture succeeded. FAILED means it did not; see failure for details.

merchantCaptureReferencestring

The merchant-defined reference for the capture.

createdAtstring date-time

The capture creation timestamp in ISO 8601 format.

updatedAtstring date-time

The capture update timestamp in ISO 8601 format.

labelsobject

Custom labels associated with the capture.

_linksLinks

Example response

{
  "id": "capture_V1StGXR8_Z5jdHi6B-myT",
  "amount": 1000,
  "status": "CAPTURED",
  "merchantCaptureReference": "merch_capture_ref_123",
  "createdAt": "2022-11-03T11:23:47.123Z",
  "updatedAt": "2022-11-03T11:23:47.123Z",
  "labels": {
    "consumer_origin": "GTM_Campaign"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.