Merchant API (2020-10-16)

Download OpenAPI specification:Download

Support: support@bigwpay.com License: Apache 2.0

The merchant API uses HTTP methods and a RESTful endpoint structure. The API authorization framework is OAuth 2.0. You format requests in JSON and the APIs return JSON-formatted responses.

We provide a demo environment so you may test your integration before going live.

Demo server host is https://app.bigwallet.online and the production server is https://app.bigwpay.com.

For DEMO server use:

For PRODUCTION server use:

Authentication

basicSecurity

Get an access token by using the OAuth 2.0 client_credentials token grant type with your terminalKey:terminalSecret as your Basic Auth credentials

Security Scheme Type HTTP
HTTP Authorization Scheme basic

oauth2Security

With each API call, you must set request headers including an OAuth 2.0 access token

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: Production: https://app.bigwpay.com/auth/token, Test: https://app.bigwallet.online/auth/token
Scopes:
  • transactions -

    Operations with transactions

  • payouts -

    Payouts

  • kyc -

    Customers registration and identification

  • customerProfiles -

    Customers profiles management

  • cards -

    Card verify

Access Token

OAuth 2.0 Server API

Get Access Token

Retrieve an access token for use with your API calls

Authorizations:
query Parameters
grant_type
required
string
Default: "client_credentials"
Value: "client_credentials"

Value must be set to client_credentials

Responses

200

The access token request is valid and authorized

401

The request failed client authentication or is invalid

get/auth/token

Test server

https://app.bigwallet.online/auth/token

Production server

https://app.bigwpay.com/auth/token

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "scope": "string",
  • "access_token": "f3ca90fc-f492-4ff3-872a-5f0b84a09445",
  • "token_type": "bearer",
  • "expires_in": 600
}

Payments

Merchant Payments API

listTransactions

Fetch list of transactions

Authorizations:
oauth2Security (transactions)

Responses

200

Data fetched

401

Bearer token is missing or invalid

get/api/v1/transactions

Test server

https://app.bigwallet.online/api/v1/transactions

Production server

https://app.bigwpay.com/api/v1/transactions

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "transactions":
    [
    ],
  • "meta":
    {
    }
}

createTransaction

Creates new payment transaction

Authorizations:
oauth2Security (transactions)
Request Body schema: application/json

Request to create a new payment transaction

intent
string (PaymentIntent)
Enum: "AUTHORIZE" "SALE"

Payment intent. Can be set to SALE for immediate funds withdrawal or AUTHORIZE to authorize a payment and withdraw funds from a Customer account later by executing capture operation.

paymentMethod
string (PaymentMethod)
Enum: "CREDIT_CARD" "SKRILL" "PAYPAL" "NETELLER" "RPNPAY" "PRZELEWY24" "SOFORT" "UPAYCARD" "UPAYCARD_WIRE" "JETON_WALLET" "PAYSAFECARD" "INTERAC" "INTERAC_ETRANSFER" "APCOPAY" "CLEARSETTLE" "ENTERCASH" "TRUSTLY" "TRUSTLY_PNP" "INTERKASSA" "KLUWP" "ECOPAYZ" "ASTROPAY" "CASHIER" "ECOMMPAY_TERMINAL" "B2CRYPTO" "CITADEL" "EFTPAY" "CRYPTOCURRENCY_EXTERNAL" "BANKTRANSFER" "VOGUEPAY" "FLEXEPIN" "BESTPAYCARD" "COMMUNITY_BANK" "CEP_BANK" "SEPA" "PAYTRIO" "PAYRETAILERS" "PAY2BEE" "WECHAT" "QQPAY" "PAYSEC" "QR" "PAYMENTCENTER" "REGULARPAY" "VLOAD" "BLACK42PAY" "ECOMMPAY" "ESTROPAY" "GLOBEPAY" "SAFECHARGE" "B2BINPAY" "STICPAY" "MUCHBETTER" "ENVOYPAY" "PAYGIGA" "SOLIDPAYMENTS" "FASAPAY" "MINERBOOKING" "DIJIPAYS" "TERREXA" "ZIGNSEC_SWISH" "THE_CHANGE" "ZIMPLER" "INTRORIX" "ZOTAPAY" "EASYEFT" "NORDEA" "IKAJO" "NETPAY" "TRONIPAY" "TRONIPAY_CRYPTO" "IACCOUNT" "PAYBOUTIQUE" "YANDEX_MONEY" "QIWI" "EPG" "DRAGONPHOENIX" "AWEPAY" "PAYTECHNO_CRYPTO" "MPESA" "PAYTRUST88" "XENTUM" "ASTROPAY_CARD" "OROUNDA" "LEOGAMING" "PAPARA" "BESTPAYCARD_CRYPTO" "MIR" "TELE_2" "MTS" "MEGAFON" "BEELINE" "ALOGATEWAY" "WEBMONEY" "WEBMONEY_LIGHT" "CASHU" "PAYEER" "PERFECT_MONEY" "ALFA_CLICK" "ALIPAY" "WELLCOINPAY" "NEOSURF" "SETTLEME" "APPLE_PAY" "MALDOPAY" "XPATE" "ANINDA" "FOURBILL" "WAYFORPAY" "DUSPAY" "ENFINS" "CRYPTO" "IPAYTOTAL" "UPHOLD" "DIRECTA24" "BCASHY" "ADVCASH" "ESKAYPAY" "GPAY" "INSTADEBIT" "IDEBIT" "CRYPTOMARINE" "PAYMEGA" "TRANSACTWORLD" "FOXAPAY" "DRAGONPAY" "PLASMAPAY" "FREEKASSA" "ISIGNTHIS" "UNNAX" "PIASTRIX" "MOBILEPAY" "BONYPAY" "CERTUS" "WHITEPAID"

Payment method. Select between various methods of payment – CREDIT_CARD is chosen by default.

amount
required
number multiple of 1e-18 [ 1e-18 .. 999999.99 ]

Transaction amount

currency
required
string <ISO 4217> (Currency)
Enum: "CNY" "EUR" "GBP" "RUB" "USD" "XBT" "B2BX" "BCH" "DOGE" "XTH" "USDT" "ADA" "LTC" "XLM" "XRP" "EOS" "BAT" "XMR"

ISO 4217 currency code, crypto currency code (XBT is used for BTC, XTH is used for ETH to avoid conflict with fiat currency)

merchantTransactionId
required
string <= 100 characters

Id of the transaction assigned by Merchant

description
required
string <= 512 characters

Description of the transaction

shippingAddress
object (ShippingAddress)

The shipping address is where customer wants order delivered. This can be the same as the billing address, or it can be different.

customer
object (Customer)
card
object (Card)

Payment card. Must be sent in server-to-server requests when merchant has PCI DSS level 1 compliance. Must be omitted in payment page requests.

cardToken
string <= 32 characters

Reference to the stored card data

startRecurring
boolean

Flag to trigger the start of a recurring transaction. A recurring token will be generated and sent back to merchant

recurringToken
string <= 32 characters

Multi-use reference token to be used for recurring operations

cashierPaymentMethod
string <= 32 characters

Cashier Payment method

returnUrl
string <= 256 characters

URL to redirect Customer after processing. Overrides terminal-level settings

predefinedAmounts
Array of numbers

Array of 3 values that override the pre defined amounts setup in merchant terminal to all payment methods.

Responses

201

Payment created.

400

Invalid input

401

Bearer token is missing or invalid

422

Operation is declined

post/api/v1/transactions

Test server

https://app.bigwallet.online/api/v1/transactions

Production server

https://app.bigwpay.com/api/v1/transactions

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "intent": "SALE",
  • "paymentMethod": "CREDIT_CARD",
  • "amount": 19.98,
  • "currency": "USD",
  • "merchantTransactionId": "ORDER-123456",
  • "description": "Purchase: 9 red roses",
  • "shippingAddress":
    {
    },
  • "customer":
    {
    },
  • "card":
    {
    },
  • "cardToken": "d7993562260c4ec2904612e5aa787261",
  • "startRecurring": true,
  • "recurringToken": "2bfe72bccdf44e16a044b8266389b05f",
  • "cashierPaymentMethod": "CASHIER_123",
  • "predefinedAmounts":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "d7993562260c4ec2904612e5aa787261",
  • "created": "2017-01-10T09:37:43.000Z",