Capture a Payment

1min
To capture an authorized transaction on a credit card, you only need to provide the payment’s unique ID. Also, capture action provide a way to capture part of the amount and the rest of the amount will be refunded to the customer’s card.
POST
Request
Path Params
id
required
String
The unique ID of the payment
Body Parameters
amount
required
String
Amount intended to be capture by this request. A positive integer represents how much to capture in the smallest currency unit (e.g., 100 Halala to charge 1.00 SAR or 100 to charge ¥100, a zero-decimal currency). The minimum amount is 1 SAR or equivalent in charge currency.
Curl
curl -X POST https://api.moyasar.com/v1/payments/{id}/capture \
     -u sk_yourkey: \
     -H 'Content-Type: application/json'
     -d '{ 
           "amount": "100"
         }'
curl -X POST https://api.moyasar.com/v1/payments/{id}/capture \
     -u sk_yourkey: \
     -H 'Content-Type: application/json'
     -d '{ 
           "amount": "100"
         }'
Responses
200
400
{
  "id": "760878ec-d1d3-5f72-9056-191683f55872",
  "status": "captured",
  "amount": 60000,
  "fee": 1580,
  "currency": "SAR",
  "refunded": 0,
  "refunded_at": null,
  "captured": 60000,
  "captured_at": null,
  "voided_at": null,
  "description": null,
  "amount_format": "600 SAR",
  "fee_format": "15.80 SAR",
  "refunded_format": "0.00 SAR",
  "captured_format": "600.00 SAR",
  "invoice_id": null,
  "ip": null,
  "callback_url": null,
  "created_at": "2016-05-11T17:04:17.000Z",
  "updated_at": "2016-05-12T17:04:19.633Z",
  "metadata": null,
  "source": {
    "type": "creditcard",
    "company": "visa",
    "name": "Saleh Ali",
    "number": "XXXX-XXXX-XXXX-1111",
    "message": null,
    "transaction_url": null,
    "gateway_id": "moyasar_cc_ce1iUidxhrh74257S891wvW",
    "reference_number": "125478454231"
  }
}
{
  "id": "760878ec-d1d3-5f72-9056-191683f55872",
  "status": "captured",
  "amount": 60000,
  "fee": 1580,
  "currency": "SAR",
  "refunded": 0,
  "refunded_at": null,
  "captured": 60000,
  "captured_at": null,
  "voided_at": null,
  "description": null,
  "amount_format": "600 SAR",
  "fee_format": "15.80 SAR",
  "refunded_format": "0.00 SAR",
  "captured_format": "600.00 SAR",
  "invoice_id": null,
  "ip": null,
  "callback_url": null,
  "created_at": "2016-05-11T17:04:17.000Z",
  "updated_at": "2016-05-12T17:04:19.633Z",
  "metadata": null,
  "source": {
    "type": "creditcard",
    "company": "visa",
    "name": "Saleh Ali",
    "number": "XXXX-XXXX-XXXX-1111",
    "message": null,
    "transaction_url": null,
    "gateway_id": "moyasar_cc_ce1iUidxhrh74257S891wvW",
    "reference_number": "125478454231"
  }
}
﻿
Returns
A payment object if the capture operation succeeded with captured and captured_at attributes updated.
In case of any failure, return an error object.
An error example is capturing a payment with a status other than authorized (i.e. capturing a payment with the status 'captured' or 'paid').
Updated 23 Nov 2023
Did this page help you?
Refund Payment
Manual Payments