API structures

Address Structure

The address structure contains information about a street address.

Fields:

Example:

US Address:

{
    "address1":"380 Portage Ave",
    "address2":"",
    "city":"Palo Alto",
    "state":"CA",
    "zip":"94306",
    "country":"US"
}
    

Non-US Address:

{
    "address1":"100 Main St",
    "address2":"",
    "region":"ON",
    "city":"Toronto",
    "postcode":"M4E 1Z5",
    "country":"CA"
}
    

Shipping Address Structure

The shipping address structure contains information about a shipping address.

Fields:

Example:

US Address:

{
	"name":"Bill Clerico",
	"address1":"380 Portage Ave",
	"address2":"",
	"city":"Palo Alto",
	"state":"CA",
	"zip":"94306",
	"country":"US"
}
	

Non-US Address:

{
	"name":"Bill Clerico",
	"address1":"100 Main St",
	"address2":"",
	"region":"ON",
	"city":"Toronto",
	"postcode":"M4E 1Z5",
	"country":"CA"
}
	

Hosted Checkout Structure

Use this to have payers enter payment information on a WePay hosted checkout URL. Send either hosted_checkout or payment_method parameter. Do not send both parameters at the same time. If neither parameter is specified, default behavior will be hosted_checkout.

Fields:

Example:

{
  "redirect_uri": "http://www.test.com",
  "fallback_uri": "http://www.test.com",
  "shipping_fee": 2,
  "mode": "iframe",
  "require_shipping": true,
  "prefill_info": {
      "address": "main street",
      "zip": "94085",
      "country": "US"
   },
   "theme_object": {
       "name": "test",
       "primary_color": "ffffff",
       "background_color": "ffffff",
       "button_color": "000000",
       "secondary_color": "000000"
   },
  "funding_sources": ["credit_card"]
}

Payment Method Structure

Send the payment method object to pay for a checkout using previously acquired payment information, such as a credit card (for tokenization) or preapproval. Based on the type, only specify credit_card or preapproval fields. For example, if the payment method has type = "credit_card", specify "credit_card" field and do not specify "preapproval" field.

Fields:

Example:

{
    "type": "credit_card",
    "credit_card": {
        "id": 1334
    }
}

Payment Method Response Structure

Contains information about the payment method used.

Fields:

Example:

{
    "type": "credit_card",
    "credit_card": {
        "id": 1334
    }
}

Payer response structure

Contains information about the payer such as their name, email, and home address. This object is returned only if a payment has been made.

Fields:

Example:

{
    "name": "John Doe",
    "email": "test@test.com",
    "home_address": {
        "address1": "350 Convention Way",
        "address2": "Suite 200",
        "city": "Redwood City",
        "state": "CA",
        "zip": "94063",
        "country": "US"
    }
}

Credit Card Structure

Object that specifies credit card ID used for tokenization.

Fields:

Example:

{
    "id": 1234,
    "data" : {
        "transaction_token": "1234567890ABCDEF"
    }
}

Credit Card Additional Data

Object that specifies additional credit card data.

Fields:

Example:

{
    "transaction_token": "1234567890ABCDEF",
    "emv_receipt": {
        "application_label": null,
        "application_identifier": "A000000025010801",
        "terminal_identification": "001",
        "transaction_type": "00",
        "transaction_certificate": "8960887ACFD507FF",
        "authorization_code": "123456",
        "merchant_id": "123456789",
        "merchant_name": "EMV Merchant"
    }
}

EMV Receipt Structure

Structure containing receipt information for EMV transactions.

Fields:

Example:

{
    "application_label": "American Express",
    "application_identifier": "A000000025010801",
    "terminal_identification": "001",
    "transaction_type": "00",
    "transaction_certificate": "8960887ACFD507FF",
    "authorization_code": "123456",
    "merchant_id": "123456789",
    "merchant_name": "EMV Merchant"
}
    

Payment Bank Structure

Object that specifies a payment bank ID.

Fields:

Example:

{
    "id": 1234
}

Payment Bank Response Structure

Object that specifies the payment bank used in payment.

Fields:

Example:

{
    "id": 1234,
    "name": "WELLS FARGO BANK",
    "type": "Checking"
}

Preapproval Structure

Object that specifies unique ID of the preapproval associated with the checkout.

Fields:

Example:

{
    "id": 1234
}

Email Message Structure

Specifies a short message to send to the payee and payer when a checkout is successful.

Fields:

Example:

{
    "to_payee": "test",
    "to_payer": "test"
}

Fee Structure

Specifies the app_fee and fee_payer parameters for a checkout.

Fields:

Example:

{
    "app_fee": 20,
    "fee_payer": "payer"
}

Payments Prefill_Info Structure

The payments prefill_info structure contains prefill information for checkout, preapprovals, and subscription flows.

Fields:

Example:

{
    "name":"Bill Clerico",
    "phone_number":"555-555-5555"
}
    

Theme Structure

The theme structure contains information to provide custom look-and-feel for the flows and emails.

Fields:

Example:

{
	"theme_id":12345,
	"name":"API Theme for API App: My Sample Application",
	"primary_color":"FFFFFF",
	"secondary_color":"000000",
	"background_color":"004C64",
	"button_color":"0084A0"
}

Balances Structure

The balances structure contains information on the account balances and automated withdrawals. Accounts can have multiple balances (one for each currency they support).

Fields:

Example:

[
  {
    "currency":"USD",
    "balance":390.50,
    "incoming_pending_amount":635.30,
    "outgoing_pending_amount":210.00,
    "reserved_amount":0,
    "disputed_amount":0,
    "withdrawal_period":"daily",
    "withdrawal_type":"ach",
    "withdrawal_next_time":1370112217,
    "withdrawal_bank_name":"WellsFargo XXXXX3102"
  },
  {
    "currency":"CAD",
    "balance":40.50,
    "incoming_pending_amount":20.30,
    "outgoing_pending_amount":70.00,
    "reserved_amount":0,
    "disputed_amount":0,
    "withdrawal_period":"daily",
    "withdrawal_type":"ach",
    "withdrawal_next_time":1370112217,
    "withdrawal_bank_name":"TD Canada XXXXX4156"
  }
]
    

Fee Response Structure

Contains information about the app fee, processing fee paid to WePay, and fee_payer.

Fields:

Example:

{
        "app_fee": 20,
        "processing_fee": 20,
        "fee_payer": "payer"
}

Chargeback Response Structure

A chargeback occurs when a customer questions your charge with their bank or credit card company. When a customer disputes your charge, you are given the opportunity to respond to the dispute with evidence that shows the charge is legitimate.

The chargeback object specifies whether there was a chargeback and the amount chargebacked.

Fields:

Example:

{
    "amount_chargeback": 40,
    "dispute_uri": ""
}

Refund Response Structure

You can use the /checkout/refund API call to refund a charge.
The refund object contains information about the amount refunded and reason for the refund.

Fields:

Example:

{
    "amount_refunded": 20,
    "refund_reason": "test"
}

Hosted Checkout Response Structure

Contains the url for the checkout, redirect url, mode, theme object, and shipping information.

Fields:

Example:

{
  "checkout_uri": "http://wepay.com/api/iframe/1346959482/90404e3d/api_checkout?iframe=1",
  "redirect_uri": "http://www.test.com",
  "shipping_fee": 2,
  "require_shipping": true,
  "shipping_address": null,
  "theme_object": {
    "theme_id": 183446800,
    "name": "test",
    "primary_color": "ffffff",
    "secondary_color": "000000",
    "background_color": "ffffff",
    "button_color": "000000"
  },
  "mode": "iframe"
}

Bank Data Response Structure

The bank data structure contains information about the bank account for a withdrawal.

Fields:

Example:

{
  "bank_name":"TestBank XXXXXX3123",
  "account_last_four":"3123",
  "note":"Withdrawing money from the account"
}

Check Data Response Structure

The check data structure contains information about the check for a withdrawal.

Fields:

Example:

{
  "name":"Bill Clerico",
  "city":"Redwood City",
  "state":"CA",
  "zip":"94063",
  "note":"Withdrawing money from the account"
}

Withdrawal Data Response Structure

The withdrawal data structure contains information about the withdrawal.

Fields:

Example:

{
  "create_time":1332280083,
  "capture_time":0,
  "redirect_uri":"http://www.example.com/withdrawal/51341",
  "callback_uri":"http://www.example.com/withdrawal/callback/51341",
  "withdrawal_uri":"https://stage.wepay.com/api/withdrawal/54321/s341bxd"
}

Account Currency Status Structure

The account currency status structure contains information about an account's ability to process incoming/outgoing payments for a particular currency.

Fields:

Example:

{
  "currency":"USD",
  "incoming_payments_status":"ok",
  "outgoing_payments_status":"ok",
  "account_review_status":"pending"
}

International Phone Number Structure

The international phone number structure contains information to construct a valid E164 formatted phone number.

Fields:

Example:

{
  "country_code":"+1",
  "phone_number":"5556667777"
}

QR Code Structure

Links to QR code images at varying resolutions.

Fields:

Example:

{
    "@1x": "https://static.wepay.com/{path}/qr@1x.png",
    "@2x": "https://static.wepay.com/{path}/qr@2x.png",
    "@3x": "https://static.wepay.com/{path}/qr@3x.png",
    "shared_secret": "CsUWMeVN6Jaw)y4B)£JnhyYiJq£$(^jAoas1e%KfT1CSeBpd"
}

Non Profit Information Structure

This structure contains information about a non profit entity

Fields:

Example:

{
    "legal_name": "Org Name",
    "ein": "343644743"
}

Payment Error Structure

This structure contains additional information about a payment error that occurred on a checkout. At present, only Pay With Bank (ACH) transactions may have additional information.

Fields:

Example:

{
    "type": "payment_bank",
    "payment_bank": {
        "code": "R23",
        "description": "Credit entry refused by receiver"
    }
}

Payment Bank Payment Error Structure

This structure contains additional information related to the payment bank payment error that occurred on a checkout.

Fields:

Example:

{
    "code": "R23",
    "description": "Credit entry refused by receiver"
}

Country Option Structure

The country option structure is currently used to enable debit card as a payment method in Canada.

Fields:

Example:

Allowing Debit Card Payment:

{
    "debit_opt_in":true
}
    

Not Allowing Debit Card Payment:

{
    "debit_opt_in":false
}