Capture Full Recurring Payment

Creates and immediately captures a recurring payment using a billing agreement token. This endpoint combines authorization and capture into a single step.

Deprecated. For new integrations, see Grants.

post/v2/recurring-payments

Request

  • Base URL: https://global-api-sandbox.afterpay.com
  • URL: https://global-api-sandbox.afterpay.com/v2/recurring-payments
  • Auth: HTTP basic

Headers

User-Agentstring required
Accept'application/json' required

Request body

requestIdstring uuid required

A unique identifier for the request, used for idempotency

descriptionstring
merchantReferencestring

The reference/order ID in the merchant's system

customobject

Custom key-value pairs for merchant use

paymentScheduleChecksumstring

Payment schedule validation checksum

Response

StatusDescription
APPROVEDIf payment is approved by Afterpay, returns a Payment object in response, with a status of "APPROVED".
DECLINEDIf payment is declined by Afterpay, for example, if expired payment method, returns a Payment object in response, with a status of "DECLINED". Please advise the consumer to contact the Afterpay Customer Service team for more information.
idstring

The unique, permanent, Afterpay generated Order ID.

tokenstring

The token obtained from the checkout call

status'APPROVED' | 'DECLINED'

represents the status of the order

createdstring

is the UTC timestamp of when the payment was completed.

paymentState'AUTH_APPROVED' | 'AUTH_DECLINED' | 'PARTIALLY_CAPTURED' | 'CAPTURED' | 'CAPTURE_DECLINED' | 'VOIDED'

is the current state for capturing payments

merchantReferencestring

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

Changes

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