B2B API Specification

B2B Payment API

Settings

The Checkout Settings endpoint provides merchants with a comprehensive framework for managing the fallback configuration and post-payment behavior of their hosted payment pages. This configuration allows integrators to specify user-required fields, and set up redirection URLs for both approved and declined payments. Additionally, it identifies the secure HTTPS endpoint for background notification posts and defines the preferred return method to transition from the payment gateway back to the merchant's site.

Create checkout setting

post /v3/checkout/setting

Parameters

X-Integrator-Id

Type

string

Maximum Length

X-Permalinks

Type

string

Maximum Length

Request Schema

silent_post

Type

string

Range

1 to 2083 characters

Example

https://example.com/payment-response

terms_conditions_link required

Type

string

Range

1 to 2083 characters

Example

http://example.com/terms-redirect-link

payment_approved_link

Type

string

Range

1 to 2083 characters

Example

http://example.com/payment-approved-link

payment_declined_link

Type

string

Range

1 to 2083 characters

Example

http://example.com/payment-declined-link

return_method

Type

string

Default

HYPERLINK

Enum

HYPERLINK

email_required

Type

boolean

Example

true

billing_address_required

Type

boolean

Example

true

csc_required

Type

boolean

Example

true

merchant_id required

Type

integer

Example

12345

invoice_expiration_days required

Type

integer

Enum

1430

Example

Example Request

{
  "silent_post": "https://example.com/payment-response",
  "terms_conditions_link": "http://example.com/terms-redirect-link",
  "payment_approved_link": "http://example.com/payment-approved-link",
  "payment_declined_link": "http://example.com/payment-declined-link",
  "return_method": "HYPERLINK",
  "email_required": true,
  "billing_address_required": true,
  "csc_required": true,
  "merchant_id": 12345,
  "invoice_expiration_days": 14
}

Example Response

201 Successful Response

422 Validation Error

Get checkout setting

get /v3/checkout/setting/{setting_id}

Parameters

setting_id required

Type

integer

merchant_id required

Type

integer

Example

246810

X-Integrator-Id

Type

string

Maximum Length

X-Permalinks

Type

string

Maximum Length

Example Response

200 Successful Response

422 Validation Error

Update checkout setting

put /v3/checkout/setting/{setting_id}

Parameters

setting_id required

Type

integer

X-Integrator-Id

Type

string

Maximum Length

X-Permalinks

Type

string

Maximum Length

Request Schema

silent_post

Type

string

Range

1 to 2083 characters

Example

https://example.com/payment-response

terms_conditions_link required

Type

string

Range

1 to 2083 characters

Example

http://example.com/terms-redirect-link

payment_approved_link

Type

string

Range

1 to 2083 characters

Example

http://example.com/payment-approved-link

payment_declined_link

Type

string

Range

1 to 2083 characters

Example

http://example.com/payment-declined-link

return_method

Type

string

Default

HYPERLINK

Enum

HYPERLINK

email_required

Type

boolean

Example

true

billing_address_required

Type

boolean

Example

true

csc_required

Type

boolean

Example

true

merchant_id required

Type

integer

Example

12345

invoice_expiration_days required

Type

integer

Enum

1430

Example

Example Request

{
  "silent_post": "https://example.com/payment-response",
  "terms_conditions_link": "http://example.com/terms-redirect-link",
  "payment_approved_link": "http://example.com/payment-approved-link",
  "payment_declined_link": "http://example.com/payment-declined-link",
  "return_method": "HYPERLINK",
  "email_required": true,
  "billing_address_required": true,
  "csc_required": true,
  "merchant_id": 12345,
  "invoice_expiration_days": 14
}

Example Response

200 Successful Response

422 Validation Error

Delete checkout setting

delete /v3/checkout/setting/{setting_id}

Parameters

setting_id required

Type

integer

merchant_id required

Type

integer

Example

246810

X-Integrator-Id

Type

string

Maximum Length

X-Permalinks

Type

string

Maximum Length

Example Response

200 Successful Response

422 Validation Error

Settings

Create checkout setting

Get checkout setting

Update checkout setting

Delete checkout setting

Contact Us