Guides
Back to skipify.comContact Us

Skipify Gateway API (DRAFT)

Learn how to integrate the Skipify Gateway API

Suggest Edits

🚧

Your merchant account needs to be approved and configured in order to use this product

Haven't set that up yet? No worries! Reach out to your friendly implementation engineer and they'll make sure your account is properly set up.

Please note that you will need to provide PCI certification documentation to be reviewed on a regular basis.

Overview

The Skipify Gateway API allows you to directly submit a transaction using card details or a network token.

Use this approach if you need ultimate flexibility to submit a payment without a user interacting with a webpage. This product provides you with multi-PSP access without having to integrate and manage each psp integration.

📘

Set up a Skipify merchant account for each PSP in-scope.

Submit a Payment

👍

This endpoint uses API Key Authentication

Check out our API KEY Authentication Section to learn more

API Request

To submit a payment request, send an API call to:

Staging: POST https://services.staging.skipify.com/v1/gateway/payments

Production: POST https://services.skipify.com/v1/gateway/payments

Request Body Parameters

Parameter NameRequired?TypeDescription
amountyesintegerThis is the amount to authorize the card for. The last two digits are cents, so $20.50 would be sent as 2050.
merchantReferenceyesstringThis is your unique merchant identifier/invoice number for this transaction.
paymentMethodyesobjectAn object that contains the paymentMethod details. If using card details, this includes PAN+CVV, if using tokens, this includes NetworkToken+Cryptogram.
billingAddressyesobjectThe customer object includes a set of properties that are required if you want to verify AVS results with your payment authorization. zipcode is required
customeryesobjectThe customer object includes fullName, email and phone if you want to send this to Skipify for reporting purposes. Full Name is required.

Payment Method

paymentMethod Parameters

Parameter NameRequired?TypeDescription
typeyesstringcard or token
cardNumberyesstringAn object that contains the paymentMethod details. If using card details, this includes PAN+CVV, if using tokens, this includes NetworkToken+Cryptogram.
expirationMonthconditionalintegerThe card's expiration month i.e. 01 or 12. Required if submitting card (PAN) details.
expirationYearconditionalintegerThe card's 4-digit expiration year i.e. 2029. Required if submitting card (PAN) details.
cvvconditionalstringRequired if submitting card (PAN) details.
cryptogramconditionalstringRequired if submitting token (NetworkToken) details.

Billing Address

billingAddress Parameters

Parameter NameRequired?TypeDescription
address1nostringThe cardholder's billing Street Address i.e. 123 Main Avenue
address2nostringThe cardholder's billing Street Address Line 2 i.e. APT 15
citynointegerThe cardholder's billing City
statenointegerThe cardholder's billing State
zipcodeyesstringThe cardholder's billing zipcode (postal code).
countrynostringThe cardholder's billing country

Customer

Customer Parameters

Parameter NameRequired?TypeDescription
fullNamenostringThe cardholder's first and last name
emailnostringThe cardholder's email address
phonenostringThe cardholder's mobile phone number

Request Body Example

{
  "amount": 5000,
  "paymentMethod": {
    "type": "card",
    "cardNumber": "string",
    "expirationMonth": 12,
    "expirationYear": 3000,
    "cvv": "string",
    "cryptogram": "string"
  },
  "billingAddress": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "st",
    "zipcode": "string",
    "country": "US"
  },
  "customer": {
    "fullName": "string",
    "email": "[email protected]",
    "phone": "string"
  }
}

API Response Example

{
  "transactionId": "73c335b2-0dad-4e4a-b10b-950614f80953",
  "pspTransactionId": "dE3Hnj7c_SD9",
  "status": "Authorized",
  "amount": 5000,
  "initialAmount": 5000,
  "pspRawResponse": "FWWp",
  "completedAt": "2025-07-21T17:32:28Z",
  "lastFour": "0005",
  "networkType": "visa",
  "isPartial": false
}

Refund a Payment

The shopper requests a refund. You use referenced data from the initial transaction response to send the refund request to Skipify.

API Request

To Refund a Payment, send an API call to:

Staging: POST https://services.stage.skipify.com/payments/{transactionId}/refundTBC

Production: POST https://services.skipify.com/payments/{transactionId}/refundTBC

Request Body Parameters TBC

Parameter NameRequired?TypeDescription
amountnointegerThis is the amount you want to refund, you do not need to pass this if you want to refund the full amount. The last two digits are cents, so $20.50 would be sent as 2050.
{
  "amount": "string",
}

API Response Example

{
  "transactionId": "73c335b2-0dad-4e4a-b10b-950614f80953",
  "pspTransactionId": "dE3Hnj7c_SD9",
  "status": "Refunded",
  "amount": 5000,
  "pspRawResponse": "FWWp",
  "completedAt": "2025-07-21T17:32:28Z"
}

Cancel a Payment

The transaction was made in error and needs to be cancelled.

API Request

To Cancel a Payment, send an API call to:

Staging: POST https://stage-gateway.skipify.com/payments/{transactionId}/cancelTBC

Production: POST https://gateway.skipify.com/payments/{transactionId}/cancelTBC

Request Body Parameters TBC

Parameter NameRequired?TypeDescription
amountnointegerThis is the amount you want to cancel, you do not need to pass this if you want to refund the full amount. The last two digits are cents, so $20.50 would be sent as 2050.
{
  "amount": "string",
}

API Response Example

{
  "transactionId": "73c335b2-0dad-4e4a-b10b-950614f80953",
  "pspTransactionId": "dE3Hnj7c_SD9",
  "status": "Canceled",
  "amount": 5000,
  "pspRawResponse": "FWWp",
  "completedAt": "2025-07-21T17:32:28Z"
}

Updated about 1 month ago