Initiate redirect-based checkout

post

https://testsecure.peachpayments.com/checkout/initiate

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

authentication.entityId

string

required

length ≤ 32

signature

string

required

length ≤ 64

merchantTransactionId

string

required

length between 8 and 16

rateLimitId

string

length ≤ 255

amount

string

required

paymentType

string

enum

required

Allowed:

currency

string

enum

required

Allowed:

nonce

string

required

length ≤ 64

shopperResultUrl

string

required

defaultPaymentMethod

string

enum

forceDefaultMethod

string

enum

Defaults to false

Allowed:

merchantInvoiceId

string

length between 8 and 255

cancelUrl

string

notificationUrl

string

customParameters[name]

string

customer.merchantCustomerId

string

length between 0 and 48

customer.givenName

string

length between 0 and 48

customer.surname

string

length between 0 and 48

customer.mobile

string

length between 5 and 24

customer.email

string

length between 6 and 128

customer.status

string

enum

Allowed:

customer.birthDate

string

customer.ip

string

length between 1 and 255

customer.phone

string

length between 5 and 24

customer.idNumber

string

length between 13 and 13

billing.street1

string

length between 1 and 100

billing.street2

string

length between 1 and 100

billing.city

string

length between 1 and 80

billing.company

string

length between 1 and 64

billing.country

string

length between 2 and 2

billing.state

string

length between 1 and 50

billing.postcode

string

length between 1 and 30

shipping.street1

string

length between 1 and 100

shipping.street2

string

length between 1 and 100

shipping.city

string

length between 1 and 80

shipping.company

string

length between 1 and 64

shipping.postcode

string

length between 1 and 30

shipping.country

string

length between 2 and 2

shipping.state

string

length between 1 and 50

cart.tax

string

cart.shippingAmount

string

cart.discount

string

createRegistration

string

enum

Allowed:

cardTokens

string

allowStoringDetails

string

enum

Allowed:

standingInstruction.expiry

date

standingInstruction.frequency

string

standingInstruction.recurringType

string

enum

Allowed:

standingInstruction.type

string

enum

Allowed:

standingInstruction.mode

string

enum

Allowed:

standingInstruction.industryPractice

string

enum

Allowed:

standingInstruction.numberOfInstallments

string

cardRemovalUrl

string

originator

string

length ≤ 100

returnTo

string

enum

Allowed:

Headers

Referer

string

required

accept

string

enum

Defaults to application/json

Allowed:

content-type

string

enum

Defaults to application/json

Allowed:

Responses

400

Invalid authentication information.

500

Internal server error.

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/html

application/json