Capture Full Payment | Welcome to cash-app Documentation

curl -X POST https://global-api-sandbox.afterpay.com/v2/payments/capture \
     -H "User-Agent: User-Agent" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "token": "{{afterpay_checkout_token}}",
  "merchantReference": "{{merchant_order_number}}"
}'

{
  "id": "300000016189",
  "token": "002.6bjbsaowxvfqam2nw4u3xudppheuh4gsuat3n2w3f6t44euzgy",
  "status": "APPROVED",
  "created": "2024-03-11T20:11:42.487Z",
  "originalAmount": {
    "amount": "37.00",
    "currency": "USD"
  },
  "openToCaptureAmount": {
    "amount": "0.00",
    "currency": "USD"
  },
  "paymentState": "CAPTURED",
  "merchantReference": "updated-k6-reference-utaddnpx",
  "refunds": [],
  "orderDetails": {
    "consumer": {
      "email": "test@example.com"
    },
    "billing": {
      "name": "Joe Customer",
      "line1": "1004 New Avenue",
      "area1": "Melbourne",
      "region": "VIC",
      "postcode": "94121",
      "countryCode": "AU",
      "phoneNumber": "2120000000",
      "countrycode": "US"
    },
    "courier": {
      "shippedAt": "2024-01-01T08:00:00Z",
      "name": "FedEx",
      "tracking": "000 000 000 000",
      "priority": "STANDARD"
    },
    "items": [
      {
        "name": "Blue Carabiner",
        "quantity": 1,
        "price": {
          "amount": "40.00",
          "currency": "USD"
        },
        "sku": "12341234"
      }
    ],
    "categories": {
      "categories": null,
      "name": "Jeans",
      "price": {
        "amount": "20.00",
        "currency": "USD"
      },
      "quantity": 1,
      "sku": "123412345"
    },
    "shipping": {
      "countrycode": "US",
      "line1": "1004 New Avenue",
      "name": "Joe Customer",
      "phoneNumber": "2120000000",
      "postcode": "94121"
    }
  },
  "events": [
    {
      "id": "2dYbLXpOtEPQbg1DT7x9D8R4oCY",
      "created": "2024-03-11T20:11:43.897Z",
      "type": "CAPTURED",
      "amount": {
        "amount": "37.00",
        "currency": "USD"
      },
      "paymentEventMerchantReference": "k6-gsrdqspusf"
    }
  ],
  "discounts": [],
  "shippingAmount": {
    "amount": "10.00",
    "currency": "USD"
  },
  "taxAmount": {
    "amount": "0.00",
    "currency": "USD"
  }
}

This endpoint makes a payment capture for the full value of the payment plan.

This operation is idempotent based on the token, which allows for the safe retry of requests, guaranteeing the payment operation is only made once.

Since the idempotency of this endpoint is based on the token, the inclusion of a requestId is not required.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	70

This endpoint makes a payment capture for the full value of the payment plan. This operation is idempotent based on the token, which allows for the safe retry of requests, guaranteeing the payment operation is only made once. Since the idempotency of this endpoint is based on the token, the inclusion of a `requestId` is not required. **Connection Timeouts** | Timeout | Time (Seconds) | |---------|----------------| | Open | 10 | | Read | 70 |

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

This endpoint expects an object.

tokenstringRequired

The token returned in the Create Checkout request.

merchantReferencestringOptional

The merchant’s order id/reference that this payment corresponds to. This updates any value previously provided in the Create Checkout request.

amountobjectOptional

Required for express checkout only. Amount to be checked against the value in the create checkout request. If the amounts do not match, then the request is rejected and an error specific to this scenario is returned.

isCheckoutAdjustedbooleanOptional

Express checkout only. The isCheckoutAdjusted field can be used to allow the order amount to be changed after the checkout flow.

paymentScheduleChecksumstringOptional

Express checkout only. A unique value representing the payment schedule that must be provided when there have been changes since the initial order creation (retrieved from checkout widget).

itemsobjectOptional

Express checkout only. An array of order items that have been updated. Provide if it has changed since the initial order creation.

shippingobjectOptional

Express checkout only. The shipping address if it has changed since the initial order creation.

enrichmentsobjectOptional

grantIdstringOptional

The Afterpay or Cash App Pay on-file grant ID. Required when processing a payment using a previously stored on-file grant.

Response

Status	Description
`APPROVED`	If payment is approved by Afterpay, returns a Payment object in response, with a status of “APPROVED”.
`DECLINED`	If payment is declined by Afterpay, for example, if invalid card details were entered, returns a Payment object in response, with a status of “DECLINED”. Please advise the customer to contact the Afterpay Customer Service team for more information.

| Status | Description | | ----- | ----- | | `APPROVED` | If payment is approved by Afterpay, returns a Payment object in response, with a status of "APPROVED". | | `DECLINED` | If payment is declined by Afterpay, for example, if invalid card details were entered, returns a Payment object in response, with a status of "DECLINED". Please advise the customer to contact the Afterpay Customer Service team for more information. |

idstringOptional

The unique, permanent, Afterpay generated Order ID.

tokenstringOptional

The token obtained from the checkout call

statusenumOptional

represents the status of the order

createdstringOptional

is the UTC timestamp of when the payment was completed.

originalAmountobjectOptional

Object containing amount and currency

openToCaptureAmountobjectOptional

Object containing amount and currency

paymentStateenumOptionalRead-only

is the current state for capturing payments

merchantReferencestringOptional

is the merchant’s order id/reference that the payment corresponds to.

refundslist of objectsOptional

orderDetailsobjectOptional

This comprehensive schema is designed to store an entire transaction's detail, covering crucial aspects like consumer information, billing and shipping details, courier particulars, item list, discounts, tax, and shipping amount.

eventslist of objectsOptional

Errors

402

Payment Required Error

412

Precondition Failed Error

422

Unprocessable Entity Error

Authentication

Headers

Request

Response

Errors