Skip to content

Attempt payment

Request

Attempt to settle a pending order by credit card payment. Payment can only be attempted once an order has been placed, but before it has timed out or been cancelled. Payment can no longer be attempted once an order has been fulfilled, refunded or cancelled.

If the tickets being ordered are free (i.e. the order total is $0.00), the order does not require settlement, and will be fulfilled immediately without payment.

Security
SessionKey(Required scopes: customeradministrator)
Path
numberstringrequired

Alphanumeric identifier of the user account

orderstring^\d{14}$

Unique identifier of the order

Bodyapplication/json
numberstring^\d{16}$required

16-Digit Primary Account Number (PAN) of the payment

cvvnumber, (integer)required

3-Digit Card Verification Value (CVV) of the payment card

expiryDatestring^\d{2}/\d{2}$required

Expiry date of the payment card in the format MM/YY

namestringrequired

Name of the payment card holder as printed on the front of the card

emailstring, (email)required

Email address of the payment card holder

phonestring, (phone)required

Phone number of the payment card holder

address1stringrequired

First line of the payment card holder's billing address

address2string

Second line of the payment card holder's billing address

citystringrequired

City of the payment card holder's billing address

districtstringrequired

Parish/State/Province of the payment card holder's billing address

countrystringrequired

Country of the payment card holder's billing address

curl -i -X POST \
  'https://docs.ticketingevents.com/_mock/openapi/accounts/{number}/orders/{order}/payments' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "number": "5555555555555555",
    "cvv": 123,
    "expiryDate": "12/30",
    "name": "Marvin M. Milk",
    "email": "marvin.milk@usmc.gov",
    "phone": "+1 (268) 555 0123",
    "address1": "Hermitage Rd.",
    "address2": "Jennings New Extension",
    "city": "Jennings",
    "district": "Saint Mary'\''s",
    "country": "Antigua and Barbuda"
  }'

Responses

Payment was accepted in settlement of the order.

Bodyapplication/json
datestring, (date-time)

The date/time at which the payment was attempted

amountnumber, (float)

The attempted payment amount

statusstring

The end result of the payment attempt

Enum:"Authorised""Declined"
Response
{
  "date": "2024-02-19T17:30:08",
  "amount": 101.99,
  "status": "Authorised"
}