younifyd
Menu

Capture payment for order

Capture payment for order

POST/v2/checkout/orders/{id}/capture

Use it in a workflow

  1. Add a step and choose the PayPal connector.
  2. Pick the Capture payment for order action (under Orders).
  3. Fill in the fields below, then reference the result from later steps as {{capturePaymentForOrder.response.data}}.

Request

Path parameters

idstringrequired

The ID of the order for which to capture a payment.

Headers

PayPal-Request-Idstring

The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager. It is mandatory for all single-step create order calls (E.g. Create Order Request with payment source information like Card, PayPal.vault_id, PayPal.billing_agreement_id, etc).

Preferstring

The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul>

Default "return=minimal"

PayPal-Client-Metadata-Idstring

A GUID value originating from Fraudnet and Dyson passed from external API clients via HTTP header. The value is used by Risk decisions to correlate calls which, in turn, might result in lower decline rates..

Authorizationstring

Holds authorization information for external API calls.

PayPal-Auth-Assertionstring

Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.

Request body

Enter the body as JSON in the step's Body field.

payment_sourceany
json
{
  "payment_source": null
}

Response

Returns 200 with an object. Read it in later steps with {{capturePaymentForOrder.response.data.<field>}}.

Need more? See the PayPal guide for connection setup and behaviour shared by every action.

Capture payment for order — PayPal — Documentation