Payment methods

Retrieve installment settings used to place orders with installments

get

Retrieve information about the number of installments available for a specific selection of products or services.

Once the installment information is retrieved, it can be used in the POST call on the order resource to place an order with a installments

Query parameters

AmountnumberRequired

Amount

CountrystringRequired

2 letters country code

CurrencystringRequired

3 letters currency code

FiscalCodestringOptional

Fiscal code. Required for Brasil or if CardBin or EesToken is not provided

CardBinstringOptional

Card number. Required if Fiscal code or EesToken is not provided

EesTokenstringOptional

Ees token. Required if Fiscal code or CardBin is not provided

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Responses

200

OK

application/json

500

ERROR

application/json

get

/orders/0/installments

HTTPcURLJavaScriptPython

GET /rest/6.0/orders/0/installments?Amount=1&Country=text&Currency=text HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

{
  "0": {
    "Amount": "384.45",
    "Currency": "BRL",
    "Number": "1"
  },
  "1": {
    "Amount": "192.23",
    "Currency": "BRL",
    "Number": "2"
  },
  "2": {
    "Amount": "128.15",
    "Currency": "BRL",
    "Number": "3"
  },
  "3": {
    "Amount": "96.11",
    "Currency": "BRL",
    "Number": "4"
  },
  "4": {
    "Amount": "76.89",
    "Currency": "BRL",
    "Number": "5"
  },
  "5": {
    "Amount": "64.08",
    "Currency": "BRL",
    "Number": "6"
  }
}

Create an EES token for placing orders using 2pay.js

post

Header parameters

X-Avangate-AuthenticationstringRequiredExample: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

AcceptstringRequiredExample: application/json

Body

application/json

NamestringOptional

Name of the cardholder

Example: John Doe

CreditCardstringRequired

Credit card number

Example: 4111111111111111

CvvstringRequiredExample: 123

ExpirationDatestringRequiredExample: 12/28

Scopestring · enumOptional

Represents the scope of the created token. It is the client's responsability to manage this

Default: orderingExample: subscriptionPossible values:

Responses

200

Create token response

application/json

post

/tokens

HTTPcURLJavaScriptPython

POST /rest/6.0/tokens HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json
Content-Type: application/json
Content-Length: 111

{
  "Name": "John Doe",
  "CreditCard": "4111111111111111",
  "Cvv": "123",
  "ExpirationDate": "12/28",
  "Scope": "subscription"
}

200

Create token response

{
  "Results": {
    "Token": "c2ba2590-3641-4a06-9eaf-5fba50c8eef0"
  }
}

Initiate an ApplePay session

post

Header parameters

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Acceptstring · enumRequiredExample: application/jsonPossible values:

Body

application/json

validationURLstringOptional

Responses

200

OK

application/json

400

Invalid data

application/json

post

/payments/startapplepaysession

HTTPcURLJavaScriptPython

POST /rest/6.0/payments/startapplepaysession HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json
Content-Type: application/json
Content-Length: 84

{
  "validationURL": "https://apple-pay-gateway.apple.com/paymentservices/startSession"
}

{
  "ApplePaySessionData": {
    "response": "APPLEPAY_DATA",
    "errors": []
  }
}

Decrypt the ApplePay data

post

Header parameters

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Acceptstring · enumRequiredExample: application/jsonPossible values:

Body

application/json

ApplePayDatastringOptional

Responses

200

OK

application/json

ApplePayDataTokenstringOptional

BillingDetailsobjectOptional

DeliveryDetailsobjectOptional

StatusbooleanOptional

400

Invalid data

application/json

post

/payments/decryptApplePayData

HTTPcURLJavaScriptPython

POST /rest/6.0/payments/decryptApplePayData HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json
Content-Type: application/json
Content-Length: 83

{
  "ApplePayData": "543a07601ed9f8b8ee226e9630a24e2a91da8fdb08e6786fa02bf628f395bb91"
}

{
  "ApplePayDataToken": "APPLEPAY_DATA_TOKEN",
  "BillingDetails": {},
  "DeliveryDetails": {},
  "Status": true
}

Retrieve the list of banks that support iDEAL

get

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Responses

200

OK

application/json

get

/paymentmethods/IDEAL/issuerbanks

HTTPcURLJavaScriptPython

GET /rest/6.0/paymentmethods/IDEAL/issuerbanks HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

200

OK

[
  {
    "Code": "ABNANL2A+ABN",
    "Name": "ABN AMRO"
  },
  {
    "Code": "RABONL2U+RAB",
    "Name": "Rabobank"
  },
  {
    "Code": "INGBNL2A+ING",
    "Name": "ING"
  },
  {
    "Code": "SNSBNL2A+SNS",
    "Name": "SNS Bank"
  },
  {
    "Code": "ASNBNL21+ASN",
    "Name": "ASN BANK"
  },
  {
    "Code": "KNABNL2H+KNA",
    "Name": "Knab"
  },
  {
    "Code": "RBRBNL21+REG",
    "Name": "SNS Regio Bank"
  },
  {
    "Code": "TRIONL2U+TRI",
    "Name": "Triodos bank"
  },
  {
    "Code": "FVLBNL22+VAN",
    "Name": "Van Lanschot"
  },
  {
    "Code": "BUNQNL2A+BUN",
    "Name": "Bunq"
  }
]

Retrieve PayPal Express redirect URL

put

Header parameters

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Acceptstring · enumRequiredExample: application/jsonPossible values:

Body

application/json

CountrystringOptional

CurrencystringOptional

CustomerIPstringOptional

LanguagestringOptional

Responses

200

OK

application/json

put

/paymentmethods/PAYPAL_EXPRESS/redirecturl

HTTPcURLJavaScriptPython

PUT /rest/6.0/paymentmethods/PAYPAL_EXPRESS/redirecturl HTTP/1.1
Host: api.2checkout.com
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Accept: application/json
Content-Type: application/json
Content-Length: 270

{
  "Country": "us",
  "Currency": "usd",
  "CustomerIP": "91.220.121.21",
  "Items": [
    {
      "Code": "my_subscription_1",
      "Quantity": "1"
    }
  ],
  "Language": "en",
  "PaymentDetails": {
    "Currency": "USD",
    "PaymentMethod": {
      "Email": "[email protected]",
      "ReturnURL": "www.yoursite.com"
    },
    "Type": "PAYPAL_EXPRESS"
  }
}

200

OK

http://api.2checkout.com/6.0/scripts/paypalexpress/request?avng8apitoken=a211b606e9a62202

Validate previous order as payment reference

get

2Checkout supports 1-click purchases for returning customers who paid for their previous orders with credit card, Paypal or iDeal.

Once a order reference has been validated, it can be used in the POST call on an order to place an order with a previous order reference.

Path parameters

OrderReferencestringRequired

Reference number for approved/paid orders.

Example: 1234567

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Responses

200

OK

application/json

get

/paymentmethods/PREVIOUS_ORDER/refno/{OrderReference}

HTTPcURLJavaScriptPython

GET /rest/6.0/paymentmethods/PREVIOUS_ORDER/refno/{OrderReference} HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

200

OK

true