Documentation

amount

-

number

Required

-

-

Positive amount in ZAR. Converted to cents (x100, rounded). PayJustNow also validates against the merchant's min/max limits set at gateway installation.

Payment amount.

500

Merchant

currency

-

string

Required

-

ZAR

Only ZAR is configured for this payment.

Currency of the payment.

ZAR

Merchant

country

-

string

Optional

-

ZA

-

Country of the payment.

ZA

Merchant

payment_method

-

object

Required

-

-

-

Payment method object. Only type is needed; fields can be empty.

{"type": "za_payjustnow_ewallet", "fields": {}}

Merchant

type

payment_method

string

Required

-

za_payjustnow_ewallet

-

Payment method type.

za_payjustnow_ewallet

Merchant

complete_payment_url

-

string

Required

-

Valid URL

Required by payment's payment_options.

Where the customer is sent after completing the PayJustNow checkout.

https://merchant.example.com/success

Merchant

error_payment_url

-

string

Required

-

Valid URL

Required by payment payment_options.

Where the customer is sent if they cancel or an error occurs.

https://merchant.example.com/error

Merchant

customer

-

object or string

Required

-

Customer object or customer ID (cus_...)

Required by payment'd payment_options. Must contain name, email and phone_number.

Customer details.

{"name": "Jane Smith", "email": "jane@example.com", "phone_number": "0821234567"}

Merchant

name

customer

string

Required

-

-

Regex ^[0-9a-zA-Z ]{1,128}$ (letters, digits, spaces; max 128).

Customer full name. Send first and last name.

Jane Smith

Merchant

email

customer

string

Required

-

Valid email

Regex limits length to 100 chars.

Customer email.

jane@example.com

Merchant

phone_number

customer

string

Required

-

-

Regex ^([0-9+ ()-]){10,20}$.

Customer phone number.

0821234567

Merchant

addresses

customer

array

Optional

-

-

Only the first address is used.

Customer addresses.

[{"line1": "1 Main Road", ...}]

Merchant

address

-

object

Optional

-

-

Used only when customer.addresses is empty.

Billing address of the payment.

{"line1": "1 Main Road", "city": "Cape Town", "state": "Western Cape", "zip": "8001", "country": "ZA"}

Merchant

line1

address / customer.addresses[]

string

Optional

"" if missing

-

-

Address line 1.

1 Main Road

Merchant

line2

address / customer.addresses[]

string

Optional

-

-

-

Address line 2.

Gardens

Merchant

city

address / customer.addresses[]

string

Optional

"" if missing

-

-

City.

Cape Town

Merchant

state

address / customer.addresses[]

string

Optional

"" if missing

-

-

Province.

Western Cape

Merchant

zip

address / customer.addresses[]

string

Optional

"" if missing

-

-

Postal code.

8001

Merchant

merchant_reference_id

-

string

Optional

-

-

-

Merchant's own order reference.

order_1234

Merchant

metadata

-

object

Optional

-

-

-

Merchant-defined data.

{"merchant_defined": true}

Merchant

expiration

-

number

Optional

-

-

Maximum expiration is 1800 seconds (30 min).

Payment expiration (Unix time).

-

Merchant

description

-

string

Optional

-

-

-

Payment description.

Order 1234

Merchant

id

data

string

-

Rapyd payment ID. Also sent to PayJustNow as requestId and merchantOrderReference.

payment_782cf4bdfbcd20322e978c6184b691c7

Rapyd

status

data

string

ACT, CLO, ERR, CAN, EXP

Payment status. ACT right after creation, then CLO when paid, ERR when the customer cancels on PayJustNow, EXP when the checkout expires, or CAN when the merchant cancels.

ACT

Rapyd

redirect_url

data

string

URL

PayJustNow hosted checkout URL. Redirect the customer here.

https://<payjustnow-checkout-host>/checkout/<checkout_token>

Gateway

next_action

data

string

pending_confirmation

Next step for the merchant.

pending_confirmation

Rapyd

original_amount

data

number

-

Requested amount.

500

Carried over

amount

data

number

-

Paid amount. 0 until paid; set from PayJustNow checkoutTotalCents/100 on completion.

0

Rapyd / Gateway

currency_code

data

string

ZAR

Currency.

ZAR

Carried over

country_code

data

string

ZA

Country.

ZA

Carried over

payment_method_type

data

string

za_payjustnow_ewallet

Payment method type.

za_payjustnow_ewallet

Carried over

payment_method_type_category

data

string

ewallet

Payment category.

ewallet

Rapyd

instructions

data

array

-

Static PayJustNow description text (Pay in 3 interest-free or over 12 months with interest).

[{"name": "instructions", "steps": [[...]]}]

Rapyd

complete_payment_url

data

string

-

Echo of the merchant success URL.

https://merchant.example.com/success

Carried over

error_payment_url

data

string

-

Echo of the merchant error URL.

https://merchant.example.com/error

Carried over

merchant_reference_id

data

string

-

Echo of the merchant reference.

order_1234

Carried over

expiration

data

number

-

Payment expiration (Unix time).

1782997015

Rapyd

paid

data

boolean

true, false

True once the payment is completed.

false

Rapyd

paid_at

data

number

-

Time of payment. Set from PayJustNow paidAt on completion.

0

Gateway

failure_code

data

string

-

PayJustNow checkout status from the latest status update (for example PAID). It is filled on every update, including successful payments, so use status, not failure_code, to decide the outcome.

-

Rapyd

failure_message

data

string

-

Text for the PayJustNow checkout status. See failure_code.

-

Rapyd

textual_codes / visual_codes

data

object

-

Not used by this connector.

{}

Rapyd

payment

path

string

Required

-

-

Payment must be ACT and the customer must not have started paying.

ID of the payment to cancel (path parameter, no body).

payment_782cf4bdfbcd20322e978c6184b691c7

Merchant

id

data

string

-

Payment ID.

payment_782cf4bdfbcd20322e978c6184b691c7

Rapyd

status

data

string

CAN

Payment status after cancel.

CAN

Rapyd / Gateway

redirect_url

data

string

-

Original PayJustNow checkout URL.

https://<payjustnow-checkout-host>/checkout/<checkout_token>

Gateway

payment_method_type

data

string

za_payjustnow_ewallet

Payment.

za_payjustnow_ewallet

Carried over

payment

-

string

Required

-

-

Payment must be CLO.

ID of the PayJustNow payment to refund.

payment_aa7a1ff631e826f04397f1c419ca1d4d

Merchant

amount

-

number

Optional

Full payment amount

-

Converted to cents (x100, rounded).

Refund amount. Partial refunds supported.

200

Merchant

currency

-

string

Optional

-

ZAR

-

Refund currency.

ZAR

Merchant

reason

-

string

Optional

-

-

-

Refund reason.

returned goods

Merchant

merchant_reference_id

-

string

Optional

-

-

-

Merchant's own refund reference.

merchant_ref_001

Merchant

id

data

string

-

Rapyd refund ID. Also sent to PayJustNow as requestId and merchantRefundReference.

refund_4d82c3d979d6f7a5b7e1db34b5dc91b4

Rapyd

payment

data

string

-

Refunded payment ID.

payment_aa7a1ff631e826f04397f1c419ca1d4d

Carried over

amount

data

number

-

Refund amount.

500

Carried over

currency

data

string

ZAR

Currency.

ZAR

Carried over

status

data

string

Completed, Error

Refund status.

Completed

Rapyd / Gateway

reason

data

string

-

Echo of the reason.

returned goods

Carried over

merchant_reference_id

data

string

-

Echo of merchant reference.

merchant_ref_001

Carried over

payment_method_type

data

string

za_payjustnow_ewallet

Payment.

za_payjustnow_ewallet

Carried over

failure_reason / failure_code

data

string

-

Not populated by this connector.

-

Rapyd