POST
Create Payment via Card Information (S2S)

Authorizations

app-id
string
header
required

A unique identifier assigned to each application.

secret-key
string
header
required

A secure token associated with the app-id.

Body

application/json
amount
number
required

Amount in smallest currency unit (e.g., cents)

Example:

1000

currency
string
required

ISO 4217 currency code (e.g., AUD)

Example:

"AUD"

email
string<email>
required

Customer's email.

Example:

"email@gmail.com"

first_name
string
required

Customer's first name.

Example:

"John"

last_name
string
required

Customer's last name.

Example:

"Doe"

billing_address
object
required

Customer’s billing address details.

card_info
object
required

Card information.

external_id
string
required

External ID

Example:

"order_test_xxx"

return_url
string
required

Return URL

Example:

"https://example.com"

description
string
required

Description for the payment.

Example:

"Payment for invoice #1234"

payment_type
enum<string>
default:regular

The type of payment.

Available options:
regular,
unscheduled
charge_reason
enum<string>

Indicates the reason for a merchant-initiated payment request. Should be provided if payment_type is unscheduled.

Available options:
resubmission,
delayed_charge,
no_show,
reauthorisation
Example:

"resubmission"

previous_payment_uuid
string<uuid>

An identifier that links the payment to an existing series of payments. Should be provided if payment_type is unscheduled.

Example:

"1GKPTU7E"

browser_details
object

Browser details information.

ip_address
string

The IP address of the cardholder

Example:

"192.168.1.1"

capture
boolean
default:false

Whether to auto capture the payment (if applicable)

webhook_notification
object

Response

Payment created

uuid
string
Example:

"7PPPMXIGH"

name
string
Example:

"Testing"

email
string
Example:

"test@example.com"

external_id
string
Example:

"wc_order_6C1hcvg4T7Pom"

status
enum<string>
Available options:
pending,
authorised,
waiting,
received,
expired,
return_pending,
return_expired,
partially_refunded,
return_received,
return_rejected,
failed,
in_dispute,
dispute_lost
Example:

"waiting"

pay_code
object | null
currency
string
Example:

"USD"

amount
number
Example:

10000

total
number
Example:

10000

paid_amount
number
Example:

0

is_refundable
boolean
Example:

true

payment_method
string
Example:

"card"

expired_at
string
Example:

""

webhook_notification
object
refund_information
object
sender_details
object
capture
boolean
Example:

false

payment_type
string
Example:

"regular"

token
object
created_at
string<date-time>
Example:

"2025-05-28T04:22:21.567+0000"