regis

<back to all web services

BeanstreamPaymentVerificationRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Beanstream/Payment/{uuid}/Verify
"use strict";
export class FinancePaymentResponse {
    /** @param {{paymentUUID?:string,order_id?:string,external_payment_id?:number,added_date?:string,regent_id?:number,uuid?:string,amount?:number,payment_type?:string,is_pushed_to_gl?:boolean,current_status?:string,current_status_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    paymentUUID;
    /** @type {string} */
    order_id;
    /** @type {number} */
    external_payment_id;
    /** @type {string} */
    added_date;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {number} */
    amount;
    /** @type {string} */
    payment_type;
    /** @type {boolean} */
    is_pushed_to_gl;
    /** @type {string} */
    current_status;
    /** @type {?string} */
    current_status_date;
}
export class BeanstreamPaymentVerificationRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript BeanstreamPaymentVerificationRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Beanstream/Payment/{uuid}/Verify HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	paymentUUID: String,
	order_id: String,
	external_payment_id: 0,
	added_date: 0001-01-01,
	regent_id: 0,
	uuid: String,
	amount: 0,
	payment_type: String,
	is_pushed_to_gl: False,
	current_status: String,
	current_status_date: 0001-01-01
}