WePay logo
      Nothing Found

Capture a payment

post/payments/{id}/capture

The POST /payments/{id}/capture call allows your platform to capture a payment (when auto_capture is set to false).

SecurityappIdAuth and appTokenAuth
Request
path Parameters
id
required
string [ 1 .. 255 ] characters
header Parameters
Api-Version
required
string
Example: 3.0
Content-Type
required
stringapplication/json
Example: application/json
Unique-Key
string
Request Body schema: application/json
object or null

For Card Present, we allow adjusting the amounts to greater or less than the auth amount. For Card Not Present, we allow adjusting the amounts to less than the auth amount for delayed capture only.

object or null

Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data.

Responses
200
Response Schema: application/json
id
required
string [ 1 .. 255 ] characters

ID of the object or resource.

resource
required
string

Helps organize information by identifying the resource type of the object data.

Value: Description
payments
path
required
string

The HTTP path of the resource. The path can be used to retrieve details about the resource and perform actions on it.

required
object or null

Details the owner resource and owner path.

create_time
required
integer <int64> >= 0

The UNIX timestamp for when the object was created.

status
required
string
Enum: Description
pending

This payment is processing, but is not yet included in the account's available or reserve balance. Find more information in the pending_reasons structure.

completed

This payment has finished processing, and is now available in either the account's available or reserved balance. Note: A payment can have a completed status and simultaneously have a refund or dispute issued against it.

… 2 more
amount
required
integer
amount_refunded
required
integer
amount_disputed
required
integer
currency
required
string

ISO 4217 currency code. Possible values include: CAD & USD. Note: as of today, currency supports a single value.

Enum: Description
USD

United States Dollar

CAD

Canadian Dollar

… 1 more
required
object
reference_id
required
string or null [ 1 .. 255 ] characters

A custom reference ID for your platform to track the object. It can be any string.

capture_at
required
integer or null <int64> >= 0
authorization_code
required
string or null

Authorization code returned from the card issuer after a credit card payment is authorized

api_version
string
auto_capture
boolean
object or null

Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data.

object or null
fee_amount
integer
fee_amount_refundable
integer
fee_type
string

Specifies the fee type your platform will use to collect fee from the payment.

Enum: Description
rent_surcharge

rent surcharge fee type for which collect net income and corresponding taxes for the merchant(landlord), i.e direct tax ONLY on the rent amount(amount - fee_amount)

platform_fee

platform fee type

initiated_by
string

Indicates who initiated a payment. Possible values include: customer, merchant, none.

Enum: Description
customer
merchant
… 1 more
object or null

The resource ID and path for the Order that your app created and associated with the payment.

Array of objects or null
object or null

THIS SHOULD NOT SHOW UP

object or null

THIS SHOULD NOT SHOW UP

400

INVALID_PARAMS, PARAM_IS_MISSING, PARAM_VALUE_IS_TOO_SMALL_INCLUSIVE, FEE_EXCEEDS_PAYMENT_AMOUNT_THRESHOLD_PERCENTAGE

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples
application/json
{
  • "amounts": {
    • "amount": 1500,
    • "currency": "USD",
    • "fee_amount": 150
    },
  • "custom_data": {
    • "foo": "bar"
    }
}
Response samples
application/json
{
  • "amount": 1000,
  • "amount_refunded": 1000,
  • "amount_disputed": 1000,
  • "auto_capture": false,
  • "capture_at": null,
  • "create_time": 1510080179,
  • "currency": "USD",
  • "custom_data": {
    • "foo": "bar"
    },
  • "failure_reason": null,
  • "fee_amount": 0,
  • "fee_amount_refundable": 0,
  • "id": "00000000-0000-0000-0000-0000767bf5cd",
  • "order": null,
  • "owner": {
    • "id": "be2b42e5-b808-40ae-9bbe-3291ab493f57",
    • "path": "/accounts/be2b42e5-b808-40ae-9bbe-3291ab493f57",
    • "resource": "accounts"
    },
  • "path": "/payments/00000000-0000-0000-0000-0000767bf5cd",
  • "payment_method": {
    • "id": "00000000-6363-0000-0000-000008b93a6e",
    • "path": "/payment_methods/00000000-6363-0000-0000-000008b93a6e",
    • "resource": "payment_methods"
    },
  • "pending_reasons": null,
  • "resource": "payments",
  • "status": "completed",
  • "authorization_code": "0224241",
  • "txnr_app_fee": null,
  • "txnr_merchant": null,
  • "initiated_by": "customer",
  • "api_version": "3.1",
  • "reference_id": "d6a60610-3a7e-4b9d-b56f-9005b9cd18ac"
}