FAfatzebra

Capture an authorization

Changed on
post/paypal/authorizations/{id}/capture

Request

  • Base URL
    https://gateway.pmnts-sandbox.io/v1.0
  • URL
    https://gateway.pmnts-sandbox.io/v1.0/paypal/authorizations/{id}/capture
  • Auth
    HTTP basic

Path parameters

idstring required

ID of the authorization to be captured.

Request body

amountinteger

Amount to be refunded in the smallest unit of the currency.

note_to_payerstring

A note to be attached with the capture. Will be visible to the customer.

final_captureboolean

True if this is the final capture on this authorization. False if more captures are going to be made. When net-captured-amount on the authorization touches or exceeds the total_authorized_amount, final_capture is automatically set to True. Merchant can capture up to 115% of the authorized_amount.

Response

200

successfulboolean
testboolean

Example response

{
  "successful": true,
  "response": {
    "id": "071-PPC-9JNQNPWCD3FSOHDG",
    "amount": 199,
    "decimal_amount": 1.99,
    "captured_amount": 199,
    "successful": true,
    "message": "Approved",
    "reference": "ref_12345_612515",
    "captured": true,
    "currency": "AUD",
    "transaction_id": "071-PPC-9JNQNPWCD3FSOHDG",
    "transaction_date": "2020-08-31T08:30:30+10:00",
    "status": "Completed",
    "invoice_id": "071-PPC-9JNQNPWCD3FSOHDG",
    "paypal_fee": 35,
    "seller_receivable_net_amount": 164,
    "note_to_payer": "$1.99 partial capture",
    "balance_available_for_refund": 199,
    "balance_available_for_capture": 13601,
    "authorization": "071-PPA-6CQGSNJFKJ1UQF9J",
    "order": "071-PPO-ZVCVMDEFCBX86RX2"
  },
  "test": true
}

Changes