Create a payment
POST /api/payment-process submits a card payment on the MID named in midName.
Required fields
Section titled “Required fields”| Field | Rule |
|---|---|
merchantIdentifier |
20 to 40 characters |
currency |
exactly 3 characters (ISO 4217), for example USD |
amount |
decimal string, for example 49.90 |
ccn |
13 to 19 characters |
expMonth |
exactly 2 characters |
expYear |
exactly 4 characters |
cvcCode |
3 to 4 characters |
referenceCode |
8 to 30 characters, unique |
Recommended fields
Section titled “Recommended fields”midName, email, firstName, lastName, phoneNumber, ip (the shopper’s), billing address, city,
state, zipCode, country, and postbackUrl. Send the shopper’s real IP and e-mail: they feed fraud checks and
the ban list.
referenceCode is your idempotency key
Section titled “referenceCode is your idempotency key”Use one per order. If your request times out, retrying with the same code is safe: a duplicate is refused with
400 Transaction reference code already exist!, then use a lookup to read the
original result.
Response
Section titled “Response”| Field | Meaning |
|---|---|
transactionUuid |
The gateway’s id |
paymentUuid |
The processor’s id; may be empty while in progress. Needed for refunds |
status |
APPROVED, DECLINED, ERROR or IN PROGRESS |
message |
The processor’s or platform’s explanation |
redirectUrl |
Present only when the shopper must authenticate |
A customer whose e-mail is on the ban list receives DECLINED with an explanatory message.
Card data
Section titled “Card data”The API receives the card number directly, so card data passes through your server. Keep that window as short as
you can, never log ccn or cvcCode, and confirm your PCI obligations with your account manager before going live.