Card: Credit Card Direct Payment

id

Y

string

The ID of the payment is used to ensure the idempotence of the request and avoid repeated deductions for one payment.

app_id

Y

string

Payments app ID.

account_id

Y

string

The ID of the merchant in the third-party payment provider, such as merNo, Account, etc.

shoplazza_order_id

Y

string

Order ID. During the payment process, multiple browser tabs may be opened to initiate payment for the same order, and a shoplazza_order_id can only be paid once.

amount

Y

string

Order amount, reserved to two decimal places.

currency

Y

string

Currency code, e.g., CAD.

products

Y

string

Payment product information in JSON string format.

cancel_url

Y

string

URL the customer is redirected to when they cancel the payment.

complete_url

Y

string

Payment result synchronization notification address.

callback_url

Y

string

Payment result asynchronous notification address.

customer_email

N

string

Customer's email address.

customer_phone_number

N

string

Customer's phone number.

customer_billing_address1

Y

string

Billing address line 1.

customer_billing_address2

N

string

Billing address line 2.

customer_billing_last_name

Y

string

Billing last name.

customer_billing_first_name

Y

string

Billing first name.

customer_billing_province

Y

string

Billing province.

customer_billing_city

Y

string

Billing city.

customer_billing_postal_code

Y

string

Billing postal code.

customer_billing_country_code

Y

string

Billing country code.

customer_billing_company

Y

string

Billing company.

customer_billing_state

Y

string

Billing state.

customer_billing_phone

Y

string

Billing phone number.

customer_shipping_address1

Y

string

Shipping address line 1.

customer_shipping_address2

N

string

Shipping address line 2.

customer_shipping_last_name

Y

string

Shipping last name.

customer_shipping_first_name

Y

string

Shipping first name.

customer_shipping_province

Y

string

Shipping province.

customer_shipping_city

Y

string

Shipping city.

customer_shipping_postal_code

Y

string

Shipping postal code.

customer_shipping_country_code

Y

string

Shipping country code.

customer_shipping_company

Y

string

Shipping company.

customer_shipping_state

Y

string

Shipping state.

customer_shipping_phone

N

string

Shipping phone number.

test

N

boolean

Whether the request is in test mode (true or false).

type

Y

string

Payment type:
- sale: Redirect payment
- card: Direct credit card payment

cards

N

string

Serialized JSON object containing credit card information for direct payments.

cards.first_name

N

string

First name on the card (e.g., Percy).

cards.last_name

N

string

Last name on the card (e.g., Parker).

cards.card_number

N

string

Credit card number (e.g., 4242424242424242).

cards.expire_year

N

string

Expiration year (2 digits, e.g., 23).

cards.expire_month

N

string

Expiration month (2 digits, e.g., 06).

cards.card_cvv

N

string

CVV (3 or 4 digits, e.g., 123).

timestamp

Y

long

Timestamp of the request (e.g., 1697704968).

app_id

Y

string

Payments app ID.

payment_id

Y

string

Payment ID, returns the ID of the request message.

amount

Y

string

Order amount.

currency

Y

string

Currency type.

status

Y

string

Payment status:
- paid: Payment successful
- failed: Payment failure
- paying: Processing payment

transaction_no

Y

string

Third-party payment system order number.

type

Y

string

Payment type, e.g., sale.

message

N

string

Payment failure message, required if payment fails.

error_code

N

string

Error code (required when status is failed).

test

Y

boolean

Indicates whether the transaction was in test mode.

extension

N

object

Custom extended fields.

timestamp

Y

long

ISO 8601 formatted timestamp, e.g., 2021-09-01T18:32:20Z.