regis

<back to all web services

BeanstreamCreditCardTokenPaymentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Beanstream/Payment/{uuid}/CreditCard/Token/Create
"use strict";
export class BeanstreamCreditCardCompletionResponse {
    /** @param {{uuid?:string,id?:string,approved?:boolean,message_id?:string,message?:string,order_number?:string,payment_method?:string,card_type?:string,card_last_four?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    id;
    /** @type {boolean} */
    approved;
    /** @type {string} */
    message_id;
    /** @type {string} */
    message;
    /** @type {string} */
    order_number;
    /** @type {string} */
    payment_method;
    /** @type {string} */
    card_type;
    /** @type {string} */
    card_last_four;
}
export class BeanstreamCreditCardTokenPaymentRequest {
    /** @param {{uuid?:string,department?:string,item?:string,amount?:number,name?:string,customer_ip?:string,email?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,phone?:string,token?:string,card_type?:string,token_last_four?:string,card_name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    department;
    /** @type {string} */
    item;
    /** @type {number} */
    amount;
    /** @type {string} */
    name;
    /** @type {string} */
    customer_ip;
    /** @type {string} */
    email;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    phone;
    /** @type {string} */
    token;
    /** @type {string} */
    card_type;
    /** @type {string} */
    token_last_four;
    /** @type {string} */
    card_name;
}

JavaScript BeanstreamCreditCardTokenPaymentRequest 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}/CreditCard/Token/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	department: String,
	item: String,
	amount: 0,
	name: String,
	customer_ip: String,
	email: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	phone: String,
	token: String,
	card_type: String,
	token_last_four: String,
	card_name: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	id: String,
	approved: False,
	message_id: String,
	message: String,
	order_number: String,
	payment_method: String,
	card_type: String,
	card_last_four: String
}