iFrame JavaScript SDK Specification

This endpoint will return a JSON Web Token (JWT) that should be used with the Authorization header when sending requests that require authorization.

This endpoint takes a previously-authorized JWT and creates a new JWT with an extended expiration date. Data stored within the token will stay the same and the user will still have access to the endpoints. To use this function, send a valid JWT through the Authorization header and replace your stored JWT with the token response upon success. This endpoint can only refresh valid JWTs signed by this application. Invalid or expired JWTs are unauthorized and will return as such.

This endpoint logs out of and expires a JWT. This requires a previously-authorized JWT. See the /auth endpoint for more information on obtaining a JWT.

This endpoint is used to submit a one-time or recurring payment. Pass in the information from your payment form including the hidden card-token field. Include the token (JWT) received in the Authentication call.

To create a recurring payment, pass in the additional fields specified in the schema. Omitting these fields will submit a one-time payment.

This endpoint is used to get details about all recurring payments that have been created for a MID. Include the token (JWT) received in the Authentication call.

This endpoint is used to update a recurring payment. Pass in the MID and the recurring payment ID that was returned when the recurring payment was initially created. Include the token (JWT) received in the Authentication call.

Settings that can be updated include the recurring frequency, start date, end date, and transaction amount, but the payment card token that was initially used to create the recurring payment cannot be updated. If a new payment method is needed, a new recurring payment must be started.

This endpoint will void or refund a transaction. Transactions may be refunded if settlement has occurred or voided if settlement has not occurred. For any Sale or Preauth sent through the Payanywhere SDK, Payanywhere SDK will return the parameter “transactionUniqueId.” The “transactionUniqueId” has the format of “ccs_” followed by several numerical characters. For this request, you will need to parse the “transactionUniqueId” returned by the Payanywhere SDK, removing the “ccs_” portion of that string, and submit the remaining numerical value in the “transaction_id” field for Voids, or the “ccs_pk” field for Refunds.

For example, if the Payanywhere SDK returned “transactionUniqueId=ccs_87654321” then the “transaction_id” or “ccs_pk” for this request would equal “87654321”. Account ID is required to be inserted into this URL. Your Account ID will be returned from the Authentication request. Authorization is required for this endpoint. Use the JWT returned from the Authentication request.

For refunds, you can refund the full amount of the transaction or any amount less than the transaction amount. If you try and refund an amount greater than the transaction amount, a 400 error code will be returned with the message “Bad Request.”