API docs by Redocly

Payments API (3.1.2)

Download OpenAPI specification:Download

Generates a unique URL where a customer can add a credit card or bank account to their account. If the customer does not have a Zuora account, the API will create one for them.

Token

Creates a Token

Authorizations:
Api-Token
header Parameters
Content-Type
required
string
Value: "application/json"
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6IjVlYzdlMDNjLTlkMDMtMTFlZC1iNzQ0LTAyNDJhYzFjMDAwNiIsImFwcCI6ImxvY2FsIiwianRpIjoiNWVlMGJlZWEtOWQwMy0xMWVkLWExMDktMDI0MmFjMWMwMDA2IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQ2ODczMzIsImV4cCI6NDgzMDM2MDkzMn0.K7U1N9XskKBFcA50uImfrRiOW-n8ogov-vNzXt4l0nM
Request Body schema: application/json
required
userId
required
string <uuid>
name
required
string
surname
required
string
email
required
string <email>
address1
required
string
address2
string
city
required
string
state
required
string <abbr>
postalCode
required
string <zip-code>
phoneNumber
required
string <phone>

Responses

Request samples

Content type
application/json
{
  • "userId": "7d59d4a3-7f60-47c1-8934-2df132c2bc1c",
  • "name": "John",
  • "surname": "Doe",
  • "email": "john.doe@uscca.com",
  • "address1": "1000 Freedom Way",
  • "address2": "",
  • "city": "West Bend",
  • "state": "WI",
  • "postalCode": "53095",
  • "phoneNumber": "765-123-4567"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Payment Session

Creates a Payment Session

Authorizations:
Api-Token
header Parameters
Content-Type
required
string
Value: "application/json"
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6IjVlYzdlMDNjLTlkMDMtMTFlZC1iNzQ0LTAyNDJhYzFjMDAwNiIsImFwcCI6ImxvY2FsIiwianRpIjoiNWVlMGJlZWEtOWQwMy0xMWVkLWExMDktMDI0MmFjMWMwMDA2IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQ2ODczMzIsImV4cCI6NDgzMDM2MDkzMn0.K7U1N9XskKBFcA50uImfrRiOW-n8ogov-vNzXt4l0nM
Request Body schema: application/json
required
accountId
required
string
amount
required
number <float (0-2 decimal places)>
processPayment
required
boolean

Responses

Request samples

Content type
application/json
{
  • "accountId": "8ac699597d0f30af017d0fff3689425c",
  • "amount": 12.34,
  • "processPayment": false
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Hosted Payment Form

Retrieves a Hosted Payment Form

Authorizations:
Api-Token
path Parameters
token
required
string <uuid>
Example: dfe8f8fe-ca5d-11ed-a00a-0242ac170005
query Parameters
pageId
string
Example: pageId=8ac69797852f02c601853166e6cd228c
header Parameters
Content-Type
required
string
Value: "text/html"

Responses

Callback

Performs Hosted Payment Form Callback Functions

Authorizations:
Api-Token
query Parameters
refId
required
string
Example: refId=8ac691a07d0f30b3017d105608784874
token
required
string
Example: token=91Li5FlEKcJXCYcXMtFv1B9q2UjJe8XL
sig
required
string
Example: sig=Ell9fekLH5kdOeThhDZmRepC0OHDykv9Nfru7KzhVa0vODbTNBn+M75/3YiZarZCEFPXKU4XqhpSZ8uVWkY/qhD4krQiLdfC8MyUfs7jLghoOcuSAmQKaiXUuuxz6Xi5+KTNQcArcwLWr4vtN97HTdYz7K7DIy476RnILz7DO3FS0b6ZpedYbyr5cGCc2DLFlva5qckrii5V4vt6k0bH3fl32vJvdsrx3AOZEOi+DXrygSNtm6A2S63IyRCHQ2ZjT5875bN1MMlhqRXp3aNF7d2g5G18sxJ18ZF7FcEvHLFlvPMRW2w+7dr8+O4YGDCcUhyccXReivoj4ppGvNgmug==
header Parameters
Content-Type
required
string
Value: "text/html"

Responses