CHcheckout
Payments

Increment authorization

Request an incremental authorization to increase the authorization amount or extend the authorization's validity period.

post/payments/{id}/authorizations

Request

Path parameters

idstring required

The payment identifier

Headers

Cko-Idempotency-Keystring

An optional idempotency key for safely retrying payment requests

Request body

amountinteger

The amount to increase the authorization by. Omit the amount or provide a value of 0 to extend the authorization validity period

referencestring

A reference you can later use to identify this authorization request

metadataobject

A set of key-value pairs to attach to the authorization request. You can use this to store additional information in a structured format.

The metadata object only supports primitive data types. Objects and arrays are not supported.

Example request

{
  "amount": 6540,
  "reference": "ORD-5023-4E89",
  "metadata": {
    "coupon_code": "NY2018",
    "partner_id": 123989
  }
}

Response

Authorization processed successfully

action_idstring required

The action identifier

amountinteger required

The payment amount

currencystring required

The three-letter <a href="https://www.checkout.com/docs/resources/codes/currency-codes" target="_blank">ISO currency code</a> of the payment

approvedboolean required

Whether or not the authorization was successful

status'Authorized' | 'Declined' required

The status of the payment

auth_codestring

The acquirer authorization code if the payment was authorized

response_codestring required

The Gateway response code

response_summarystring

The Gateway response summary

expires_onstring

The timestamp (ISO 8601 code) for when the authorization's validity period ends

processed_onstring date-time required

Read-only UTC timestamp, automatically assigned by us

referencestring

Your reference for the payment

ecistring

The final Electronic Commerce Indicator (ECI) security level used to authorize the payment. Applicable for 3D Secure and network token payments

scheme_idstring

The scheme transaction identifier

Example response

{
  "action_id": "act_y3oqhf46pyzuxjbcn2giaqnb44",
  "amount": 6540,
  "currency": "USD",
  "approved": true,
  "status": "Authorized",
  "auth_code": "643381",
  "response_code": "10000",
  "response_summary": "Approved",
  "balances": {
    "total_authorized": 6540,
    "available_to_void": 6540,
    "available_to_capture": 6540
  },
  "reference": "ORD-5023-4E89",
  "processing": {
    "retrieval_reference_number": "909913440644",
    "acquirer_transaction_id": "440644309099499894406",
    "recommendation_code": "02",
    "surcharge_amount": 200
  },
  "eci": "06",
  "scheme_id": "489341065491658",
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44"
    },
    "actions": {
      "href": "https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/actions"
    },
    "authorize": {
      "href": "https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/authorizations"
    },
    "void": {
      "href": "https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/voids"
    },
    "capture": {
      "href": "https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/capture"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.