Capture - Regional API GetNet

Capture an Authorized Payment

The Capture endpoint is used to finalize a previously successful authorized payment, ensuring that the transaction amount is deducted from the customer’s account and settled to the merchant. The transaction must be captured within the allowed timeframe, otherwise a new transaction authorization is required.

Usage Scenarios:

Splitting authorization and capture into separate steps for better control over transaction processing.

Reducing the captured amount if needed before final settlement (if partial capture is supported).

Notes:

Some updates may require additional validation or approval.

A payment must be previously authorized before capture.

If the transaction is not captured within the allowed timeframe, the authorization may expire, requiring a new transaction.

请求参数

Authorization

OAuth 2.0

Client Credentials

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Token URL: https://api.globalgetnet.com/authentication/oauth2/access_token

OAuth 2.0

Client Credentials

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Token URL: https://api.pre.globalgetnet.com/authentication/oauth2/access_token

OAuth 2.0

Client Credentials

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Token URL: https://api-sbx.globalgetnet.com/authentication/oauth2/access_token

Scopes:

digital-platform:gateway-api-Read and write access

Body 参数application/json必填

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200

application/json

Transaction executed successfully.

Bodyapplication/json

示例

{
    "idempotency_key": "63c7f8ee-51a6-470d-bb76-ef762b62bfb7",
    "seller_id": "9406df6c-3100-49ba-b4df-d81c1ad8a62b",
    "payment_id": "2c341d28-491b-4cf8-aec7-eeb60136b7a5",
    "order_id": "ORDER-10187383",
    "amount": 8900,
    "currency": "BRL",
    "status": "CAPTURED",
    "reason_code": "00",
    "reason_message": "TRANSACTION EXECUTED SUCCESSFULLY",
    "captured_at": "2020-06-30T22:33:41.172"
}

🟠400

🟠401

🟠404

🟠422

🟠429

🔴500

🔴503

🔴504