v1

latestOpenAPI 3.1.02026-07-24260142.2 KB

Capture a charge

Sandbox (Testing): https://global-api.sand.au.edge.zip.co/merchant/charges/{chargeId}/capture

Once a Charge has been Authorized it must then be Captured for disbursement to the merchant. This is done by simply referring to the Authorized "charge_id" in the endpoint url and passing the amount to be captured.

post/charges/{chargeId}/capture

Headers

Authorizationstring required

Bearer {{API Key}}

Idempotency-Keystring required

[RandomString]

Zip-Versionstring required

2021-08-25

Request body

amountinteger required

Order shipping address object.

referencestring

Unique transaction reference.

is_partial_captureboolean

Specifies whether the capture request is partial or not. If true and the capture amount is less than the authorized amount then the outstanding balance will remain authorised for capture at a later stage. If false and the capture amount is less than the authorized amount then the outstanding balance will be released back to the customer and the charges will be finalised, future captures will not be allowed. Default value is false if attribute is not specified in the request..

Response

200

amountinteger

captured_amountinteger

created_datestring

currencystring

idstring

productstring

receipt_numberinteger

refunded_amountinteger

statestring

Example response

{
  "amount": 100,
  "captured_amount": 100,
  "created_date": "2023-06-23T17:25:49.215Z",
  "currency": "USD",
  "id": "us-5b1c9ff7-8972-4cef-b016-eb6675ee1066",
  "product": "partPay",
  "receipt_number": 230623652526,
  "state": "approved",
  "customer": {
    "first_name": "Dale",
    "last_name": "Jones",
    "email": "firstname.lastname@zip.co"
  }
}