APS React Types

PaymentAccountCardData

Property Type Description

Property	Type	Description
`cardNumber`	`string`
`cardType?`	`string`
`creditCardSecCode`	`string`
`displayName`	`string`
`expirationMonth`	`number`
`expirationYear`	`number`
`nameOnAccount`	`string`

cardNumber

string

cardType?

string

creditCardSecCode

string

displayName

string

expirationMonth

number

expirationYear

number

nameOnAccount

string

PaymentAccountFormData

extends Address, PaymentAccountCardData

Property

Type

Description

SelectedInstallment

Represents the currently selected installment plan and issuer/bank.

Property Type Description

Property	Type	Description
`issuer_code?`	`string`
`plan_code?`	`string`
`number_of_installment?`	`string`

issuer_code?

string

plan_code?

string

number_of_installment?

string

SignatureRequestProps

extends Record<string, string | string[]>

Properties to include for a signature request against the Broadleaf APS API.

Property Type Description

Property	Type	Description
`access_code`	`string`
`language`	`string`
`merchant_identifier`	`string`
`merchant_reference`	`string`
`return_url`	`string`
`service_command`	`string`

access_code

string

language

string

merchant_identifier

string

merchant_reference

string

return_url

string

service_command

string

ThreeDSecureResponse

Property Type Description

Property	Type	Description
`command`	`'AUTHORIZATION'`
`access_code`	`string`
`merchant_identifier`	`string`
`merchant_reference`	`string`
`language`	`string`
`return_url`	`string`
`amount`	`number`
`currency`	`string`
`signature`	`string`
`token_name`	`string`
`response_message`	`string`
`response_code`	`number`
`status`	`number`
`card_number`	`string`
`card_holder_name`	`string`
`payment_option`	`string`
`expiry_date`	`number`
`customer_email`	`string`
`customer_ip`	`string`
`eci`	`string`
`fort_id`	`string`
`authorization_code`	`number`
`settlement_reference`	`string`
`acquirer_response_code`	`number`

command

'AUTHORIZATION'

access_code

string

merchant_identifier

string

merchant_reference

string

language

string

return_url

string

amount

number

currency

string

signature

string

token_name

string

response_message

string

response_code

number

status

number

card_number

string

card_holder_name

string

payment_option

string

expiry_date

number

customer_email

string

customer_ip

string

eci

string

fort_id

string

authorization_code

number

settlement_reference

string

acquirer_response_code

number

TokenizationRequest

Property Type Description

Property	Type	Description
`service_command`	`'TOKENIZATION'`
`access_code`	`string`
`merchant_identifier`	`string`
`merchant_reference`	`string`
`language`	`string`
`return_url`	`string`
`card_number`	`number`
`expiry_date`	`number`
`card_security_code`	`number`
`signature`	`string`
`token_name?`	`string`
`card_holder_name?`	`string`
`remember_me?`	`'YES' \| 'NO'`

service_command

'TOKENIZATION'

access_code

string

merchant_identifier

string

merchant_reference

string

language

string

return_url

string

card_number

number

expiry_date

number

card_security_code

number

signature

string

token_name?

string

card_holder_name?

string

remember_me?

'YES' | 'NO'

TokenizationResponse

Property Type Description

Property	Type	Description
`service_command`	`'TOKENIZATION'`
`access_code`	`string`
`merchant_identifier`	`string`
`merchant_reference`	`string`
`language`	`string`
`return_url`	`string`
`card_number`	`string`
`expiry_date`	`string`
`signature`	`string`
`token_name`	`string`
`response_message`	`string`
`response_code`	`string`
`status`	`string`
`cardHolderName`	`string`
`card_bin`	`string`
`remember_me`	`'YES' \| 'NO'`

service_command

'TOKENIZATION'

access_code

string

merchant_identifier

string

merchant_reference

string

language

string

return_url

string

card_number

string

expiry_date

string

signature

string

token_name

string

response_message

string

response_code

string

status

string

cardHolderName

string

card_bin

string

remember_me

'YES' | 'NO'

TokenServiceRequest

Property Type Description

Property	Type	Description
`service_command`	`'CREATE_TOKEN'`
`access_code`	`string`
`merchant_identifier`	`string`
`merchant_reference`	`string`
`language`	`string`
`return_url`	`string`
`card_number`	`number`
`expiry_date`	`number`
`signature`	`string`
`currency?`	`string`
`token_name?`	`string`
`cardHolderName?`	`string`

service_command

'CREATE_TOKEN'

access_code

string

merchant_identifier

string

merchant_reference

string

language

string

return_url

string

card_number

number

expiry_date

number

signature

string

currency?

string

token_name?

string

cardHolderName?

string

TokenServiceResponse

Property Type Description

Property	Type	Description
`service_command`	`'CREATE_TOKEN'`
`access_code`	`string`
`merchant_identifier`	`string`
`merchant_reference`	`string`
`language`	`string`
`return_url`	`string`
`card_number`	`number`
`expiry_date`	`number`
`signature`	`string`
`currency`	`string`
`token_name`	`string`
`cardHolderName`	`string`
`response_message`	`string`
`response_code`	`number`
`status`	`number`

service_command

'CREATE_TOKEN'

access_code

string

merchant_identifier

string

merchant_reference

string

language

string

return_url

string

card_number

number

expiry_date

number

signature

string

currency

string

token_name

string

cardHolderName

string

response_message

string

response_code

number

status

number