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.

/charges/{chargeId}/capture

Useful Notes

  • You can capture less than the authorized amount.

E.g. if the authorized amount is $100, you do a partial capture of $10, and then a final capture of $70 specifying is_partial_capture=false, then the remaining $20 will be released to the customer account.

  • You cannot capture an amount beyond what was authorized.
  • The "charge_id" must be in an "Authorized" state to be captured.
  • Ensure the idempotency-key header parameter is present in capture API requests.

Example Request

{
  "amount": 100,
  "reference":"ref_1646065022",
  "is_partial_capture":false  
}
Language