Payment Request

Payment Request

POST /requests

cURL

Standard Payment Request

curl --request POST \
  --url https://testapi.fractalpay.com/api/v1/requests \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchant_key": "{{merchant_key}}",
  "amount": "10.00",
  "order_id": "5467",
  "phone_number": "7777771234",
  "email": "[e-mail]",
  "allow_card": true,
  "allow_ach": true
}
'

200

Preauth Request

{
  "message": "Authorization request has been sent",
  "data": {
    "order_id": "5467",
    "link_id": "gsgqll4xfa7",
    "pay_link": "https://testapi.fractalpay.com/authcheck-paymentlink/gsgqll4xfa7"
  }
}

Authorizations

Authorization · string · header · required

Use your Fractal API credentials.

Username = Client ID Password = Secret Key

Sandbox credentials can be generated from the Test Portal.

Body

application/json

merchant_key · string · required

The merchant's unique API key.

Example:

"{{merchant_key}}"

amount · string · required

Payment amount.

Example:

"10.00"

order_id · string · required

Your unique order reference. Max 100 characters.

Example:

"5467"

phone_number · string

Customer phone number. If provided, an SMS with the pay link is sent.

Example:

"7777771234"

email · string

Customer email address. If provided, an email with the pay link is sent.

Example:

"[e-mail]"

name · string

Customer name. Used in the email template.

Example:

"Jane Smith"

preauth · boolean

Set to true to issue a preauthorization. The customer authorizes the amount without being charged immediately.

Example:

true

pass_fee · boolean

Pass the processing fee to the customer.

Example:

true

require_3ds · boolean

Require 3D Secure authentication.

Example:

false

allow_card · boolean · default: true

Allow card as a payment method. At least one of allow_card or allow_ach must be true.

Example:

true

allow_ach · boolean · default: true

Allow ACH as a payment method. At least one of allow_card or allow_ach must be true.

Example:

true

invoice_number · string

Invoice reference. Alphanumeric, max 100 characters.

Example:

"345"

sub_merchant_key · string

Sub-merchant key, if applicable.

Example:

""

discount · string

Discount amount.

Example:

"0.00"

surcharge · string

Surcharge amount.

Example:

"0.00"

tax · string

Tax amount.

Example:

"0.00"

description · string

Payment description.

Response

200 - application/json

Payment request created successfully

message · string

data · object

Show child attributes