# Beanstream Payments API

> Beanstream Payments API on Apizie: 15 endpoints (Make Payment, Get payment, Complete pre-auth, Return payment, …) returned as clean JSON through one API key. 15 endpoints are live now. Call it over REST at https://zieapi.vercel.app/v1/payments:beanstream/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:beanstream`
- Category: Payments
- Status: live
- Source: https://beanstream.com
- Page: https://zieapi.vercel.app/api/payments/beanstream
- OpenAPI: https://zieapi.vercel.app/api/payments/beanstream/openapi.json

https://www.beanstream.com/api/v1

## Endpoints

### Make Payment
`POST https://zieapi.vercel.app/v1/payments:beanstream/post-payments`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get payment
`GET https://zieapi.vercel.app/v1/payments:beanstream/get-payments-trans-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| transId | number | yes | The transaction id. |

### Complete pre-auth
`POST https://zieapi.vercel.app/v1/payments:beanstream/post-payments-trans-id-completions`

| Parameter | Type | Required | Description |
|---|---|---|---|
| transId | number | yes | The transaction id. |
| body | object | no | JSON request body |

### Return payment
`POST https://zieapi.vercel.app/v1/payments:beanstream/post-payments-trans-id-returns`

| Parameter | Type | Required | Description |
|---|---|---|---|
| transId | number | yes | The transaction id. |
| body | object | yes | JSON request body |

### Void Transaction
`POST https://zieapi.vercel.app/v1/payments:beanstream/post-payments-trans-id-void`

| Parameter | Type | Required | Description |
|---|---|---|---|
| transId | number | yes | The transaction id to void. |
| body | object | yes | JSON request body |

### Create Profile
`POST https://zieapi.vercel.app/v1/payments:beanstream/post-profiles`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get profile
`GET https://zieapi.vercel.app/v1/payments:beanstream/get-profiles-profile-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| profileId | string | yes | The profile id. (aka CustomerCode) |

### Update Profile
`POST https://zieapi.vercel.app/v1/payments:beanstream/put-profiles-profile-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| profileId | string | yes | The profile id. (aka CustomerCode) |
| body | object | yes | JSON request body |

### Delete profile
`POST https://zieapi.vercel.app/v1/payments:beanstream/delete-profiles-profile-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| profileId | string | yes | The profile id. (aka CustomerCode) |

### Get cards
`GET https://zieapi.vercel.app/v1/payments:beanstream/get-profiles-profile-id-cards`

| Parameter | Type | Required | Description |
|---|---|---|---|
| profileId | string | yes | The profile id. (aka CustomerCode) |

### Add card
`POST https://zieapi.vercel.app/v1/payments:beanstream/post-profiles-profile-id-cards`

| Parameter | Type | Required | Description |
|---|---|---|---|
| profileId | string | yes | The profile id. (aka CustomerCode) |
| body | object | yes | JSON request body |

### Update card
`POST https://zieapi.vercel.app/v1/payments:beanstream/put-profiles-profile-id-cards-card-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| profileId | string | yes | The profile id. (aka CustomerCode) |
| cardId | number | yes | The card id. |
| body | object | yes | JSON request body |

### Delete card
`POST https://zieapi.vercel.app/v1/payments:beanstream/delete-profiles-profile-id-cards-card-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| profileId | string | yes | The profile id. (aka CustomerCode) |
| cardId | number | yes | The card id. |

### Search Query
`POST https://zieapi.vercel.app/v1/payments:beanstream/post-reports`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Tokenize credit card
`POST https://zieapi.vercel.app/v1/payments:beanstream/post-scripts-tokenization-tokens`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/payments:beanstream/post-payments" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the Beanstream Payments API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/payments:beanstream/post-payments with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Beanstream Payments API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the Beanstream Payments API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:beanstream.

### What is the status of the Beanstream Payments API?
Live: works with just an Apizie key