Skip to main content
POST
/
capture-payment
/
{payment_id}
Capture Payment
curl --request POST \
  --url https://api.atlas.co/functions/v1/capture-payment/{payment_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 123
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "currency": "<string>",
  "status": "pending",
  "payment_method_type": "card",
  "psp": "stripe",
  "psp_transaction_id": "<string>",
  "captured_amount": 123,
  "refunded_amount": 123,
  "card": {
    "brand": "<string>",
    "last4": "<string>",
    "exp_month": 123,
    "exp_year": 123
  },
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key (sk_test_* or sk_live_*)

Path Parameters

payment_id
string<uuid>
required

Body

application/json
amount
integer

Partial capture amount in cents

Response

Payment captured

id
string<uuid>
session_id
string<uuid>
amount
integer
currency
string
status
enum<string>
Available options:
pending,
authorized,
captured,
failed,
canceled,
refunded
payment_method_type
enum<string>
Available options:
card,
apple_pay,
google_pay,
bank_account,
paypal
psp
enum<string>
Available options:
stripe,
adyen,
authorizenet,
chase,
nuvei,
dlocal,
braintree,
checkoutcom,
airwallex,
windcave,
paypal
psp_transaction_id
string
captured_amount
integer
refunded_amount
integer
card
object
created_at
string<date-time>