# Assembly Payments Pay IDs API

**Canonical:** https://apis.io/apis/assembly-payments/assembly-payments-payids-api/  
**Provider:** Assembly Payments — https://apis.io/providers/assembly-payments/  
**Base URL:** https://secure.api.promisepay.com  
**Documentation:** https://developer.hellozai.com/reference/overview

Assembly Payments Pay IDs API is one of 31 APIs that [Assembly Payments](https://apis.io/providers/assembly-payments/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 25 JSON Schema definitions. Tagged areas include PayIDs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 25 JSON Schemas.

The PayIDs API from Assembly Payments — 3 operation(s) for payids.

## Operations (3)

| Method | Path | Summary |
|---|---|---|
| GET | `/pay_ids/{id}` | Retrieve a PayID |
| PATCH | `/pay_ids/{id}/status` | Update PayID Status |
| POST | `/virtual_accounts/{id}/pay_ids` | Register PayID |

## Machine-readable artifacts (32)

- **OpenAPI** — https://artifacts.apis.io/assembly-payments/openapi/assembly-payments-payids-api-openapi.yml
- **Documentation** — https://developer.hellozai.com/reference/overview
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-npp-last-domestic-leg-request-body-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-user-request-body-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-update-user-request-body-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-charge-request-body-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-bank-account-request-body-au-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-item-request-body-schema.json
- **Documentation** — https://developer.hellozai.com/reference/overview-va
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-virtual-account-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-pay-id-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-pay-id-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-update-va-status-resp-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-deregister-pay-id-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-virtual-accounts-list-schema.json
- **Documentation** — https://developer.hellozai.com/reference/overview-1
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-initiate-payment-status-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-agreement-details-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-validate-agreement-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-amend-agreement-details-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-initiate-payment-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-initiate-payment-response-schema.json
- **Documentation** — https://developer.hellozai.com/reference/async-overview
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-make-payment-request-body-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-status-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-callbacks-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-single-item-schema.json
- **Documentation** — https://developer.hellozai.com/reference
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-payment-data-schema.json
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-supplementary-data-schema.json
- **Documentation** — https://developer.hellozai.com/reference/npplastdomesticleg-1
- **JSONSchema** — https://artifacts.apis.io/assembly-payments/json-schema/assembly-payments-npp-last-domestic-leg-disbursement-schema.json

## Other Assembly Payments APIs (12)

- [Webhooks API](https://apis.io/apis/assembly-payments/webhooks-api/)
- [Assembly Payments Addresses API](https://apis.io/apis/assembly-payments/assembly-payments-addresses-api/)
- [Assembly Payments Authentication API](https://apis.io/apis/assembly-payments/assembly-payments-authentication-api/)
- [Assembly Payments Bank Accounts API](https://apis.io/apis/assembly-payments/assembly-payments-bank-accounts-api/)
- [Assembly Payments Batch Transactions API](https://apis.io/apis/assembly-payments/assembly-payments-batch-transactions-api/)
- [Assembly Payments BPay Accounts API](https://apis.io/apis/assembly-payments/assembly-payments-bpay-accounts-api/)
- [Assembly Payments Callbacks API](https://apis.io/apis/assembly-payments/assembly-payments-callbacks-api/)
- [Assembly Payments Card Accounts API](https://apis.io/apis/assembly-payments/assembly-payments-card-accounts-api/)
- [Assembly Payments Charges API](https://apis.io/apis/assembly-payments/assembly-payments-charges-api/)
- [Assembly Payments Companies API](https://apis.io/apis/assembly-payments/assembly-payments-companies-api/)
- [Assembly Payments Direct Debit Authorities API](https://apis.io/apis/assembly-payments/assembly-payments-direct-debit-authorities-api/)
- [Assembly Payments Disbursements API](https://apis.io/apis/assembly-payments/assembly-payments-disbursements-api/)

## Tags

PayIDs

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/assembly-payments/assembly-payments-payids-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/assembly-payments/.