Start Billing Agreement Approval Process | Welcome to cash-app Documentation

curl -X POST https://global-api-sandbox.afterpay.com/v2/billing-agreements/approvals \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{
  "merchant": {
    "redirectConfirmUrl": "http://example.com/confirm",
    "redirectCancelUrl": "http://example.com/cancel"
  },
  "consumer": {
    "email": "test@example.com",
    "givenNames": "Joe",
    "surname": "Customer",
    "phoneNumber": "11111111111"
  },
  "merchantReference": "merchant-order-12345",
  "agreements": [
    {
      "type": "BILLING",
      "merchantReference": "merchant-order-12345"
    }
  ]
}'

Initiates the approval process for a new billing agreement.

Deprecated. For new integrations, see Grants.

Initiates the approval process for a new billing agreement. *Deprecated. For new integrations, see [Grants](https://afterpay.docs.buildwithfern.com/afterpay-online-developer/api-reference/reference/grants/start-grant-approval).*

Authentication

AuthorizationBasic

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

Request

This endpoint expects an object.

merchantobjectRequired

consumerobjectOptional

Consumer details for the billing agreement

merchantReferencestringOptional<=128 characters

Merchant's unique reference for this billing agreement

agreementslist of objectsOptional

Agreement type for approval (only single agreement is supported)

Response

The consumer approved the billing agreement

tokenstring

Token identifying this billing agreement approval request

expiresdatetime

When this approval request expires

redirectCheckoutUrlstringformat: "uri"

URL where the consumer should be redirected to complete approval

Errors

401

Start Billing Agreement Approval Request Unauthorized Error

403

Start Billing Agreement Approval Request Forbidden Error

415

Start Billing Agreement Approval Request Unsupported Media Type Error

422

Start Billing Agreement Approval Request Unprocessable Entity Error

1	{
2	"token": "ba_approval_xyz789abc123",
3	"expires": "2024-03-05T22:13:45Z",
4	"redirectCheckoutUrl": "https://portal.afterpay.com/us/checkout/ba-approval?token=ba_approval_xyz789abc123"
5	}

Authentication

Headers

Request

Response

Errors