How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Verifone Billing Agreement API

The Billing Agreement API from Verifone — 5 operation(s) for billing agreement.

Verifone Billing Agreement API is one of 27 APIs that Verifone publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Billing Agreement. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 5 paths, and defines 20 schemas. It is described by OpenAPI 3.0.1, at version 3.43.0.

Requests are made against 5 base URLs: https://emea.gsc.verifone.cloud/oidc/3ds-service, https://us.gsc.verifone.cloud/oidc/3ds-service, https://nz.gsc.verifone.cloud/oidc/3ds-service, https://cst.test-gsc.vfims.com/oidc/3ds-service, https://uscst-gb.gsc.vficloud.net/oidc/3ds-service.

5 operations 5 paths 20 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
3.43.0
Base URL
https://us.gsc.verifone.cloud/oidc/checkout-service
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

Verifone Billing Agreement API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BearerAuth — JWT Bearer token. Pass as: Authorization: Bearer . The JWT must be signed with your Verifone-provisioned private key and must include entityid, sub (userid), a…
  • BasicAuth — HTTP Basic authentication. Pass base64-encoded username:password as: Authorization: Basic .

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Billing Agreement 5
GET
/billingAgreement/{agreementId}
Get agreement details
getBillingagreementAgreementid 2 params → 200400401403404500
GET
/billingAgreement/token/{tokenId}
Show token details
getBillingagreementTokenTokenid 2 params → 200400401403404500
POST
/billingAgreement/create
Create billing agreement using token
postBillingagreementCreate 1 param body → 200400401403404500
POST
/billingAgreement/initiate
Initiate billing agreement
postBillingagreementInitiate body → 200400401403404500
POST
/billingAgreement/{agreementId}/cancel
Cancel agreement details
postBillingagreementAgreementidCancel 1 param body → 200400401403404500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Model32 (10 properties), Model17 (9 properties), Model8 (9 properties), Model30 (8 properties). Each schema is shown below with its type and property counts.

merchant
object
1 property
payerInfo
object
7 properties 2 required
allowedCountries
array
An array of legally accepted customer country codes
Model29
object
2 properties 2 required
billingAddress
object
Shipping Address details
6 properties 2 required
shippingAddress
object
7 properties 5 required
payeeInfo
object
1 property 1 required
Model17
object
9 properties 1 required
payer
object
1 property
Model30
object
8 properties 3 required
Model33
object
2 properties 2 required
details
object
Model31
object
Shipping Address details
6 properties 5 required
Model5
object
4 properties 2 required
Model8
object
9 properties 3 required
Model32
object
10 properties 1 required
redirectUrls
object
2 properties
merchantPreferences
object
5 properties
plan
object
1 property
Model38
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

verifone-billing-agreement-api-openapi.yml Raw ↑

Other APIs Verifone publishes across the network.

Verifone eCommerce API
Verifone 3D Secure API
Verifone Reporting API
Verifone PayPal eCommerce API
Verifone VHQ Device Management API
Verifone 3DS Authentication API
Verifone Batch API
Verifone Billing Plans API
Verifone Checkout API
Verifone Customer API
Verifone Ecom Payments API
Verifone Hardware Orders API
Where this information came from

This is an independent, third-party profile of Verifone Billing Agreement API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.