@knuseski/c-pay v1.0.3
��# C P a y
C P a y i s a J a v a S c r i p t c l a s s t h a t f a c i l i t a t e s c r e a t i n g p a y m e n t s f o r m e r c h a n t s u s i n g t h e C P a y s e r v i c e .
# # F e a t u r e s
- E a s i l y c r e a t e p a y m e n t r e q u e s t f o r m s .
- G e n e r a t e c h e c k s u m s f o r d a t a i n t e g r i t y .
- C o n f i g u r e f o r t e s t o r p r o d u c t i o n e n v i r o n m e n t .
# # I n s t a l l a t i o n
T o u s e C P a y i n y o u r p r o j e c t , y o u c a n i n s t a l l i t v i a n p m :
b a s h
n p m i n s t a l l @ k n u s e s k i / c - p a y
# # U s a g e
j a v a s c r i p t
i m p o r t { C P a y } f r o m ' @ k n u s e s k i / c - p a y ' ;
/ / C r e a t e a n e w C P a y i n s t a n c e
c o n s t c P a y = n e w C P a y ( a u t h K e y , p a y T o M e r c h a n t , m e r c h a n t N a m e , p a y m e n t O k U r l , p a y m e n t F a i l U r l ) ;
/ / C r e a t e a p a y m e n t r e q u e s t f o r m
c o n s t p a y m e n t R e q u e s t F o r m = c P a y . c r e a t e F o r m A n d P o p u l a t e W i t h R e q u e s t D a t a ( p a y m e n t R e q u e s t ) ;
/ / G e n e r a t e a c h e c k s u m
c o n s t c h e c k s u m D a t a = c P a y . g e n e r a t e C h e c k s u m ( r e q u e s t B o d y ) ;
# # C o n s t r u c t o r
j a v a s c r i p t
n e w C P a y ( a u t h K e y , p a y T o M e r c h a n t , m e r c h a n t N a m e , p a y m e n t O k U r l , p a y m e n t F a i l U r l , i s P r o d u c t i o n )
- a u t h K e y : T h e a u t h e n t i c a t i o n k e y r e q u i r e d f o r C P a y A P I a u t h e n t i c a t i o n .
- p a y T o M e r c h a n t : T h e m e r c h a n t I D o r i d e n t i f i e r t o s p e c i f y t h e r e c i p i e n t o f t h e p a y m e n t .
- m e r c h a n t N a m e : T h e n a m e o f t h e m e r c h a n t t h a t i s i n i t i a t i n g t h e p a y m e n t .
- p a y m e n t O k U r l : T h e U R L t o r e d i r e c t t o a f t e r s u c c e s s f u l p a y m e n t .
- p a y m e n t F a i l U r l : T h e U R L t o r e d i r e c t t o a f t e r f a i l e d p a y m e n t o r c a n c e l l a t i o n .
- i s P r o d u c t i o n : I n d i c a t e s i f t h e r e q u e s t i s s e n t t o t h e t e s t o r p r o d u c t i o n e n v i r o n m e n t . D e f a u l t v a l u e i s f a l s e .
# # P u b l i c M e t h o d s
# # # c r e a t e F o r m A n d P o p u l a t e W i t h R e q u e s t D a t a ( p a y m e n t R e q u e s t )
C r e a t e a p a y m e n t r e q u e s t f o r m w i t h t h e p r o v i d e d r e q u e s t b o d y .
- p a y m e n t R e q u e s t : T h e r e q u e s t b o d y c o n t a i n i n g p a y m e n t i n f o r m a t i o n .
# # # g e n e r a t e C h e c k s u m ( r e q u e s t B o d y )
G e n e r a t e s a c h e c k s u m f o r t h e g i v e n r e q u e s t b o d y t o e n s u r e d a t a i n t e g r i t y .
- r e q u e s t B o d y ` : T h e r e q u e s t b o d y f o r w h i c h t h e c h e c k s u m i s t o b e g e n e r a t e d .
# # L i c e n s e
T h i s p r o j e c t i s l i c e n s e d u n d e r t h e M I T L i c e n s e s e e t h e L I C E N S E ( h t t p s : / / o p e n s o u r c e . o r g / l i c e n s e / m i t ) f i l e f o r d e t a i l s .