Payment API Requests
Version 1.0
POST https://api-dev.cruisepay.finance/api/v1/payment
Authentication
All requests sent to the Cruisepay API must be authenticated using a Bearer token. This token verifies that the request originates from an authorized account and defines the permitted access scope.
Requests with missing, expired, or invalid tokens will receive a 401 Unauthorized response.
Authorization: Bearer ••••••••••••••••••••••Request Parameters
Payment Details
Customer’s payment method.
CARD or GOOGLEPAY or APPLEPAY (Only as given)
CARD
Amount of the transaction.
The format depends on the currency exponent.
100.5
Payment Currency
3 Letter Currency Code
USD
Transasction ID assigned by Merchant.
Minimum length of 7 characters.
ABC123
Card Details
Card primary account number (PAN).
All non-numeric characters will be ignored.
Minimum length of 7 characters.
4000000000000002
Card Expiry Month - 2 Digits only
08
Card Expiry Year - last 2 Digits of the year value only
29
CVV Code - 3 Digits or 4 (for AMEX)
123
Customer Identity
Customer's First Name.
A Maxumum of 50 Characters allowed
Sherlock
Customer's Last Name.
A Maxumum of 50 Characters allowed
Holmes
Customer's Phone Number
Min 7 digits - Max 18 digits - No need to enter country code.
6549873215
Billing Details
Customer's Address
Min 3 & Max 45 characters
221 B, Baker Street
Customer's City
Min 3 & Max 45 characters
London
Customer's State
Min 2 & Max 45 characters
State
Customer's Zip Code
Only Alpha Numeric values allowed
NW16XE
Customer's Country Code
2-letter country code
UK
Network Information
IP address (IPv4 or IPv6)
192.168.1.1
Redirects & Webhooks
URL to redirect Customer after processing
Https://abcwebsite.com
API endpoint to receive the payment status
To know either Success or Failure
Https://abcwebsite.com/returnurl
API endpoint to receive the callbacks for refunds
If empty, refund callbacks will be send to statusurl.
Https://abcwebsite.com/refundcallbackurl
API endpoint to receive the callbacks for chargeback
If empty, chargeback callbacks will be send to statusurl.
Https://abcwebsite.com/chargebackCallbackUrl
API endpoint to receive the callbacks for fraud warnings
If empty, fraud warning callbacks will be send to statusurl.
Https://abcwebsite.com/fraudCallbackUrl
Payload Structure
{
"paymentMethod": "CARD",
"amount": "66.00",
"currency": "USD",
"invoiceNumber": "abcd1234",
"cardNumber": "4000000000000002",
"expMonth": "05",
"expYear": "28",
"cvv": "123",
"firstName": "Sherlock",
"lastName": "Holmes",
"email": "[email protected]",
"phone": "9876543210",
"address": "221B Baker Street",
"city": "London",
"state": "State",
"zip": "NW16XE",
"country": "UK",
"ip": "192.168.5.6",
"returnUrl": "https://www.clientsite.com",
"statusUrl": "https://clientsite.com/api/statusurl",
"refundCallbackUrl": "https://clientsite.com/api/refundCallbackUrl",
"chargebackCallbackUrl": "https://clientsite.com/api/chargebackCallbackUrl",
"fraudCallbackUrl": "https://clientsite.com/api/fraudCallbackUrl"
"additionalParameters": {}
}
Callback Responses
Get Status API Request
Version 1.0
GET https://api-dev.cruisepay.finance/api/v1/orderStatus
Get Transaction Status
The Get Transaction Status endpoint requires authentication using a Bearer token. This request returns the current status of a transaction based on the provided identifier.
Requests with missing, expired, or invalid tokens will receive a 401 Unauthorized response.
Authorization: Bearer ••••••••••••••••••••••Request Parameters
Invoice Detail
Transasction ID assigned by Merchant.
Minimum length of 7 characters.
ABC123
Payload Structure
{
"invoiceNumber": "abcd1234",
}Status Callback Responses