Capture Operation and Statuses

After authorizing the required amount it will be available to capture them to your merchant account.

You can capture the authorized amount multiple times, or you can do it once by executing the capture operation, and you have a limit to the authorized amount and you can't capture an amount greater than the authorized amount.

To start a capture operation you should keep the transaction id that generated from the last authorize operation and pass it with the needed amount to be captured URL: https://web.moneyhash.io/api/v1.1/payments/transactions/xxxx-xxxx-xxxx-xxxx/capture/

Code samples

curl --location --request POST 'https://web.moneyhash.io/api/v1.1/payments/transactions/{transaction_id}/capture/' \
--header 'X-Api-Key: Brd7FTmS.wMYHOZPgri8DyBjHbctmxQCpMoZ1rIW5' \
--header 'Content-Type: application/json' \
--data-raw '{"amount": 10}'

import requests
url = "https://moneyhash.io/api/v1.1/payments/transactions/{transaction_id}/capture/"
payload = "{\"amount\": 10}"
headers = {
  'X-Api-Key': 'Brd7FTmS.wMYHOZPgri8DyBjHbctmxQCpMoZ1rIW5',
  'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data = payload)
print(response.text.encode('utf8'))

If the capture request is succeeded you will receive an update to the current status of the intent, The intended transaction will contain list operations with all operations

{
  "status": {
    "code": 200,
    "message": "success",
    "errors": []
  },
  "data": {
    "status_id": "1ZvObd9",
    "intent": {
      "id": "xxxxxxx",
      "created": "2022-10-16 13:22:10.680392+00:00",
      "custom_fields": null,
      "custom_form_answers": null,
      "amount": {
        "value": 50,
        "currency": "USD"
      }
    },
    "account": {
      "id": "xxxxxx"
    },
    "transaction": {
      "type": "payment",
      "id": "xxxx-xxxx-xxxx-xxxx",
      "created": "2022-10-16 13:22:10.689464+00:00",
      "status": "capture.successful",
      "billing_data": null,
      "external_action_message": [],
      "operations": [
        {
          "id": "BZ18m6g",
          "type": "authorize",
          "status": "successful",
          "amount": {
            "value": 100,
            "currency": "USD"
          },
          "statuses": [
            {
              "id": "Vgl60z9",
              "value": "pending",
              "created": "2022-10-16 13:22:10.701388+00:00"
            },
            {
              "id": "A9eEq69",
              "value": "successful",
              "created": "2022-10-16 13:22:10.704596+00:00"
            }
          ]
        },
        {
          "id": "8LVR1NL",
          "type": "capture",
          "status": "successful",
          "amount": {
            "value": 10,
            "currency": "USD"
          },
          "statuses": [
            {
              "id": "z98xXJ9",
              "value": "successful",
              "created": "2022-10-16 13:22:48.411996+00:00"
            }
          ]
        },
        {
          "id": "z98p5r9",
          "type": "capture",
          "status": "successful",
          "amount": {
            "value": 10,
            "currency": "USD"
          },
          "statuses": [
            {
              "id": "1ZvObd9",
              "value": "successful",
              "created": "2022-10-16 14:55:15.310527+00:00"
            }
          ]
        }
      ],
      "custom_message": "",
      "method": {
        "id": "wA9eY9m",
        "display_name": "Demo - Card",
        "service_provider": {
          "id": "YVglAZx"
        }
      }
    }
  },
  "count": 1,
  "next": null,
  "previous": null
}

If you are going to capture the full amount in multiple requests or with different states, then you will receive an extra operation in the operations list indicating the latest operation, and its status

{
  "status": {
    "code": 200,
    "message": "success",
    "errors": []
  },
  "data": {
    "status_id": "dLWwooL",
    "intent": {
      "id": "xxxxxxx",
      "created": "2022-10-16 13:22:10.680392+00:00",
      "custom_fields": null,
      "custom_form_answers": null,
      "amount": {
        "value": 50,
        "currency": "USD"
      }
    },
    "account": {
      "id": "xxxxxxx"
    },
    "transaction": {
      "type": "payment",
      "id": "xxxx-xxxx-xxxx-xxxx",
      "created": "2022-10-16 13:22:10.689464+00:00",
      "status": "capture.successful",
      "billing_data": null,
      "external_action_message": [],
      "operations": [
        {
          "id": "BZ18m6g",
          "type": "authorize",
          "status": "successful",
          "amount": {
            "value": 100,
            "currency": "USD"
          },
          "statuses": [
            {
              "id": "Vgl60z9",
              "value": "pending",
              "created": "2022-10-16 13:22:10.701388+00:00"
            },
            {
              "id": "A9eEq69",
              "value": "successful",
              "created": "2022-10-16 13:22:10.704596+00:00"
            }
          ]
        },
        {
          "id": "8LVR1NL",
          "type": "capture",
          "status": "successful",
          "amount": {
            "value": 10,
            "currency": "USD"
          },
          "statuses": [
            {
              "id": "z98xXJ9",
              "value": "successful",
              "created": "2022-10-16 13:22:48.411996+00:00"
            }
          ]
        },
        {
          "id": "z98p5r9",
          "type": "capture",
          "status": "successful",
          "amount": {
            "value": 10,
            "currency": "USD"
          },
          "statuses": [
            {
              "id": "1ZvObd9",
              "value": "successful",
              "created": "2022-10-16 14:55:15.310527+00:00"
            }
          ]
        },
        {
          "id": "oZpaGk9",
          "type": "capture",
          "status": "successful",
          "amount": {
            "value": 10,
            "currency": "USD"
          },
          "statuses": [
            {
              "id": "dLWwooL",
              "value": "successful",
              "created": "2022-10-16 14:58:54.780998+00:00"
            }
          ]
        }
      ],
      "custom_message": "",
      "method": {
        "id": "wA9eY9m",
        "display_name": "Demo - Card",
        "service_provider": {
          "id": "YVglAZx"
        }
      }
    }
  },
  "count": 1,
  "next": null,
  "previous": null
}

The operations list now contains a new item with the latest capture operation and also the previous one to keep the whole history of the transactions and updates

Errors
If you authorized specific amount, and you tried to capture an amount larger than the authorized amount then you will receive an error indicating that.

{
    "status": {
        "code": 400,
        "message": "",
        "errors": [
            {
                "capture": "capture operation amount = 100.00 can't be greater than (transaction amount - previously captured amount)"
            }
        ]
    },
    "data": {},
    "count": null,
    "next": null,
    "previous": null
}

Status: 400 Ensure this value is greater than or equal to 0.01

{
    "status": {
        "code": 400,
        "message": "",
        "errors": [
            {
                "amount": "Ensure this value is greater than or equal to 0.01."
            }
        ]
    },
    "data": {},
    "count": null,
    "next": null,
    "previous": null
}

Status: 401 Unauthorized

{
  "status": {
    "code": 401,
    "message": "",
    "errors": [
      {
        "detail": "Authentication credentials were not provided."
      }
    ]
  },
  "data": {},
  "count":null,
  "next":null,
  "previous":null
}

Code samples

Errors