| 1 | package Business::NAB::BPAY::Payments::Results::DetailRecord; | ||||||||||||||||||||||||||||||||
| 2 | 2 | $Business::NAB::BPAY::Payments::Results::DetailRecord::VERSION = '0.11'; | |||||||||||||||||||||||||||||||
| 3 | =head1 NAME | ||||||||||||||||||||||||||||||||
| 4 | |||||||||||||||||||||||||||||||||
| 5 | Business::NAB::BPAY::Payments::Results::DetailRecord | ||||||||||||||||||||||||||||||||
| 6 | |||||||||||||||||||||||||||||||||
| 7 | =head1 SYNOPSIS | ||||||||||||||||||||||||||||||||
| 8 | |||||||||||||||||||||||||||||||||
| 9 | use Business::NAB::BPAY::Payments::Results::DetailRecord; | ||||||||||||||||||||||||||||||||
| 10 | |||||||||||||||||||||||||||||||||
| 11 | # parse | ||||||||||||||||||||||||||||||||
| 12 | my $Detail = Business::NAB::BPAY::Payments::Results::DetailRecord; | ||||||||||||||||||||||||||||||||
| 13 | ->new_from_record( $line ); | ||||||||||||||||||||||||||||||||
| 14 | |||||||||||||||||||||||||||||||||
| 15 | # create | ||||||||||||||||||||||||||||||||
| 16 | my $Detail = Business::NAB::BPAY::Payments::Results::DetailRecord->new( | ||||||||||||||||||||||||||||||||
| 17 | biller_code => $biller_code, | ||||||||||||||||||||||||||||||||
| 18 | payment_account_bsb => $payment_account_bsb, | ||||||||||||||||||||||||||||||||
| 19 | payment_account_number => $payment_account_number, | ||||||||||||||||||||||||||||||||
| 20 | customer_reference_number => $customer_reference_number, | ||||||||||||||||||||||||||||||||
| 21 | amount => $amount, | ||||||||||||||||||||||||||||||||
| 22 | lodgement_reference_1 => $lodgement_reference_1, | ||||||||||||||||||||||||||||||||
| 23 | lodgement_reference_2 => $lodgement_reference_2, | ||||||||||||||||||||||||||||||||
| 24 | lodgement_reference_3 => $lodgement_reference_3, | ||||||||||||||||||||||||||||||||
| 25 | return_code => $return_code, | ||||||||||||||||||||||||||||||||
| 26 | return_code_desc => $return_code_desc, | ||||||||||||||||||||||||||||||||
| 27 | transaction_reference_number => $transaction_reference_number, | ||||||||||||||||||||||||||||||||
| 28 | ); | ||||||||||||||||||||||||||||||||
| 29 | |||||||||||||||||||||||||||||||||
| 30 | my $line = $Detail->to_record; | ||||||||||||||||||||||||||||||||
| 31 | |||||||||||||||||||||||||||||||||
| 32 | =head1 DESCRIPTION | ||||||||||||||||||||||||||||||||
| 33 | |||||||||||||||||||||||||||||||||
| 34 | Class for detail record in the "BPAY Batch User Guide" responses | ||||||||||||||||||||||||||||||||
| 35 | |||||||||||||||||||||||||||||||||
| 36 | All methods and attributes are inherited from | ||||||||||||||||||||||||||||||||
| 37 | L<Business::NAB::BPAY::Payments::DetailRecord> | ||||||||||||||||||||||||||||||||
| 38 | |||||||||||||||||||||||||||||||||
| 39 | =cut | ||||||||||||||||||||||||||||||||
| 40 | |||||||||||||||||||||||||||||||||
| 41 | 2 | ▶ | use strict; | ||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||
| 42 | 2 | ▶ | use warnings; | ||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||
| 43 | 2 | ▶ | use feature qw/ signatures /; | ||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||
| 44 | |||||||||||||||||||||||||||||||||
| 45 | 2 | ▶ | use Moose; | ||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||
| 46 | 2 | extends 'Business::NAB::BPAY::Payments::DetailRecord'; | |||||||||||||||||||||||||||||||
| 47 | |||||||||||||||||||||||||||||||||
| 48 | 2 | ▶ | use Carp qw/ croak /; | ||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||
| 49 | 2 | ▶ | no warnings qw/ experimental::signatures /; | ||||||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||
| 50 | |||||||||||||||||||||||||||||||||
| 51 | =head1 ATTRIBUTES | ||||||||||||||||||||||||||||||||
| 52 | |||||||||||||||||||||||||||||||||
| 53 | Additional attributes are inherited from | ||||||||||||||||||||||||||||||||
| 54 | L<Business::NAB::BPAY::Payments::DetailRecord> | ||||||||||||||||||||||||||||||||
| 55 | |||||||||||||||||||||||||||||||||
| 56 | =over | ||||||||||||||||||||||||||||||||
| 57 | |||||||||||||||||||||||||||||||||
| 58 | =item return_code (Str, max length 4) | ||||||||||||||||||||||||||||||||
| 59 | |||||||||||||||||||||||||||||||||
| 60 | =item return_code_desc (Str, max length 50) | ||||||||||||||||||||||||||||||||
| 61 | |||||||||||||||||||||||||||||||||
| 62 | =item transaction_reference_number (Str, max length 21) | ||||||||||||||||||||||||||||||||
| 63 | |||||||||||||||||||||||||||||||||
| 64 | =back | ||||||||||||||||||||||||||||||||
| 65 | |||||||||||||||||||||||||||||||||
| 66 | =cut | ||||||||||||||||||||||||||||||||
| 67 | |||||||||||||||||||||||||||||||||
| 68 | 2 | foreach my $str_attr ( | |||||||||||||||||||||||||||||||
| 69 | 'return_code[4]', | ||||||||||||||||||||||||||||||||
| 70 | 'return_code_desc[50]', | ||||||||||||||||||||||||||||||||
| 71 | 'transaction_reference_number[21]', | ||||||||||||||||||||||||||||||||
| 72 | ) { | ||||||||||||||||||||||||||||||||
| 73 | 6 | __PACKAGE__->add_max_string_attribute( | |||||||||||||||||||||||||||||||
| 74 | $str_attr, | ||||||||||||||||||||||||||||||||
| 75 | is => 'ro', | ||||||||||||||||||||||||||||||||
| 76 | required => 0, | ||||||||||||||||||||||||||||||||
| 77 | ); | ||||||||||||||||||||||||||||||||
| 78 | } | ||||||||||||||||||||||||||||||||
| 79 | |||||||||||||||||||||||||||||||||
| 80 | 23 | ▶ | sub _pack_template { | ||||||||||||||||||||||||||||||
|
Subroutine
_pack_template: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||||||
| 81 | 23 | return "A1 A10 A6 A9 A20 A13 A10 A20 A50 A4 A50 A21"; | |||||||||||||||||||||||||||||||
| 82 | } | ||||||||||||||||||||||||||||||||
| 83 | |||||||||||||||||||||||||||||||||
| 84 | =head1 METHODS | ||||||||||||||||||||||||||||||||
| 85 | |||||||||||||||||||||||||||||||||
| 86 | See L<Business::NAB::BPAY::Payments::DetailRecord> for details of | ||||||||||||||||||||||||||||||||
| 87 | C<new_from_record> and C<to_record> | ||||||||||||||||||||||||||||||||
| 88 | |||||||||||||||||||||||||||||||||
| 89 | =cut | ||||||||||||||||||||||||||||||||
| 90 | |||||||||||||||||||||||||||||||||
| 91 | 7 | ▶ | sub new_from_record ( $class, $line ) { | ||||||||||||||||||||||||||||||
|
Subroutine
new_from_record: called CC=2 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||||||
| 92 | |||||||||||||||||||||||||||||||||
| 93 | # undef being "this space intentionally left blank" | ||||||||||||||||||||||||||||||||
| 94 | my ( | ||||||||||||||||||||||||||||||||
| 95 | 7 | $record_type, | |||||||||||||||||||||||||||||||
| 96 | $biller_code, | ||||||||||||||||||||||||||||||||
| 97 | $payment_account_bsb, | ||||||||||||||||||||||||||||||||
| 98 | $payment_account_number, | ||||||||||||||||||||||||||||||||
| 99 | $customer_reference_number, | ||||||||||||||||||||||||||||||||
| 100 | $amount, | ||||||||||||||||||||||||||||||||
| 101 | $lodgement_reference_1, | ||||||||||||||||||||||||||||||||
| 102 | $lodgement_reference_2, | ||||||||||||||||||||||||||||||||
| 103 | $lodgement_reference_3, | ||||||||||||||||||||||||||||||||
| 104 | $return_code, | ||||||||||||||||||||||||||||||||
| 105 | $return_code_desc, | ||||||||||||||||||||||||||||||||
| 106 | $trans_ref_number, | ||||||||||||||||||||||||||||||||
| 107 | ) = unpack( $class->_pack_template(), $line ); | ||||||||||||||||||||||||||||||||
| 108 | |||||||||||||||||||||||||||||||||
| 109 | 7 | ▶ | if ( $record_type ne '2' ) { | ||||||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||||||
| 110 | 1 | croak( "unsupported record type ($record_type)" ); | |||||||||||||||||||||||||||||||
| 111 | } | ||||||||||||||||||||||||||||||||
| 112 | |||||||||||||||||||||||||||||||||
| 113 | 6 | $biller_code =~ s/^0+//; | |||||||||||||||||||||||||||||||
| 114 | 6 | $amount =~ s/^0+//; | |||||||||||||||||||||||||||||||
| 115 | |||||||||||||||||||||||||||||||||
| 116 | 6 | return $class->new( | |||||||||||||||||||||||||||||||
| 117 | biller_code => $biller_code, | ||||||||||||||||||||||||||||||||
| 118 | payment_account_bsb => $payment_account_bsb, | ||||||||||||||||||||||||||||||||
| 119 | payment_account_number => $payment_account_number, | ||||||||||||||||||||||||||||||||
| 120 | customer_reference_number => $customer_reference_number, | ||||||||||||||||||||||||||||||||
| 121 | amount => $amount, | ||||||||||||||||||||||||||||||||
| 122 | lodgement_reference_1 => $lodgement_reference_1, | ||||||||||||||||||||||||||||||||
| 123 | lodgement_reference_2 => $lodgement_reference_2, | ||||||||||||||||||||||||||||||||
| 124 | lodgement_reference_3 => $lodgement_reference_3, | ||||||||||||||||||||||||||||||||
| 125 | return_code => $return_code, | ||||||||||||||||||||||||||||||||
| 126 | return_code_desc => $return_code_desc, | ||||||||||||||||||||||||||||||||
| 127 | transaction_reference_number => $trans_ref_number, | ||||||||||||||||||||||||||||||||
| 128 | ); | ||||||||||||||||||||||||||||||||
| 129 | } | ||||||||||||||||||||||||||||||||
| 130 | |||||||||||||||||||||||||||||||||
| 131 | =head2 is_successful | ||||||||||||||||||||||||||||||||
| 132 | |||||||||||||||||||||||||||||||||
| 133 | =head2 is_failed | ||||||||||||||||||||||||||||||||
| 134 | |||||||||||||||||||||||||||||||||
| 135 | Boolean check on if the transaction in question was successful or not | ||||||||||||||||||||||||||||||||
| 136 | |||||||||||||||||||||||||||||||||
| 137 | if ( $Detail->is_successful ) { | ||||||||||||||||||||||||||||||||
| 138 | ... | ||||||||||||||||||||||||||||||||
| 139 | } | ||||||||||||||||||||||||||||||||
| 140 | |||||||||||||||||||||||||||||||||
| 141 | =cut | ||||||||||||||||||||||||||||||||
| 142 | |||||||||||||||||||||||||||||||||
| 143 | 7 | ▶ | sub is_successful ( $self ) { return $self->return_code eq '0000' } | ||||||||||||||||||||||||||||||
|
Subroutine
is_successful: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||
| 144 | 1 | ▶ | sub is_failed ( $self ) { return !$self->is_successful } | ||||||||||||||||||||||||||||||
|
Subroutine
is_failed: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||||||
| 145 | |||||||||||||||||||||||||||||||||
| 146 | 16 | ▶ | sub to_record ( $self ) { | ||||||||||||||||||||||||||||||
|
Subroutine
to_record: called CC=4 SCAR=13.9
Pod
documented
| |||||||||||||||||||||||||||||||||
| 147 | |||||||||||||||||||||||||||||||||
| 148 | # remove the - char (well, any non-digits). the various specs are | ||||||||||||||||||||||||||||||||
| 149 | # a bit all over the place, some keep this char and some don't | ||||||||||||||||||||||||||||||||
| 150 | 16 | my $bsb = $self->payment_account_bsb =~ s/\D//gr; | |||||||||||||||||||||||||||||||
| 151 | |||||||||||||||||||||||||||||||||
| 152 | 16 | ▶ | my $record = pack( | ||||||||||||||||||||||||||||||
|
Condition83%5/6
$self->lodgement_reference_1 // ""
$self->lodgement_reference_2 // ""
$self->lodgement_reference_3 // ""
MC/DC0%0/1
$self->lodgement_reference_1 // ""
$self->lodgement_reference_1
MC/DC100%1/1
$self->lodgement_reference_2 // ""
$self->lodgement_reference_2
MC/DC100%1/1
$self->lodgement_reference_3 // ""
$self->lodgement_reference_3
Truth table50%1/2
A
A= $self->lodgement_reference_1
Truth table100%2/2
A
A= $self->lodgement_reference_2
Truth table100%2/2
A
A= $self->lodgement_reference_3
| |||||||||||||||||||||||||||||||||
| 153 | $self->_pack_template(), | ||||||||||||||||||||||||||||||||
| 154 | "2", | ||||||||||||||||||||||||||||||||
| 155 | sprintf( "%010s", $self->biller_code ), | ||||||||||||||||||||||||||||||||
| 156 | $bsb, | ||||||||||||||||||||||||||||||||
| 157 | $self->payment_account_number, | ||||||||||||||||||||||||||||||||
| 158 | $self->customer_reference_number, | ||||||||||||||||||||||||||||||||
| 159 | sprintf( "%013.0f", $self->amount ), | ||||||||||||||||||||||||||||||||
| 160 | $self->lodgement_reference_1 // '', | ||||||||||||||||||||||||||||||||
| 161 | $self->lodgement_reference_2 // '', | ||||||||||||||||||||||||||||||||
| 162 | $self->lodgement_reference_3 // '', | ||||||||||||||||||||||||||||||||
| 163 | $self->return_code, | ||||||||||||||||||||||||||||||||
| 164 | $self->return_code_desc, | ||||||||||||||||||||||||||||||||
| 165 | $self->transaction_reference_number, | ||||||||||||||||||||||||||||||||
| 166 | ); | ||||||||||||||||||||||||||||||||
| 167 | |||||||||||||||||||||||||||||||||
| 168 | 16 | return $record; | |||||||||||||||||||||||||||||||
| 169 | } | ||||||||||||||||||||||||||||||||
| 170 | |||||||||||||||||||||||||||||||||
| 171 | =head1 SEE ALSO | ||||||||||||||||||||||||||||||||
| 172 | |||||||||||||||||||||||||||||||||
| 173 | L<Business::NAB::Types> | ||||||||||||||||||||||||||||||||
| 174 | |||||||||||||||||||||||||||||||||
| 175 | L<Business::NAB::BPAY::Payments::Results::DetailRecord> | ||||||||||||||||||||||||||||||||
| 176 | |||||||||||||||||||||||||||||||||
| 177 | =cut | ||||||||||||||||||||||||||||||||
| 178 | |||||||||||||||||||||||||||||||||
| 179 | 2 | __PACKAGE__->meta->make_immutable; | |||||||||||||||||||||||||||||||