Payment APIs Spec

Bambora Payment APIs

https://api.na.bambora.com/v1

Version: 1.0.5

Security

Passcode

(api key)

Pass the authorization header in your request as "Authorization: Passcode Base64Encoded(merchant_id:passcode)"

Name	In
Passcode	header

Sub-Merchant-Id

(api key)

OPTIONAL: Only used by partners to make an API call on behalf of their subMerchant. Pass the header in your request as "Sub-Merchant-Id: sub_merchant_id"

Name	In
Sub-Merchant-Id	header

Make a payment using credit card, cash, cheque, profile, token, Apple Pay, or Google Pay. Each payment type has its own json definition passed in the body. For all payments you have the standard Billing, Shipping, Comments, etc. fields that are optional. Only the amount is required along with the payment data for card, cash, cheque, profile, and token. You must change the payment_method for each payment type. Credit Card - "card", Payment Profile - "payment_profile", Single Use Token - "token", Cash - "cash", Cheque - "cheque", Interac - "interac", Apple Pay - "apple_pay", Google Pay - "google_pay".

Parameters

Required	In	Name	Description	Schema
	body	payment_request		PaymentRequest

Parameter Schema Definitions
PaymentRequest { order_number : string maxLength: 30 description: A unique order number. amount* : number format: double description: A decimal value in dollars. Uses up to two decimal places. Max value is account specific. Default max value is 1000. payment_method* : string Enum (10) card token payment_profile cash cheque interac apple_pay google_pay 3d_secure_token processor_token description: The desired method of payment. language : string maxLength: 3 description: characters customer_ip : string maxLength: 30 description: IP Address of the api consumer. Required if calculating risk score. term_url : string maxLength: 256 description: Callback URL used with 3D Secure payment processing. comments : string maxLength: 256 description: alphanumeric billing : RequestBillingAddress { name : string maxLength: 64 description: Name of the person/business address_line1 : string maxLength: 64 description: Street address. Impacts risk score. address_line2 : string maxLength: 64 description: Additional address information(eg; suite number, apartment number, etc) city : string maxLength: 32 description: The city. Impacts risk score. province : string description: 2 characters. Set to -- for any countries except for US and Canada. Impacts risk score. country : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW maxLength: 2 description: Valid ISO 3166-1 country code. Impacts risk score. postal_code : string maxLength: 16 description: Postal/Zip code. Impacts risk score. phone_number : string pattern: ^\d{1,20}$ description: Phone number email_address : string maxLength: 64 description: Email Address. Impacts risk score. } shipping : Address { name : string maxLength: 64 description: Name of the person/business address_line1 : string maxLength: 64 description: Street address address_line2 : string maxLength: 64 description: Additional address information(eg; suite number, apartment number, etc) city : string maxLength: 32 description: The city province : string description: characters (2) country : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW maxLength: 2 description: Valid ISO 3166-1 country code postal_code : string maxLength: 16 description: Postal/Zip code phone_number : string pattern: ^\d{1,20}$ description: Phone number email_address : string maxLength: 64 description: Email Address } custom : Custom { ref1 : string maxLength: 256 description: custom reference field 1 ref2 : string maxLength: 256 description: custom reference field 2 ref3 : string maxLength: 256 description: custom reference field 3 ref4 : string maxLength: 256 description: custom reference field 4 ref5 : string maxLength: 256 description: custom reference field 5 } card : Card { Payment with a credit card. The payment_method must be 'card' number* : string default: 5100000010001004 maxLength: 20 description: Credit card number (PAN). name* : string minLength: 1 maxLength: 64 description: Card holder name. expiry_month* : string default: 02 maxLength: 2 description: eg. 02 for February. expiry_year* : string default: 18 maxLength: 2 description: eg. 15 for 2015. cvd : string default: 123 minLength: 3 maxLength: 4 description: Security code on the back of the credit card. This can be set to mandatory in the back office. 3d_secure : 3DSecure { Payment with 3D Secure (Verified by Visa, Mastercard SecureCode, American Express SafeKey). Note that 3D Secure must be enabled on the merchant account in order to process transactions with 3D Secure. browser : BrowserData { Data collected about the cardholders browser, required for 3DS 2.0 transactions, optional for others. accept_header* : string maxLength: 2048 description: HTTP Accept Header returned by the browser. java_enabled* : boolean description: True if the browser supports Java. language* : string maxLength: 8 description: Language currently set in the browser. color_depth : integer description: Color bit-depth of the screen. screen_height* : integer description: Height, in pixels, of the screen. screen_width* : integer description: Width, in pixels, of the screen. time_zone* : integer description: Timezone returned by the browser. user_agent* : string maxLength: 2048 description: User-Agent header returned by the browser in the client HTTP request. javascript_enabled* : boolean default: true description: True if the browser has JavaScript enabled. } enabled* : boolean default: true description: If 3D Secure is enabled on the merchant account, set to false to process transactions without 3D Secure. Otherwise, set to true to process transactions with 3D Secure. version : integer description: Version of 3DS to perform (1 or 2). Optional and will default to what is configured in the merchants account. auth_required : boolean description: If set to true the transaction will not continue processing unless 3DS authentication is successful. xid : string description: The transaction ID (XID) used for processing transactions with 3D Secure. cavv : string description: The cardholder authentication verification value (CAVV/UCAF/AEVV) used for processing transactions with 3D Secure. eci : integer description: The electronic commerce indicator (ECI) used for processing transactions with 3D Secure. } visa_checkout_call_id : string maxLength: 20 description: The Visa Checkout payment request ID. complete : boolean default: true description: set to false for Pre-Authorize, and true to complete a payment is_accord_d : boolean description: required flag for desjardin visa cards that want to make Accord D financing transactions. Accord D transactions require billing information as well accord_d : AccordD { Desjardin Visa Only - required for a complete Accord D financing transaction financing_type* : string Enum (2) D E default: E maxLength: 1 description: Deferred(D) or Equal(E) payment plan_number* : string maxLength: 3 description: Must be a value between 000 - ZZZ grace_period* : integer default: 0 description: Must be 0 if financing_type is not a deferred payment term* : integer description: Number of months. Must be 00 is financing_type is not a deferred payment } } apple_pay : ApplePay { Apple Pay Only - required when attempting to process apple_pay transactions. Note that the 'card' object returned in a successful response will have a 'last_four' property value that is based on the source Apple Pay Wallet and its Device Account Number. apple_pay_merchant_id* : string description: The Apple Pay merchant ID. payment_token* : string description: The encrypted token provided by Apple Pay that you then Base64 encode. complete : boolean default: true description: set to false for Pre-Authorize, and true to complete a payment } google_pay : GooglePay { Google Pay Only - required when attempting to process google_pay transactions. name : string description: The cardholder name. 3d_secure : 3DSecure { Payment with 3D Secure (Verified by Visa, Mastercard SecureCode, American Express SafeKey). Note that 3D Secure must be enabled on the merchant account in order to process transactions with 3D Secure. browser : BrowserData { Data collected about the cardholders browser, required for 3DS 2.0 transactions, optional for others. accept_header* : string maxLength: 2048 description: HTTP Accept Header returned by the browser. java_enabled* : boolean description: True if the browser supports Java. language* : string maxLength: 8 description: Language currently set in the browser. color_depth : integer description: Color bit-depth of the screen. screen_height* : integer description: Height, in pixels, of the screen. screen_width* : integer description: Width, in pixels, of the screen. time_zone* : integer description: Timezone returned by the browser. user_agent* : string maxLength: 2048 description: User-Agent header returned by the browser in the client HTTP request. javascript_enabled* : boolean default: true description: True if the browser has JavaScript enabled. } enabled* : boolean default: true description: If 3D Secure is enabled on the merchant account, set to false to process transactions without 3D Secure. Otherwise, set to true to process transactions with 3D Secure. version : integer description: Version of 3DS to perform (1 or 2). Optional and will default to what is configured in the merchants account. auth_required : boolean description: If set to true the transaction will not continue processing unless 3DS authentication is successful. xid : string description: The transaction ID (XID) used for processing transactions with 3D Secure. cavv : string description: The cardholder authentication verification value (CAVV/UCAF/AEVV) used for processing transactions with 3D Secure. eci : integer description: The electronic commerce indicator (ECI) used for processing transactions with 3D Secure. } transaction_payload* : string description: Payload that contains the encrypted Google payment token (required to complete a transaction), along with other security information. complete : boolean default: true description: set to false for Pre-Authorize, and true to complete a payment } payment_profile : ProfilePurchase { Payment with a Payment Profile. The payment_method must be 'payment_profile' complete : boolean default: true description: Set to false for Pre-Authorize, and true to complete a payment customer_code* : string maxLength: 32 description: The payment profile ID. card_id* : integer maxLength: 1 description: Which credit card to use. Starts at 1 for the first card. You must configure how many cards can be stored by visiting the profile options in the back office. } token : TokenPurchase { Payment with a single-use token. The payment_method must be 'token' complete : boolean description: Set to false for Pre-Authorize, and true to complete a payment code* : string maxLength: 40 description: the payment token you retrieved from the service. name* : string minLength: 4 maxLength: 64 description: Card holder name. 3d_secure : 3DSecure { Payment with 3D Secure (Verified by Visa, Mastercard SecureCode, American Express SafeKey). Note that 3D Secure must be enabled on the merchant account in order to process transactions with 3D Secure. browser : BrowserData { Data collected about the cardholders browser, required for 3DS 2.0 transactions, optional for others. accept_header* : string maxLength: 2048 description: HTTP Accept Header returned by the browser. java_enabled* : boolean description: True if the browser supports Java. language* : string maxLength: 8 description: Language currently set in the browser. color_depth : integer description: Color bit-depth of the screen. screen_height* : integer description: Height, in pixels, of the screen. screen_width* : integer description: Width, in pixels, of the screen. time_zone* : integer description: Timezone returned by the browser. user_agent* : string maxLength: 2048 description: User-Agent header returned by the browser in the client HTTP request. javascript_enabled* : boolean default: true description: True if the browser has JavaScript enabled. } enabled* : boolean default: true description: If 3D Secure is enabled on the merchant account, set to false to process transactions without 3D Secure. Otherwise, set to true to process transactions with 3D Secure. version : integer description: Version of 3DS to perform (1 or 2). Optional and will default to what is configured in the merchants account. auth_required : boolean description: If set to true the transaction will not continue processing unless 3DS authentication is successful. xid : string description: The transaction ID (XID) used for processing transactions with 3D Secure. cavv : string description: The cardholder authentication verification value (CAVV/UCAF/AEVV) used for processing transactions with 3D Secure. eci : integer description: The electronic commerce indicator (ECI) used for processing transactions with 3D Secure. } visa_checkout_call_id : string maxLength: 20 description: The Visa Checkout payment request ID. } 3d_secure : 3d_secure_token { Payment with a 3D Secure Session Data token. Reference a previously processed 3D Secure transaction processed through the 3D Secure 2.0 API. This will apply the associated card number, card expiry, and 3D Secure results to your payment request. The payment_method must be '3d_secure' complete : boolean description: Set to false for Pre-Authorize, and true to complete a payment threeDS_session_data* : string minLength: 1 maxLength: 128 description: auth_required : boolean description: If set to true the transaction will not continue processing unless 3DS authentication is successful. } recurring_payment : boolean description: A recurring transaction is a transaction where a cardholder had provided permission to a merchant to periodically charge his/her account number for recurring goods or services. The recurring payment indicator may be set for credit card based pre-auth, capture and purchase transactions. level2 : Level2 { Level 2 processing is for B2B customers. Additional information can be provided, to the benefit of corporate/government/industrial customers, that includes a customer code & tax amounts. customer_code* : string maxLength: 17 description: Visa - Used by merchant to identify the purchase (i.e. SKU number). Master Card - Code the cardholder supplied to the merchant. American Express - Customer reference number. order_tax1_price* : number format: double maxLength: 12 description: Visa - Amount of state or provincial tax included in the transaction amount - Must between 0.1% and 22% of the transaction amount. Master Card - Sales tax/VAT on the total purchase - Must be between 0.1% and 30% of the transaction amount. American Express - Transaction tax amount (calculated or entered). order_tax2_price* : number format: double maxLength: 12 description: Visa - Amount of state or provincial tax included in the transaction amount - Must between 0.1% and 22% of the transaction amount. Master Card - Sales tax/VAT on the total purchase - Must be between 0.1% and 30% of the transaction amount. American Express - Transaction tax amount (calculated or entered). } card_on_file : CardOnFile { When processing a transaction where the credit card information is stored on file, you must pass along an indicator showing the type of credential-on-file transaction that is being processed. type* : string Enum (7) not_card_on_file first_installment subsequent_installment first_recurring subsequent_recurring subsequent_customer_initiated subsequent_unscheduled description: not_card_on_file - A transaction where the credit card information is not stored on file. first_installment - The first payment in a series of installment payments. (Eg. Initial installment payment when purchasing a fridge.) subsequent_installment - A subsequent payment (ie. not the first) in a series of installment payments. (Eg. Next installment payment when purchasing a fridge.) first_recurring - The first payment in a series of scheduled payments with no expected end date. (Eg. Initial payment for a subscription service.) subsequent_recurring - A subsequent payment (ie. not the first) in a series of scheduled payments with no expected end date. (Eg. Next payment for a subscription service.) subsequent_customer_initiated - A recurring transaction that is initiated by the customer. (Eg. Customer reloads a prepaid cash card.) subsequent_unscheduled - An unscheduled recurring transaction that is initiated by the merchant. (Eg. Merchant auto-reloads a prepaid cash card for the customer when the balance on the card reaches a predetermined threshold.) series_id : number format: integer description: The identifier for the set of transactions that this transaction belongs to. This field is required for "subsequent_installment", "subsequent_recurring", and "subsequent_unscheduled" credential-on-file transaction types. } processor_token : ProcessorTokenRequest { Payment with Processor Token. The payment_method must be 'processor_token'. payment_token* : string minLength: 15 maxLength: 19 description: The payment token you retrieved from the service. expiry_month* : string maxLength: 2 description: eg. 02 for February. expiry_year* : string maxLength: 2 description: eg. 15 for 2015. } }

Parameter Schema Definitions

PaymentRequest { order_number : string maxLength: 30 description:

A unique order number.

amount* : number format: double description:

A decimal value in dollars. Uses up to two decimal places. Max value is account specific. Default max value is 1000.

payment_method* : string Enum (10) card token payment_profile cash cheque interac apple_pay google_pay 3d_secure_token processor_token description:

The desired method of payment.

language : string maxLength: 3 description:

characters

customer_ip : string maxLength: 30 description:

IP Address of the api consumer. Required if calculating risk score.

term_url : string maxLength: 256 description:

Callback URL used with 3D Secure payment processing.

comments : string maxLength: 256 description:

alphanumeric

billing : RequestBillingAddress { name : string maxLength: 64 description:

Name of the person/business

address_line1 : string maxLength: 64 description:

Street address. Impacts risk score.

address_line2 : string maxLength: 64 description:

Additional address information(eg; suite number, apartment number, etc)

city : string maxLength: 32 description:

The city. Impacts risk score.

province : string description:

2 characters. Set to -- for any countries except for US and Canada. Impacts risk score.

country : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW maxLength: 2 description:

Valid ISO 3166-1 country code. Impacts risk score.

postal_code : string maxLength: 16 description:

Postal/Zip code. Impacts risk score.

phone_number : string pattern: ^\d{1,20}$ description:

Phone number

email_address : string maxLength: 64 description:

Email Address. Impacts risk score.

} shipping : Address { name : string maxLength: 64 description:

Name of the person/business

address_line1 : string maxLength: 64 description:

Street address

address_line2 : string maxLength: 64 description:

Additional address information(eg; suite number, apartment number, etc)

city : string maxLength: 32 description:

The city

province : string description:

characters (2)

Valid ISO 3166-1 country code

postal_code : string maxLength: 16 description:

Postal/Zip code

phone_number : string pattern: ^\d{1,20}$ description:

Phone number

email_address : string maxLength: 64 description:

Email Address

} custom : Custom { ref1 : string maxLength: 256 description:

custom reference field 1

ref2 : string maxLength: 256 description:

custom reference field 2

ref3 : string maxLength: 256 description:

custom reference field 3

ref4 : string maxLength: 256 description:

custom reference field 4

ref5 : string maxLength: 256 description:

custom reference field 5

} card : Card { Payment with a credit card. The payment_method must be 'card' number* : string default: 5100000010001004 maxLength: 20 description:

Credit card number (PAN).

name* : string minLength: 1 maxLength: 64 description:

Card holder name.

expiry_month* : string default: 02 maxLength: 2 description:

eg. 02 for February.

expiry_year* : string default: 18 maxLength: 2 description:

eg. 15 for 2015.

cvd : string default: 123 minLength: 3 maxLength: 4 description:

Security code on the back of the credit card. This can be set to mandatory in the back office.

3d_secure : 3DSecure { Payment with 3D Secure (Verified by Visa, Mastercard SecureCode, American Express SafeKey). Note that 3D Secure must be enabled on the merchant account in order to process transactions with 3D Secure. browser : BrowserData { Data collected about the cardholders browser, required for 3DS 2.0 transactions, optional for others. accept_header* : string maxLength: 2048 description:

HTTP Accept Header returned by the browser.

java_enabled* : boolean description:

True if the browser supports Java.

language* : string maxLength: 8 description:

Language currently set in the browser.

color_depth : integer description:

Color bit-depth of the screen.

screen_height* : integer description:

Height, in pixels, of the screen.

screen_width* : integer description:

Width, in pixels, of the screen.

time_zone* : integer description:

Timezone returned by the browser.

user_agent* : string maxLength: 2048 description:

User-Agent header returned by the browser in the client HTTP request.

javascript_enabled* : boolean default: true description:

True if the browser has JavaScript enabled.

} enabled* : boolean default: true description:

If 3D Secure is enabled on the merchant account, set to false to process transactions without 3D Secure. Otherwise, set to true to process transactions with 3D Secure.

version : integer description:

Version of 3DS to perform (1 or 2). Optional and will default to what is configured in the merchants account.

auth_required : boolean description:

If set to true the transaction will not continue processing unless 3DS authentication is successful.

xid : string description:

The transaction ID (XID) used for processing transactions with 3D Secure.

cavv : string description:

The cardholder authentication verification value (CAVV/UCAF/AEVV) used for processing transactions with 3D Secure.

eci : integer description:

The electronic commerce indicator (ECI) used for processing transactions with 3D Secure.

} visa_checkout_call_id : string maxLength: 20 description:

The Visa Checkout payment request ID.

complete : boolean default: true description:

set to false for Pre-Authorize, and true to complete a payment

is_accord_d : boolean description:

required flag for desjardin visa cards that want to make Accord D financing transactions. Accord D transactions require billing information as well

accord_d : AccordD { Desjardin Visa Only - required for a complete Accord D financing transaction financing_type* : string Enum (2) D E default: E maxLength: 1 description:

Deferred(D) or Equal(E) payment

plan_number* : string maxLength: 3 description:

Must be a value between 000 - ZZZ

grace_period* : integer default: 0 description:

Must be 0 if financing_type is not a deferred payment

term* : integer description:

Number of months. Must be 00 is financing_type is not a deferred payment

} } apple_pay : ApplePay { Apple Pay Only - required when attempting to process apple_pay transactions. Note that the 'card' object returned in a successful response will have a 'last_four' property value that is based on the source Apple Pay Wallet and its Device Account Number. apple_pay_merchant_id* : string description:

The Apple Pay merchant ID.

payment_token* : string description:

The encrypted token provided by Apple Pay that you then Base64 encode.

complete : boolean default: true description:

set to false for Pre-Authorize, and true to complete a payment

} google_pay : GooglePay { Google Pay Only - required when attempting to process google_pay transactions. name : string description:

The cardholder name.

HTTP Accept Header returned by the browser.

java_enabled* : boolean description:

True if the browser supports Java.

language* : string maxLength: 8 description:

Language currently set in the browser.

color_depth : integer description:

Color bit-depth of the screen.

screen_height* : integer description:

Height, in pixels, of the screen.

screen_width* : integer description:

Width, in pixels, of the screen.

time_zone* : integer description:

Timezone returned by the browser.

user_agent* : string maxLength: 2048 description:

User-Agent header returned by the browser in the client HTTP request.

javascript_enabled* : boolean default: true description:

True if the browser has JavaScript enabled.

} enabled* : boolean default: true description:

If 3D Secure is enabled on the merchant account, set to false to process transactions without 3D Secure. Otherwise, set to true to process transactions with 3D Secure.

version : integer description:

Version of 3DS to perform (1 or 2). Optional and will default to what is configured in the merchants account.

auth_required : boolean description:

If set to true the transaction will not continue processing unless 3DS authentication is successful.

xid : string description:

The transaction ID (XID) used for processing transactions with 3D Secure.

cavv : string description:

The cardholder authentication verification value (CAVV/UCAF/AEVV) used for processing transactions with 3D Secure.

eci : integer description:

The electronic commerce indicator (ECI) used for processing transactions with 3D Secure.

} transaction_payload* : string description:

Payload that contains the encrypted Google payment token (required to complete a transaction), along with other security information.

complete : boolean default: true description:

set to false for Pre-Authorize, and true to complete a payment

} payment_profile : ProfilePurchase { Payment with a Payment Profile. The payment_method must be 'payment_profile' complete : boolean default: true description:

Set to false for Pre-Authorize, and true to complete a payment

customer_code* : string maxLength: 32 description:

The payment profile ID.

card_id* : integer maxLength: 1 description:

Which credit card to use. Starts at 1 for the first card. You must configure how many cards can be stored by visiting the profile options in the back office.

} token : TokenPurchase { Payment with a single-use token. The payment_method must be 'token' complete : boolean description:

Set to false for Pre-Authorize, and true to complete a payment

code* : string maxLength: 40 description:

the payment token you retrieved from the service.

name* : string minLength: 4 maxLength: 64 description:

Card holder name.

HTTP Accept Header returned by the browser.

java_enabled* : boolean description:

True if the browser supports Java.

language* : string maxLength: 8 description:

Language currently set in the browser.

color_depth : integer description:

Color bit-depth of the screen.

screen_height* : integer description:

Height, in pixels, of the screen.

screen_width* : integer description:

Width, in pixels, of the screen.

time_zone* : integer description:

Timezone returned by the browser.

user_agent* : string maxLength: 2048 description:

User-Agent header returned by the browser in the client HTTP request.

javascript_enabled* : boolean default: true description:

True if the browser has JavaScript enabled.

} enabled* : boolean default: true description:

If 3D Secure is enabled on the merchant account, set to false to process transactions without 3D Secure. Otherwise, set to true to process transactions with 3D Secure.

version : integer description:

Version of 3DS to perform (1 or 2). Optional and will default to what is configured in the merchants account.

auth_required : boolean description:

If set to true the transaction will not continue processing unless 3DS authentication is successful.

xid : string description:

The transaction ID (XID) used for processing transactions with 3D Secure.

cavv : string description:

The cardholder authentication verification value (CAVV/UCAF/AEVV) used for processing transactions with 3D Secure.

eci : integer description:

The electronic commerce indicator (ECI) used for processing transactions with 3D Secure.

} visa_checkout_call_id : string maxLength: 20 description:

The Visa Checkout payment request ID.

} 3d_secure : 3d_secure_token { Payment with a 3D Secure Session Data token. Reference a previously processed 3D Secure transaction processed through the 3D Secure 2.0 API. This will apply the associated card number, card expiry, and 3D Secure results to your payment request. The payment_method must be '3d_secure' complete : boolean description:

Set to false for Pre-Authorize, and true to complete a payment

threeDS_session_data* : string minLength: 1 maxLength: 128 description: auth_required : boolean description:

If set to true the transaction will not continue processing unless 3DS authentication is successful.

} recurring_payment : boolean description:

A recurring transaction is a transaction where a cardholder had provided permission to a merchant to periodically charge his/her account number for recurring goods or services. The recurring payment indicator may be set for credit card based pre-auth, capture and purchase transactions.

level2 : Level2 { Level 2 processing is for B2B customers. Additional information can be provided, to the benefit of corporate/government/industrial customers, that includes a customer code & tax amounts. customer_code* : string maxLength: 17 description:

Visa - Used by merchant to identify the purchase (i.e. SKU number).
Master Card - Code the cardholder supplied to the merchant.
American Express - Customer reference number.

order_tax1_price* : number format: double maxLength: 12 description:

Visa - Amount of state or provincial tax included in the transaction amount - Must between 0.1% and 22% of the transaction amount.
Master Card - Sales tax/VAT on the total purchase - Must be between 0.1% and 30% of the transaction amount.
American Express - Transaction tax amount (calculated or entered).

order_tax2_price* : number format: double maxLength: 12 description:

Visa - Amount of state or provincial tax included in the transaction amount - Must between 0.1% and 22% of the transaction amount.
Master Card - Sales tax/VAT on the total purchase - Must be between 0.1% and 30% of the transaction amount.
American Express - Transaction tax amount (calculated or entered).

} card_on_file : CardOnFile { When processing a transaction where the credit card information is stored on file, you must pass along an indicator showing the type of credential-on-file transaction that is being processed. type* : string Enum (7) not_card_on_file first_installment subsequent_installment first_recurring subsequent_recurring subsequent_customer_initiated subsequent_unscheduled description:

not_card_on_file - A transaction where the credit card information is not stored on file.
first_installment - The first payment in a series of installment payments. (Eg. Initial installment payment when purchasing a fridge.)
subsequent_installment - A subsequent payment (ie. not the first) in a series of installment payments. (Eg. Next installment payment when purchasing a fridge.)
first_recurring - The first payment in a series of scheduled payments with no expected end date. (Eg. Initial payment for a subscription service.)
subsequent_recurring - A subsequent payment (ie. not the first) in a series of scheduled payments with no expected end date. (Eg. Next payment for a subscription service.)
subsequent_customer_initiated - A recurring transaction that is initiated by the customer. (Eg. Customer reloads a prepaid cash card.)
subsequent_unscheduled - An unscheduled recurring transaction that is initiated by the merchant. (Eg. Merchant auto-reloads a prepaid cash card for the customer when the balance on the card reaches a predetermined threshold.)

series_id : number format: integer description:

The identifier for the set of transactions that this transaction belongs to. This field is required for "subsequent_installment", "subsequent_recurring", and "subsequent_unscheduled" credential-on-file transaction types.

} processor_token : ProcessorTokenRequest { Payment with Processor Token. The payment_method must be 'processor_token'. payment_token* : string minLength: 15 maxLength: 19 description:

The payment token you retrieved from the service.

expiry_month* : string maxLength: 2 description:

eg. 02 for February.

expiry_year* : string maxLength: 2 description:

eg. 15 for 2015.

} }

Responses

Code	Description	Schema
200	Payment response containing the payment details as well as if the payment was approved or declined.	PaymentResponse
400	Bad Request	ErrorResponse
401	Authentication Failure	ErrorResponse
402	Business Rule Violation or Decline	ErrorResponse
403	Authorization Failure	ErrorResponse
405	Invalid Request Method	ErrorResponse
500	Internal Server Error	ErrorResponse

Response Schema Definitions
PaymentResponse { id : string maxLength: 9 description: transaction Id authorizing_merchant_id : integer description: The id of the merchant that authorized the transaction. approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code created : string format: date-time description: Time stamp of when the transaction occurred order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC maxLength: 16 description: Payment transaction type risk_score : number format: double description: The risk score represents the percentage of probability that the transaction is fraudulent. For example, a score of 10 represents a 10% possibility that the transaction is fraudulent. amount : number format: double maxLength: 9 description: A decimal value in dollars. Uses up to two decimal places. payment_method : string Enum (8) card token payment_profile cash cheque interac apple_pay google_pay description: Payment method custom : Custom { ref1 : string maxLength: 256 description: custom reference field 1 ref2 : string maxLength: 256 description: custom reference field 2 ref3 : string maxLength: 256 description: custom reference field 3 ref4 : string maxLength: 256 description: custom reference field 4 ref5 : string maxLength: 256 description: custom reference field 5 } card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } 3d_secure : 3DSecureResponse { 3D Secure result data status* : string description: Status of 3D secure authentication for the transaction. One of: Success, Attempted, Rejected, Failed, Unavailable, or Error } merchant_data : string maxLength: 32 description: Returned only for 'interac' or 3D Secure payment requests. This value can be used as the {id} value when creating your 'continue' endpoint URL. contents : string description: Returned only for 'interac' or 3D Secure payment requests. This should be embedded in the user's browser client and this needs to be displayed to the customer to redirect them to the Interac login or 3D Secure processing page. interac_online : InteracOnlineResponse { Returned only in the final response from the 'continue' endpoint. idebit_issconf : string description: A numeric confirmation code of the payment idebit_issname : string description: Name of the account holder's financial institution } links : array of Link { ref : string pattern: ^[a-zA-z]{1,16}$ description: Eg. "void" or "return" href : string maxLength: 256 description: Url to perform the void, return, completion etc. method : string pattern: ^[a-zA-z]{1,16}$ description: Http method. post, put, get etc. } card_on_file : CardOnFileResponse { type : string Enum (7) not_card_on_file first_installment subsequent_installment first_recurring subsequent_recurring subsequent_customer_initiated subsequent_unscheduled description: not_card_on_file - A transaction where the credit card information is not stored on file. first_installment - The first payment in a series of installment payments. (Eg. Initial installment payment when purchasing a fridge.) subsequent_installment - A subsequent payment (ie. not the first) in a series of installment payments. (Eg. Next installment payment when purchasing a fridge.) first_recurring - The first payment in a series of scheduled payments with no expected end date. (Eg. Initial payment for a subscription service.) subsequent_recurring - A subsequent payment (ie. not the first) in a series of scheduled payments with no expected end date. (Eg. Next payment for a subscription service.) subsequent_customer_initiated - A recurring transaction that is initiated by the customer. (Eg. Customer reloads a prepaid cash card.) subsequent_unscheduled - An unscheduled recurring transaction that is initiated by the merchant. (Eg. Merchant auto-reloads a prepaid cash card for the customer when the balance on the card reaches a predetermined threshold.) series_id : number format: integer description: The identifier for the set of transactions that this transaction belongs to. } }
ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description: Not used. Always returns an empty string. card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }

Response Schema Definitions

PaymentResponse { id : string maxLength: 9 description:

transaction Id

authorizing_merchant_id : integer description:

The id of the merchant that authorized the transaction.

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

created : string format: date-time description:

Time stamp of when the transaction occurred

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC maxLength: 16 description:

Payment transaction type

risk_score : number format: double description:

The risk score represents the percentage of probability that the transaction is fraudulent. For example, a score of 10 represents a 10% possibility that the transaction is fraudulent.

amount : number format: double maxLength: 9 description:

A decimal value in dollars. Uses up to two decimal places.

payment_method : string Enum (8) card token payment_profile cash cheque interac apple_pay google_pay description:

Payment method

custom : Custom { ref1 : string maxLength: 256 description:

custom reference field 1

ref2 : string maxLength: 256 description:

custom reference field 2

ref3 : string maxLength: 256 description:

custom reference field 3

ref4 : string maxLength: 256 description:

custom reference field 4

ref5 : string maxLength: 256 description:

custom reference field 5

} card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction.

card_bin : string minLength: 6 maxLength: 8 description:

For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token.

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank.

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response.

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description:

This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} 3d_secure : 3DSecureResponse { 3D Secure result data status* : string description:

Status of 3D secure authentication for the transaction. One of: Success, Attempted, Rejected, Failed, Unavailable, or Error

} merchant_data : string maxLength: 32 description:

Returned only for 'interac' or 3D Secure payment requests. This value can be used as the {id} value when creating your 'continue' endpoint URL.

contents : string description:

Returned only for 'interac' or 3D Secure payment requests. This should be embedded in the user's browser client and this needs to be displayed to the customer to redirect them to the Interac login or 3D Secure processing page.

interac_online : InteracOnlineResponse { Returned only in the final response from the 'continue' endpoint. idebit_issconf : string description:

A numeric confirmation code of the payment

idebit_issname : string description:

Name of the account holder's financial institution

} links : array of Link { ref : string pattern: ^[a-zA-z]{1,16}$ description:

Eg. "void" or "return"

href : string maxLength: 256 description:

Url to perform the void, return, completion etc.

method : string pattern: ^[a-zA-z]{1,16}$ description:

Http method. post, put, get etc.

} card_on_file : CardOnFileResponse { type : string Enum (7) not_card_on_file first_installment subsequent_installment first_recurring subsequent_recurring subsequent_customer_initiated subsequent_unscheduled description:

not_card_on_file - A transaction where the credit card information is not stored on file.
first_installment - The first payment in a series of installment payments. (Eg. Initial installment payment when purchasing a fridge.)
subsequent_installment - A subsequent payment (ie. not the first) in a series of installment payments. (Eg. Next installment payment when purchasing a fridge.)
first_recurring - The first payment in a series of scheduled payments with no expected end date. (Eg. Initial payment for a subscription service.)
subsequent_recurring - A subsequent payment (ie. not the first) in a series of scheduled payments with no expected end date. (Eg. Next payment for a subscription service.)
subsequent_customer_initiated - A recurring transaction that is initiated by the customer. (Eg. Customer reloads a prepaid cash card.)
subsequent_unscheduled - An unscheduled recurring transaction that is initiated by the merchant. (Eg. Merchant auto-reloads a prepaid cash card for the customer when the balance on the card reaches a predetermined threshold.)

series_id : number format: integer description:

The identifier for the set of transactions that this transaction belongs to.

} }

ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description:

Not used. Always returns an empty string.

card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

POST

/payments/{transId}/returns

Return payment

Description

Return payment.

Parameters

Required	In	Name	Description	Schema
true	path	transId	The transaction id.	number
true	body	return		Return

Parameter Schema Definitions
Return { order_number : string maxLength: 30 description: A unique order number. amount* : number format: double description: A decimal value in dollars. Must be less than or equal to the original purchase amount. }

Responses

Code	Description	Schema
200	Payment response containing the payment details as well as if the transaction was approved or declined.	PaymentResponse
400	Bad Request	ErrorResponse
401	Authentication Failure	ErrorResponse
402	Business Rule Violation or Decline	ErrorResponse
403	Authorization Failure	ErrorResponse
405	Invalid Request Method	ErrorResponse
500	Internal Server Error	ErrorResponse

Response Schema Definitions
PaymentResponse { id : string maxLength: 9 description: transaction Id authorizing_merchant_id : integer description: The id of the merchant that authorized the transaction. approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code created : string format: date-time description: Time stamp of when the transaction occurred order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC maxLength: 16 description: Payment transaction type risk_score : number format: double description: The risk score represents the percentage of probability that the transaction is fraudulent. For example, a score of 10 represents a 10% possibility that the transaction is fraudulent. amount : number format: double maxLength: 9 description: A decimal value in dollars. Uses up to two decimal places. payment_method : string Enum (8) card token payment_profile cash cheque interac apple_pay google_pay description: Payment method custom : Custom { ref1 : string maxLength: 256 description: custom reference field 1 ref2 : string maxLength: 256 description: custom reference field 2 ref3 : string maxLength: 256 description: custom reference field 3 ref4 : string maxLength: 256 description: custom reference field 4 ref5 : string maxLength: 256 description: custom reference field 5 } card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } 3d_secure : 3DSecureResponse { 3D Secure result data status* : string description: Status of 3D secure authentication for the transaction. One of: Success, Attempted, Rejected, Failed, Unavailable, or Error } merchant_data : string maxLength: 32 description: Returned only for 'interac' or 3D Secure payment requests. This value can be used as the {id} value when creating your 'continue' endpoint URL. contents : string description: Returned only for 'interac' or 3D Secure payment requests. This should be embedded in the user's browser client and this needs to be displayed to the customer to redirect them to the Interac login or 3D Secure processing page. interac_online : InteracOnlineResponse { Returned only in the final response from the 'continue' endpoint. idebit_issconf : string description: A numeric confirmation code of the payment idebit_issname : string description: Name of the account holder's financial institution } links : array of Link { ref : string pattern: ^[a-zA-z]{1,16}$ description: Eg. "void" or "return" href : string maxLength: 256 description: Url to perform the void, return, completion etc. method : string pattern: ^[a-zA-z]{1,16}$ description: Http method. post, put, get etc. } card_on_file : CardOnFileResponse { type : string Enum (7) not_card_on_file first_installment subsequent_installment first_recurring subsequent_recurring subsequent_customer_initiated subsequent_unscheduled description: not_card_on_file - A transaction where the credit card information is not stored on file. first_installment - The first payment in a series of installment payments. (Eg. Initial installment payment when purchasing a fridge.) subsequent_installment - A subsequent payment (ie. not the first) in a series of installment payments. (Eg. Next installment payment when purchasing a fridge.) first_recurring - The first payment in a series of scheduled payments with no expected end date. (Eg. Initial payment for a subscription service.) subsequent_recurring - A subsequent payment (ie. not the first) in a series of scheduled payments with no expected end date. (Eg. Next payment for a subscription service.) subsequent_customer_initiated - A recurring transaction that is initiated by the customer. (Eg. Customer reloads a prepaid cash card.) subsequent_unscheduled - An unscheduled recurring transaction that is initiated by the merchant. (Eg. Merchant auto-reloads a prepaid cash card for the customer when the balance on the card reaches a predetermined threshold.) series_id : number format: integer description: The identifier for the set of transactions that this transaction belongs to. } }
ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description: Not used. Always returns an empty string. card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }

Response Schema Definitions

PaymentResponse { id : string maxLength: 9 description:

transaction Id

authorizing_merchant_id : integer description:

The id of the merchant that authorized the transaction.

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

created : string format: date-time description:

Time stamp of when the transaction occurred

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC maxLength: 16 description:

Payment transaction type

risk_score : number format: double description:

The risk score represents the percentage of probability that the transaction is fraudulent. For example, a score of 10 represents a 10% possibility that the transaction is fraudulent.

amount : number format: double maxLength: 9 description:

A decimal value in dollars. Uses up to two decimal places.

payment_method : string Enum (8) card token payment_profile cash cheque interac apple_pay google_pay description:

Payment method

custom : Custom { ref1 : string maxLength: 256 description:

custom reference field 1

ref2 : string maxLength: 256 description:

custom reference field 2

ref3 : string maxLength: 256 description:

custom reference field 3

ref4 : string maxLength: 256 description:

custom reference field 4

ref5 : string maxLength: 256 description:

custom reference field 5

} card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} 3d_secure : 3DSecureResponse { 3D Secure result data status* : string description:

Status of 3D secure authentication for the transaction. One of: Success, Attempted, Rejected, Failed, Unavailable, or Error

} merchant_data : string maxLength: 32 description:

Returned only for 'interac' or 3D Secure payment requests. This value can be used as the {id} value when creating your 'continue' endpoint URL.

contents : string description:

interac_online : InteracOnlineResponse { Returned only in the final response from the 'continue' endpoint. idebit_issconf : string description:

A numeric confirmation code of the payment

idebit_issname : string description:

Name of the account holder's financial institution

} links : array of Link { ref : string pattern: ^[a-zA-z]{1,16}$ description:

Eg. "void" or "return"

href : string maxLength: 256 description:

Url to perform the void, return, completion etc.

method : string pattern: ^[a-zA-z]{1,16}$ description:

Http method. post, put, get etc.

not_card_on_file - A transaction where the credit card information is not stored on file.
first_installment - The first payment in a series of installment payments. (Eg. Initial installment payment when purchasing a fridge.)
subsequent_installment - A subsequent payment (ie. not the first) in a series of installment payments. (Eg. Next installment payment when purchasing a fridge.)
first_recurring - The first payment in a series of scheduled payments with no expected end date. (Eg. Initial payment for a subscription service.)
subsequent_recurring - A subsequent payment (ie. not the first) in a series of scheduled payments with no expected end date. (Eg. Next payment for a subscription service.)
subsequent_customer_initiated - A recurring transaction that is initiated by the customer. (Eg. Customer reloads a prepaid cash card.)
subsequent_unscheduled - An unscheduled recurring transaction that is initiated by the merchant. (Eg. Merchant auto-reloads a prepaid cash card for the customer when the balance on the card reaches a predetermined threshold.)

series_id : number format: integer description:

The identifier for the set of transactions that this transaction belongs to.

} }

ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description:

Not used. Always returns an empty string.

card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

POST

/payments/{transId}/void

Void transaction

Description

Void a transaction. You can void payments, returns, pre-auths, and completions. It will cancel that transaction.

Parameters

Required	In	Name	Description	Schema
true	path	transId	The transaction id to void.	number
true	body	void		Void

Parameter Schema Definitions
Void { amount* : number format: double description: A decimal value in dollars. Must be equal to the original purchase amount. You can void purchases as well as pre-auths and returns. order_number : string maxLength: 30 description: A unique order number. }

Responses

Code	Description	Schema
200	Payment response containing the payment details as well as if the transaction was approved or declined.	PaymentResponse
400	Bad Request	ErrorResponse
401	Authentication Failure	ErrorResponse
402	Business Rule Violation or Decline	ErrorResponse
403	Authorization Failure	ErrorResponse
405	Invalid Request Method	ErrorResponse
500	Internal Server Error	ErrorResponse

Response Schema Definitions
PaymentResponse { id : string maxLength: 9 description: transaction Id authorizing_merchant_id : integer description: The id of the merchant that authorized the transaction. approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code created : string format: date-time description: Time stamp of when the transaction occurred order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC maxLength: 16 description: Payment transaction type risk_score : number format: double description: The risk score represents the percentage of probability that the transaction is fraudulent. For example, a score of 10 represents a 10% possibility that the transaction is fraudulent. amount : number format: double maxLength: 9 description: A decimal value in dollars. Uses up to two decimal places. payment_method : string Enum (8) card token payment_profile cash cheque interac apple_pay google_pay description: Payment method custom : Custom { ref1 : string maxLength: 256 description: custom reference field 1 ref2 : string maxLength: 256 description: custom reference field 2 ref3 : string maxLength: 256 description: custom reference field 3 ref4 : string maxLength: 256 description: custom reference field 4 ref5 : string maxLength: 256 description: custom reference field 5 } card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } 3d_secure : 3DSecureResponse { 3D Secure result data status* : string description: Status of 3D secure authentication for the transaction. One of: Success, Attempted, Rejected, Failed, Unavailable, or Error } merchant_data : string maxLength: 32 description: Returned only for 'interac' or 3D Secure payment requests. This value can be used as the {id} value when creating your 'continue' endpoint URL. contents : string description: Returned only for 'interac' or 3D Secure payment requests. This should be embedded in the user's browser client and this needs to be displayed to the customer to redirect them to the Interac login or 3D Secure processing page. interac_online : InteracOnlineResponse { Returned only in the final response from the 'continue' endpoint. idebit_issconf : string description: A numeric confirmation code of the payment idebit_issname : string description: Name of the account holder's financial institution } links : array of Link { ref : string pattern: ^[a-zA-z]{1,16}$ description: Eg. "void" or "return" href : string maxLength: 256 description: Url to perform the void, return, completion etc. method : string pattern: ^[a-zA-z]{1,16}$ description: Http method. post, put, get etc. } card_on_file : CardOnFileResponse { type : string Enum (7) not_card_on_file first_installment subsequent_installment first_recurring subsequent_recurring subsequent_customer_initiated subsequent_unscheduled description: not_card_on_file - A transaction where the credit card information is not stored on file. first_installment - The first payment in a series of installment payments. (Eg. Initial installment payment when purchasing a fridge.) subsequent_installment - A subsequent payment (ie. not the first) in a series of installment payments. (Eg. Next installment payment when purchasing a fridge.) first_recurring - The first payment in a series of scheduled payments with no expected end date. (Eg. Initial payment for a subscription service.) subsequent_recurring - A subsequent payment (ie. not the first) in a series of scheduled payments with no expected end date. (Eg. Next payment for a subscription service.) subsequent_customer_initiated - A recurring transaction that is initiated by the customer. (Eg. Customer reloads a prepaid cash card.) subsequent_unscheduled - An unscheduled recurring transaction that is initiated by the merchant. (Eg. Merchant auto-reloads a prepaid cash card for the customer when the balance on the card reaches a predetermined threshold.) series_id : number format: integer description: The identifier for the set of transactions that this transaction belongs to. } }
ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description: Not used. Always returns an empty string. card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }

Response Schema Definitions

PaymentResponse { id : string maxLength: 9 description:

transaction Id

authorizing_merchant_id : integer description:

The id of the merchant that authorized the transaction.

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

created : string format: date-time description:

Time stamp of when the transaction occurred

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC maxLength: 16 description:

Payment transaction type

risk_score : number format: double description:

The risk score represents the percentage of probability that the transaction is fraudulent. For example, a score of 10 represents a 10% possibility that the transaction is fraudulent.

amount : number format: double maxLength: 9 description:

A decimal value in dollars. Uses up to two decimal places.

payment_method : string Enum (8) card token payment_profile cash cheque interac apple_pay google_pay description:

Payment method

custom : Custom { ref1 : string maxLength: 256 description:

custom reference field 1

ref2 : string maxLength: 256 description:

custom reference field 2

ref3 : string maxLength: 256 description:

custom reference field 3

ref4 : string maxLength: 256 description:

custom reference field 4

ref5 : string maxLength: 256 description:

custom reference field 5

} card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} 3d_secure : 3DSecureResponse { 3D Secure result data status* : string description:

Status of 3D secure authentication for the transaction. One of: Success, Attempted, Rejected, Failed, Unavailable, or Error

} merchant_data : string maxLength: 32 description:

Returned only for 'interac' or 3D Secure payment requests. This value can be used as the {id} value when creating your 'continue' endpoint URL.

contents : string description:

interac_online : InteracOnlineResponse { Returned only in the final response from the 'continue' endpoint. idebit_issconf : string description:

A numeric confirmation code of the payment

idebit_issname : string description:

Name of the account holder's financial institution

} links : array of Link { ref : string pattern: ^[a-zA-z]{1,16}$ description:

Eg. "void" or "return"

href : string maxLength: 256 description:

Url to perform the void, return, completion etc.

method : string pattern: ^[a-zA-z]{1,16}$ description:

Http method. post, put, get etc.

not_card_on_file - A transaction where the credit card information is not stored on file.
first_installment - The first payment in a series of installment payments. (Eg. Initial installment payment when purchasing a fridge.)
subsequent_installment - A subsequent payment (ie. not the first) in a series of installment payments. (Eg. Next installment payment when purchasing a fridge.)
first_recurring - The first payment in a series of scheduled payments with no expected end date. (Eg. Initial payment for a subscription service.)
subsequent_recurring - A subsequent payment (ie. not the first) in a series of scheduled payments with no expected end date. (Eg. Next payment for a subscription service.)
subsequent_customer_initiated - A recurring transaction that is initiated by the customer. (Eg. Customer reloads a prepaid cash card.)
subsequent_unscheduled - An unscheduled recurring transaction that is initiated by the merchant. (Eg. Merchant auto-reloads a prepaid cash card for the customer when the balance on the card reaches a predetermined threshold.)

series_id : number format: integer description:

The identifier for the set of transactions that this transaction belongs to.

} }

ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description:

Not used. Always returns an empty string.

card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

POST

/payments/{transId}/completions

Complete pre-auth

Description

Complete a pre-authorized payment. The amount of the transaction to complete must be less than or equal to the original pre-auth amount. Complete must be set to true.

Parameters

Required	In	Name	Description	Schema
true	path	transId	The transaction id.	number
	body	payment_request		PaymentRequest

Parameter Schema Definitions
PaymentRequest { order_number : string maxLength: 30 description: A unique order number. amount* : number format: double description: A decimal value in dollars. Uses up to two decimal places. Max value is account specific. Default max value is 1000. payment_method* : string Enum (10) card token payment_profile cash cheque interac apple_pay google_pay 3d_secure_token processor_token description: The desired method of payment. language : string maxLength: 3 description: characters customer_ip : string maxLength: 30 description: IP Address of the api consumer. Required if calculating risk score. term_url : string maxLength: 256 description: Callback URL used with 3D Secure payment processing. comments : string maxLength: 256 description: alphanumeric billing : RequestBillingAddress { name : string maxLength: 64 description: Name of the person/business address_line1 : string maxLength: 64 description: Street address. Impacts risk score. address_line2 : string maxLength: 64 description: Additional address information(eg; suite number, apartment number, etc) city : string maxLength: 32 description: The city. Impacts risk score. province : string description: 2 characters. Set to -- for any countries except for US and Canada. Impacts risk score. country : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW maxLength: 2 description: Valid ISO 3166-1 country code. Impacts risk score. postal_code : string maxLength: 16 description: Postal/Zip code. Impacts risk score. phone_number : string pattern: ^\d{1,20}$ description: Phone number email_address : string maxLength: 64 description: Email Address. Impacts risk score. } shipping : Address { name : string maxLength: 64 description: Name of the person/business address_line1 : string maxLength: 64 description: Street address address_line2 : string maxLength: 64 description: Additional address information(eg; suite number, apartment number, etc) city : string maxLength: 32 description: The city province : string description: characters (2) country : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW maxLength: 2 description: Valid ISO 3166-1 country code postal_code : string maxLength: 16 description: Postal/Zip code phone_number : string pattern: ^\d{1,20}$ description: Phone number email_address : string maxLength: 64 description: Email Address } custom : Custom { ref1 : string maxLength: 256 description: custom reference field 1 ref2 : string maxLength: 256 description: custom reference field 2 ref3 : string maxLength: 256 description: custom reference field 3 ref4 : string maxLength: 256 description: custom reference field 4 ref5 : string maxLength: 256 description: custom reference field 5 } card : Card { Payment with a credit card. The payment_method must be 'card' number* : string default: 5100000010001004 maxLength: 20 description: Credit card number (PAN). name* : string minLength: 1 maxLength: 64 description: Card holder name. expiry_month* : string default: 02 maxLength: 2 description: eg. 02 for February. expiry_year* : string default: 18 maxLength: 2 description: eg. 15 for 2015. cvd : string default: 123 minLength: 3 maxLength: 4 description: Security code on the back of the credit card. This can be set to mandatory in the back office. 3d_secure : 3DSecure { Payment with 3D Secure (Verified by Visa, Mastercard SecureCode, American Express SafeKey). Note that 3D Secure must be enabled on the merchant account in order to process transactions with 3D Secure. browser : BrowserData { Data collected about the cardholders browser, required for 3DS 2.0 transactions, optional for others. accept_header* : string maxLength: 2048 description: HTTP Accept Header returned by the browser. java_enabled* : boolean description: True if the browser supports Java. language* : string maxLength: 8 description: Language currently set in the browser. color_depth : integer description: Color bit-depth of the screen. screen_height* : integer description: Height, in pixels, of the screen. screen_width* : integer description: Width, in pixels, of the screen. time_zone* : integer description: Timezone returned by the browser. user_agent* : string maxLength: 2048 description: User-Agent header returned by the browser in the client HTTP request. javascript_enabled* : boolean default: true description: True if the browser has JavaScript enabled. } enabled* : boolean default: true description: If 3D Secure is enabled on the merchant account, set to false to process transactions without 3D Secure. Otherwise, set to true to process transactions with 3D Secure. version : integer description: Version of 3DS to perform (1 or 2). Optional and will default to what is configured in the merchants account. auth_required : boolean description: If set to true the transaction will not continue processing unless 3DS authentication is successful. xid : string description: The transaction ID (XID) used for processing transactions with 3D Secure. cavv : string description: The cardholder authentication verification value (CAVV/UCAF/AEVV) used for processing transactions with 3D Secure. eci : integer description: The electronic commerce indicator (ECI) used for processing transactions with 3D Secure. } visa_checkout_call_id : string maxLength: 20 description: The Visa Checkout payment request ID. complete : boolean default: true description: set to false for Pre-Authorize, and true to complete a payment is_accord_d : boolean description: required flag for desjardin visa cards that want to make Accord D financing transactions. Accord D transactions require billing information as well accord_d : AccordD { Desjardin Visa Only - required for a complete Accord D financing transaction financing_type* : string Enum (2) D E default: E maxLength: 1 description: Deferred(D) or Equal(E) payment plan_number* : string maxLength: 3 description: Must be a value between 000 - ZZZ grace_period* : integer default: 0 description: Must be 0 if financing_type is not a deferred payment term* : integer description: Number of months. Must be 00 is financing_type is not a deferred payment } } apple_pay : ApplePay { Apple Pay Only - required when attempting to process apple_pay transactions. Note that the 'card' object returned in a successful response will have a 'last_four' property value that is based on the source Apple Pay Wallet and its Device Account Number. apple_pay_merchant_id* : string description: The Apple Pay merchant ID. payment_token* : string description: The encrypted token provided by Apple Pay that you then Base64 encode. complete : boolean default: true description: set to false for Pre-Authorize, and true to complete a payment } google_pay : GooglePay { Google Pay Only - required when attempting to process google_pay transactions. name : string description: The cardholder name. 3d_secure : 3DSecure { Payment with 3D Secure (Verified by Visa, Mastercard SecureCode, American Express SafeKey). Note that 3D Secure must be enabled on the merchant account in order to process transactions with 3D Secure. browser : BrowserData { Data collected about the cardholders browser, required for 3DS 2.0 transactions, optional for others. accept_header* : string maxLength: 2048 description: HTTP Accept Header returned by the browser. java_enabled* : boolean description: True if the browser supports Java. language* : string maxLength: 8 description: Language currently set in the browser. color_depth : integer description: Color bit-depth of the screen. screen_height* : integer description: Height, in pixels, of the screen. screen_width* : integer description: Width, in pixels, of the screen. time_zone* : integer description: Timezone returned by the browser. user_agent* : string maxLength: 2048 description: User-Agent header returned by the browser in the client HTTP request. javascript_enabled* : boolean default: true description: True if the browser has JavaScript enabled. } enabled* : boolean default: true description: If 3D Secure is enabled on the merchant account, set to false to process transactions without 3D Secure. Otherwise, set to true to process transactions with 3D Secure. version : integer description: Version of 3DS to perform (1 or 2). Optional and will default to what is configured in the merchants account. auth_required : boolean description: If set to true the transaction will not continue processing unless 3DS authentication is successful. xid : string description: The transaction ID (XID) used for processing transactions with 3D Secure. cavv : string description: The cardholder authentication verification value (CAVV/UCAF/AEVV) used for processing transactions with 3D Secure. eci : integer description: The electronic commerce indicator (ECI) used for processing transactions with 3D Secure. } transaction_payload* : string description: Payload that contains the encrypted Google payment token (required to complete a transaction), along with other security information. complete : boolean default: true description: set to false for Pre-Authorize, and true to complete a payment } payment_profile : ProfilePurchase { Payment with a Payment Profile. The payment_method must be 'payment_profile' complete : boolean default: true description: Set to false for Pre-Authorize, and true to complete a payment customer_code* : string maxLength: 32 description: The payment profile ID. card_id* : integer maxLength: 1 description: Which credit card to use. Starts at 1 for the first card. You must configure how many cards can be stored by visiting the profile options in the back office. } token : TokenPurchase { Payment with a single-use token. The payment_method must be 'token' complete : boolean description: Set to false for Pre-Authorize, and true to complete a payment code* : string maxLength: 40 description: the payment token you retrieved from the service. name* : string minLength: 4 maxLength: 64 description: Card holder name. 3d_secure : 3DSecure { Payment with 3D Secure (Verified by Visa, Mastercard SecureCode, American Express SafeKey). Note that 3D Secure must be enabled on the merchant account in order to process transactions with 3D Secure. browser : BrowserData { Data collected about the cardholders browser, required for 3DS 2.0 transactions, optional for others. accept_header* : string maxLength: 2048 description: HTTP Accept Header returned by the browser. java_enabled* : boolean description: True if the browser supports Java. language* : string maxLength: 8 description: Language currently set in the browser. color_depth : integer description: Color bit-depth of the screen. screen_height* : integer description: Height, in pixels, of the screen. screen_width* : integer description: Width, in pixels, of the screen. time_zone* : integer description: Timezone returned by the browser. user_agent* : string maxLength: 2048 description: User-Agent header returned by the browser in the client HTTP request. javascript_enabled* : boolean default: true description: True if the browser has JavaScript enabled. } enabled* : boolean default: true description: If 3D Secure is enabled on the merchant account, set to false to process transactions without 3D Secure. Otherwise, set to true to process transactions with 3D Secure. version : integer description: Version of 3DS to perform (1 or 2). Optional and will default to what is configured in the merchants account. auth_required : boolean description: If set to true the transaction will not continue processing unless 3DS authentication is successful. xid : string description: The transaction ID (XID) used for processing transactions with 3D Secure. cavv : string description: The cardholder authentication verification value (CAVV/UCAF/AEVV) used for processing transactions with 3D Secure. eci : integer description: The electronic commerce indicator (ECI) used for processing transactions with 3D Secure. } visa_checkout_call_id : string maxLength: 20 description: The Visa Checkout payment request ID. } 3d_secure : 3d_secure_token { Payment with a 3D Secure Session Data token. Reference a previously processed 3D Secure transaction processed through the 3D Secure 2.0 API. This will apply the associated card number, card expiry, and 3D Secure results to your payment request. The payment_method must be '3d_secure' complete : boolean description: Set to false for Pre-Authorize, and true to complete a payment threeDS_session_data* : string minLength: 1 maxLength: 128 description: auth_required : boolean description: If set to true the transaction will not continue processing unless 3DS authentication is successful. } recurring_payment : boolean description: A recurring transaction is a transaction where a cardholder had provided permission to a merchant to periodically charge his/her account number for recurring goods or services. The recurring payment indicator may be set for credit card based pre-auth, capture and purchase transactions. level2 : Level2 { Level 2 processing is for B2B customers. Additional information can be provided, to the benefit of corporate/government/industrial customers, that includes a customer code & tax amounts. customer_code* : string maxLength: 17 description: Visa - Used by merchant to identify the purchase (i.e. SKU number). Master Card - Code the cardholder supplied to the merchant. American Express - Customer reference number. order_tax1_price* : number format: double maxLength: 12 description: Visa - Amount of state or provincial tax included in the transaction amount - Must between 0.1% and 22% of the transaction amount. Master Card - Sales tax/VAT on the total purchase - Must be between 0.1% and 30% of the transaction amount. American Express - Transaction tax amount (calculated or entered). order_tax2_price* : number format: double maxLength: 12 description: Visa - Amount of state or provincial tax included in the transaction amount - Must between 0.1% and 22% of the transaction amount. Master Card - Sales tax/VAT on the total purchase - Must be between 0.1% and 30% of the transaction amount. American Express - Transaction tax amount (calculated or entered). } card_on_file : CardOnFile { When processing a transaction where the credit card information is stored on file, you must pass along an indicator showing the type of credential-on-file transaction that is being processed. type* : string Enum (7) not_card_on_file first_installment subsequent_installment first_recurring subsequent_recurring subsequent_customer_initiated subsequent_unscheduled description: not_card_on_file - A transaction where the credit card information is not stored on file. first_installment - The first payment in a series of installment payments. (Eg. Initial installment payment when purchasing a fridge.) subsequent_installment - A subsequent payment (ie. not the first) in a series of installment payments. (Eg. Next installment payment when purchasing a fridge.) first_recurring - The first payment in a series of scheduled payments with no expected end date. (Eg. Initial payment for a subscription service.) subsequent_recurring - A subsequent payment (ie. not the first) in a series of scheduled payments with no expected end date. (Eg. Next payment for a subscription service.) subsequent_customer_initiated - A recurring transaction that is initiated by the customer. (Eg. Customer reloads a prepaid cash card.) subsequent_unscheduled - An unscheduled recurring transaction that is initiated by the merchant. (Eg. Merchant auto-reloads a prepaid cash card for the customer when the balance on the card reaches a predetermined threshold.) series_id : number format: integer description: The identifier for the set of transactions that this transaction belongs to. This field is required for "subsequent_installment", "subsequent_recurring", and "subsequent_unscheduled" credential-on-file transaction types. } processor_token : ProcessorTokenRequest { Payment with Processor Token. The payment_method must be 'processor_token'. payment_token* : string minLength: 15 maxLength: 19 description: The payment token you retrieved from the service. expiry_month* : string maxLength: 2 description: eg. 02 for February. expiry_year* : string maxLength: 2 description: eg. 15 for 2015. } }

Parameter Schema Definitions

PaymentRequest { order_number : string maxLength: 30 description:

A unique order number.

amount* : number format: double description:

A decimal value in dollars. Uses up to two decimal places. Max value is account specific. Default max value is 1000.

payment_method* : string Enum (10) card token payment_profile cash cheque interac apple_pay google_pay 3d_secure_token processor_token description:

The desired method of payment.

language : string maxLength: 3 description:

characters

customer_ip : string maxLength: 30 description:

IP Address of the api consumer. Required if calculating risk score.

term_url : string maxLength: 256 description:

Callback URL used with 3D Secure payment processing.

comments : string maxLength: 256 description:

alphanumeric

billing : RequestBillingAddress { name : string maxLength: 64 description:

Name of the person/business

address_line1 : string maxLength: 64 description:

Street address. Impacts risk score.

address_line2 : string maxLength: 64 description:

Additional address information(eg; suite number, apartment number, etc)

city : string maxLength: 32 description:

The city. Impacts risk score.

province : string description:

2 characters. Set to -- for any countries except for US and Canada. Impacts risk score.

Valid ISO 3166-1 country code. Impacts risk score.

postal_code : string maxLength: 16 description:

Postal/Zip code. Impacts risk score.

phone_number : string pattern: ^\d{1,20}$ description:

Phone number

email_address : string maxLength: 64 description:

Email Address. Impacts risk score.

} shipping : Address { name : string maxLength: 64 description:

Name of the person/business

address_line1 : string maxLength: 64 description:

Street address

address_line2 : string maxLength: 64 description:

Additional address information(eg; suite number, apartment number, etc)

city : string maxLength: 32 description:

The city

province : string description:

characters (2)

Valid ISO 3166-1 country code

postal_code : string maxLength: 16 description:

Postal/Zip code

phone_number : string pattern: ^\d{1,20}$ description:

Phone number

email_address : string maxLength: 64 description:

Email Address

} custom : Custom { ref1 : string maxLength: 256 description:

custom reference field 1

ref2 : string maxLength: 256 description:

custom reference field 2

ref3 : string maxLength: 256 description:

custom reference field 3

ref4 : string maxLength: 256 description:

custom reference field 4

ref5 : string maxLength: 256 description:

custom reference field 5

} card : Card { Payment with a credit card. The payment_method must be 'card' number* : string default: 5100000010001004 maxLength: 20 description:

Credit card number (PAN).

name* : string minLength: 1 maxLength: 64 description:

Card holder name.

expiry_month* : string default: 02 maxLength: 2 description:

eg. 02 for February.

expiry_year* : string default: 18 maxLength: 2 description:

eg. 15 for 2015.

cvd : string default: 123 minLength: 3 maxLength: 4 description:

Security code on the back of the credit card. This can be set to mandatory in the back office.

HTTP Accept Header returned by the browser.

java_enabled* : boolean description:

True if the browser supports Java.

language* : string maxLength: 8 description:

Language currently set in the browser.

color_depth : integer description:

Color bit-depth of the screen.

screen_height* : integer description:

Height, in pixels, of the screen.

screen_width* : integer description:

Width, in pixels, of the screen.

time_zone* : integer description:

Timezone returned by the browser.

user_agent* : string maxLength: 2048 description:

User-Agent header returned by the browser in the client HTTP request.

javascript_enabled* : boolean default: true description:

True if the browser has JavaScript enabled.

} enabled* : boolean default: true description:

If 3D Secure is enabled on the merchant account, set to false to process transactions without 3D Secure. Otherwise, set to true to process transactions with 3D Secure.

version : integer description:

Version of 3DS to perform (1 or 2). Optional and will default to what is configured in the merchants account.

auth_required : boolean description:

If set to true the transaction will not continue processing unless 3DS authentication is successful.

xid : string description:

The transaction ID (XID) used for processing transactions with 3D Secure.

cavv : string description:

The cardholder authentication verification value (CAVV/UCAF/AEVV) used for processing transactions with 3D Secure.

eci : integer description:

The electronic commerce indicator (ECI) used for processing transactions with 3D Secure.

} visa_checkout_call_id : string maxLength: 20 description:

The Visa Checkout payment request ID.

complete : boolean default: true description:

set to false for Pre-Authorize, and true to complete a payment

is_accord_d : boolean description:

required flag for desjardin visa cards that want to make Accord D financing transactions. Accord D transactions require billing information as well

accord_d : AccordD { Desjardin Visa Only - required for a complete Accord D financing transaction financing_type* : string Enum (2) D E default: E maxLength: 1 description:

Deferred(D) or Equal(E) payment

plan_number* : string maxLength: 3 description:

Must be a value between 000 - ZZZ

grace_period* : integer default: 0 description:

Must be 0 if financing_type is not a deferred payment

term* : integer description:

Number of months. Must be 00 is financing_type is not a deferred payment

The Apple Pay merchant ID.

payment_token* : string description:

The encrypted token provided by Apple Pay that you then Base64 encode.

complete : boolean default: true description:

set to false for Pre-Authorize, and true to complete a payment

} google_pay : GooglePay { Google Pay Only - required when attempting to process google_pay transactions. name : string description:

The cardholder name.

HTTP Accept Header returned by the browser.

java_enabled* : boolean description:

True if the browser supports Java.

language* : string maxLength: 8 description:

Language currently set in the browser.

color_depth : integer description:

Color bit-depth of the screen.

screen_height* : integer description:

Height, in pixels, of the screen.

screen_width* : integer description:

Width, in pixels, of the screen.

time_zone* : integer description:

Timezone returned by the browser.

user_agent* : string maxLength: 2048 description:

User-Agent header returned by the browser in the client HTTP request.

javascript_enabled* : boolean default: true description:

True if the browser has JavaScript enabled.

} enabled* : boolean default: true description:

If 3D Secure is enabled on the merchant account, set to false to process transactions without 3D Secure. Otherwise, set to true to process transactions with 3D Secure.

version : integer description:

Version of 3DS to perform (1 or 2). Optional and will default to what is configured in the merchants account.

auth_required : boolean description:

If set to true the transaction will not continue processing unless 3DS authentication is successful.

xid : string description:

The transaction ID (XID) used for processing transactions with 3D Secure.

cavv : string description:

The cardholder authentication verification value (CAVV/UCAF/AEVV) used for processing transactions with 3D Secure.

eci : integer description:

The electronic commerce indicator (ECI) used for processing transactions with 3D Secure.

} transaction_payload* : string description:

Payload that contains the encrypted Google payment token (required to complete a transaction), along with other security information.

complete : boolean default: true description:

set to false for Pre-Authorize, and true to complete a payment

} payment_profile : ProfilePurchase { Payment with a Payment Profile. The payment_method must be 'payment_profile' complete : boolean default: true description:

Set to false for Pre-Authorize, and true to complete a payment

customer_code* : string maxLength: 32 description:

The payment profile ID.

card_id* : integer maxLength: 1 description:

Which credit card to use. Starts at 1 for the first card. You must configure how many cards can be stored by visiting the profile options in the back office.

} token : TokenPurchase { Payment with a single-use token. The payment_method must be 'token' complete : boolean description:

Set to false for Pre-Authorize, and true to complete a payment

code* : string maxLength: 40 description:

the payment token you retrieved from the service.

name* : string minLength: 4 maxLength: 64 description:

Card holder name.

HTTP Accept Header returned by the browser.

java_enabled* : boolean description:

True if the browser supports Java.

language* : string maxLength: 8 description:

Language currently set in the browser.

color_depth : integer description:

Color bit-depth of the screen.

screen_height* : integer description:

Height, in pixels, of the screen.

screen_width* : integer description:

Width, in pixels, of the screen.

time_zone* : integer description:

Timezone returned by the browser.

user_agent* : string maxLength: 2048 description:

User-Agent header returned by the browser in the client HTTP request.

javascript_enabled* : boolean default: true description:

True if the browser has JavaScript enabled.

} enabled* : boolean default: true description:

If 3D Secure is enabled on the merchant account, set to false to process transactions without 3D Secure. Otherwise, set to true to process transactions with 3D Secure.

version : integer description:

Version of 3DS to perform (1 or 2). Optional and will default to what is configured in the merchants account.

auth_required : boolean description:

If set to true the transaction will not continue processing unless 3DS authentication is successful.

xid : string description:

The transaction ID (XID) used for processing transactions with 3D Secure.

cavv : string description:

The cardholder authentication verification value (CAVV/UCAF/AEVV) used for processing transactions with 3D Secure.

eci : integer description:

The electronic commerce indicator (ECI) used for processing transactions with 3D Secure.

} visa_checkout_call_id : string maxLength: 20 description:

The Visa Checkout payment request ID.

Set to false for Pre-Authorize, and true to complete a payment

threeDS_session_data* : string minLength: 1 maxLength: 128 description: auth_required : boolean description:

If set to true the transaction will not continue processing unless 3DS authentication is successful.

} recurring_payment : boolean description:

Visa - Used by merchant to identify the purchase (i.e. SKU number).
Master Card - Code the cardholder supplied to the merchant.
American Express - Customer reference number.

order_tax1_price* : number format: double maxLength: 12 description:

Visa - Amount of state or provincial tax included in the transaction amount - Must between 0.1% and 22% of the transaction amount.
Master Card - Sales tax/VAT on the total purchase - Must be between 0.1% and 30% of the transaction amount.
American Express - Transaction tax amount (calculated or entered).

order_tax2_price* : number format: double maxLength: 12 description:

Visa - Amount of state or provincial tax included in the transaction amount - Must between 0.1% and 22% of the transaction amount.
Master Card - Sales tax/VAT on the total purchase - Must be between 0.1% and 30% of the transaction amount.
American Express - Transaction tax amount (calculated or entered).

not_card_on_file - A transaction where the credit card information is not stored on file.
first_installment - The first payment in a series of installment payments. (Eg. Initial installment payment when purchasing a fridge.)
subsequent_installment - A subsequent payment (ie. not the first) in a series of installment payments. (Eg. Next installment payment when purchasing a fridge.)
first_recurring - The first payment in a series of scheduled payments with no expected end date. (Eg. Initial payment for a subscription service.)
subsequent_recurring - A subsequent payment (ie. not the first) in a series of scheduled payments with no expected end date. (Eg. Next payment for a subscription service.)
subsequent_customer_initiated - A recurring transaction that is initiated by the customer. (Eg. Customer reloads a prepaid cash card.)
subsequent_unscheduled - An unscheduled recurring transaction that is initiated by the merchant. (Eg. Merchant auto-reloads a prepaid cash card for the customer when the balance on the card reaches a predetermined threshold.)

series_id : number format: integer description:

} processor_token : ProcessorTokenRequest { Payment with Processor Token. The payment_method must be 'processor_token'. payment_token* : string minLength: 15 maxLength: 19 description:

The payment token you retrieved from the service.

expiry_month* : string maxLength: 2 description:

eg. 02 for February.

expiry_year* : string maxLength: 2 description:

eg. 15 for 2015.

} }

Responses

Code	Description	Schema
200	Payment response containing the payment details as well as if the transaction was approved or declined.	PaymentResponse
400	Bad Request	ErrorResponse
401	Authentication Failure	ErrorResponse
402	Business Rule Violation or Decline	ErrorResponse
403	Authorization Failure	ErrorResponse
405	Invalid Request Method	ErrorResponse
500	Internal Server Error	ErrorResponse

Response Schema Definitions
PaymentResponse { id : string maxLength: 9 description: transaction Id authorizing_merchant_id : integer description: The id of the merchant that authorized the transaction. approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code created : string format: date-time description: Time stamp of when the transaction occurred order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC maxLength: 16 description: Payment transaction type risk_score : number format: double description: The risk score represents the percentage of probability that the transaction is fraudulent. For example, a score of 10 represents a 10% possibility that the transaction is fraudulent. amount : number format: double maxLength: 9 description: A decimal value in dollars. Uses up to two decimal places. payment_method : string Enum (8) card token payment_profile cash cheque interac apple_pay google_pay description: Payment method custom : Custom { ref1 : string maxLength: 256 description: custom reference field 1 ref2 : string maxLength: 256 description: custom reference field 2 ref3 : string maxLength: 256 description: custom reference field 3 ref4 : string maxLength: 256 description: custom reference field 4 ref5 : string maxLength: 256 description: custom reference field 5 } card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } 3d_secure : 3DSecureResponse { 3D Secure result data status* : string description: Status of 3D secure authentication for the transaction. One of: Success, Attempted, Rejected, Failed, Unavailable, or Error } merchant_data : string maxLength: 32 description: Returned only for 'interac' or 3D Secure payment requests. This value can be used as the {id} value when creating your 'continue' endpoint URL. contents : string description: Returned only for 'interac' or 3D Secure payment requests. This should be embedded in the user's browser client and this needs to be displayed to the customer to redirect them to the Interac login or 3D Secure processing page. interac_online : InteracOnlineResponse { Returned only in the final response from the 'continue' endpoint. idebit_issconf : string description: A numeric confirmation code of the payment idebit_issname : string description: Name of the account holder's financial institution } links : array of Link { ref : string pattern: ^[a-zA-z]{1,16}$ description: Eg. "void" or "return" href : string maxLength: 256 description: Url to perform the void, return, completion etc. method : string pattern: ^[a-zA-z]{1,16}$ description: Http method. post, put, get etc. } card_on_file : CardOnFileResponse { type : string Enum (7) not_card_on_file first_installment subsequent_installment first_recurring subsequent_recurring subsequent_customer_initiated subsequent_unscheduled description: not_card_on_file - A transaction where the credit card information is not stored on file. first_installment - The first payment in a series of installment payments. (Eg. Initial installment payment when purchasing a fridge.) subsequent_installment - A subsequent payment (ie. not the first) in a series of installment payments. (Eg. Next installment payment when purchasing a fridge.) first_recurring - The first payment in a series of scheduled payments with no expected end date. (Eg. Initial payment for a subscription service.) subsequent_recurring - A subsequent payment (ie. not the first) in a series of scheduled payments with no expected end date. (Eg. Next payment for a subscription service.) subsequent_customer_initiated - A recurring transaction that is initiated by the customer. (Eg. Customer reloads a prepaid cash card.) subsequent_unscheduled - An unscheduled recurring transaction that is initiated by the merchant. (Eg. Merchant auto-reloads a prepaid cash card for the customer when the balance on the card reaches a predetermined threshold.) series_id : number format: integer description: The identifier for the set of transactions that this transaction belongs to. } }
ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description: Not used. Always returns an empty string. card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }

Response Schema Definitions

PaymentResponse { id : string maxLength: 9 description:

transaction Id

authorizing_merchant_id : integer description:

The id of the merchant that authorized the transaction.

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

created : string format: date-time description:

Time stamp of when the transaction occurred

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC maxLength: 16 description:

Payment transaction type

risk_score : number format: double description:

The risk score represents the percentage of probability that the transaction is fraudulent. For example, a score of 10 represents a 10% possibility that the transaction is fraudulent.

amount : number format: double maxLength: 9 description:

A decimal value in dollars. Uses up to two decimal places.

payment_method : string Enum (8) card token payment_profile cash cheque interac apple_pay google_pay description:

Payment method

custom : Custom { ref1 : string maxLength: 256 description:

custom reference field 1

ref2 : string maxLength: 256 description:

custom reference field 2

ref3 : string maxLength: 256 description:

custom reference field 3

ref4 : string maxLength: 256 description:

custom reference field 4

ref5 : string maxLength: 256 description:

custom reference field 5

} card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} 3d_secure : 3DSecureResponse { 3D Secure result data status* : string description:

Status of 3D secure authentication for the transaction. One of: Success, Attempted, Rejected, Failed, Unavailable, or Error

} merchant_data : string maxLength: 32 description:

Returned only for 'interac' or 3D Secure payment requests. This value can be used as the {id} value when creating your 'continue' endpoint URL.

contents : string description:

interac_online : InteracOnlineResponse { Returned only in the final response from the 'continue' endpoint. idebit_issconf : string description:

A numeric confirmation code of the payment

idebit_issname : string description:

Name of the account holder's financial institution

} links : array of Link { ref : string pattern: ^[a-zA-z]{1,16}$ description:

Eg. "void" or "return"

href : string maxLength: 256 description:

Url to perform the void, return, completion etc.

method : string pattern: ^[a-zA-z]{1,16}$ description:

Http method. post, put, get etc.

not_card_on_file - A transaction where the credit card information is not stored on file.
first_installment - The first payment in a series of installment payments. (Eg. Initial installment payment when purchasing a fridge.)
subsequent_installment - A subsequent payment (ie. not the first) in a series of installment payments. (Eg. Next installment payment when purchasing a fridge.)
first_recurring - The first payment in a series of scheduled payments with no expected end date. (Eg. Initial payment for a subscription service.)
subsequent_recurring - A subsequent payment (ie. not the first) in a series of scheduled payments with no expected end date. (Eg. Next payment for a subscription service.)
subsequent_customer_initiated - A recurring transaction that is initiated by the customer. (Eg. Customer reloads a prepaid cash card.)
subsequent_unscheduled - An unscheduled recurring transaction that is initiated by the merchant. (Eg. Merchant auto-reloads a prepaid cash card for the customer when the balance on the card reaches a predetermined threshold.)

series_id : number format: integer description:

The identifier for the set of transactions that this transaction belongs to.

} }

ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description:

Not used. Always returns an empty string.

card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

GET

/payments/{transId}

Get payment

Description

Get a previous payment (transaction).

Parameters

Required	In	Name	Description	Schema
true	path	transId	The transaction id.	number

Responses

Code	Description	Schema
200	A transaction object.	Transaction
400	Bad Request	ErrorResponse
401	Authentication Failure	ErrorResponse
402	Business Rule Violation or Decline	ErrorResponse
403	Authorization Failure	ErrorResponse
405	Invalid Request Method	ErrorResponse
500	Internal Server Error	ErrorResponse

Response Schema Definitions
Transaction { id : number format: integer authorizing_merchant_id : integer description: The id of the merchant that authorized the transaction. approved : boolean message_id : number format: integer message : string auth_code : string created : string format: date-time description: Time stamp of when the transaction occurred amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. order_number : string type : string comments : string batch_number : string total_refunds : number format: double total_completions : number format: double payment_method : string card : CardGetTransactionResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: The last 4 digits of the credit card used in the transaction cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match. avs_result : integer description: Result of street address and Postal/Zip match/mismatch. 0 in case of mismatch. 1 in case of match. expiry_month : string maxLength: 2 description: a 2 digit representation of the expiry month. For example March is 03. expiry_year : string maxLength: 2 description: a 2 digit representation of the expiry year. For example 2016 is 16. cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } } billing : Address { name : string maxLength: 64 description: Name of the person/business address_line1 : string maxLength: 64 description: Street address address_line2 : string maxLength: 64 description: Additional address information(eg; suite number, apartment number, etc) city : string maxLength: 32 description: The city province : string description: characters (2) country : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW maxLength: 2 description: Valid ISO 3166-1 country code postal_code : string maxLength: 16 description: Postal/Zip code phone_number : string pattern: ^\d{1,20}$ description: Phone number email_address : string maxLength: 64 description: Email Address } shipping : Address { name : string maxLength: 64 description: Name of the person/business address_line1 : string maxLength: 64 description: Street address address_line2 : string maxLength: 64 description: Additional address information(eg; suite number, apartment number, etc) city : string maxLength: 32 description: The city province : string description: characters (2) country : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW maxLength: 2 description: Valid ISO 3166-1 country code postal_code : string maxLength: 16 description: Postal/Zip code phone_number : string pattern: ^\d{1,20}$ description: Phone number email_address : string maxLength: 64 description: Email Address } custom : Custom { ref1 : string maxLength: 256 description: custom reference field 1 ref2 : string maxLength: 256 description: custom reference field 2 ref3 : string maxLength: 256 description: custom reference field 3 ref4 : string maxLength: 256 description: custom reference field 4 ref5 : string maxLength: 256 description: custom reference field 5 } adjusted_by : array of Adjustment { id : number format: integer type : string approval : number format: integer message : string amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. created : string description: The date it was created '2015-04-22T10:03:19.323-07:00' url : string } links : array of Link { ref : string pattern: ^[a-zA-z]{1,16}$ description: Eg. "void" or "return" href : string maxLength: 256 description: Url to perform the void, return, completion etc. method : string pattern: ^[a-zA-z]{1,16}$ description: Http method. post, put, get etc. } }
ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description: Not used. Always returns an empty string. card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }

Response Schema Definitions

Transaction { id : number format: integer authorizing_merchant_id : integer description:

The id of the merchant that authorized the transaction.

approved : boolean message_id : number format: integer message : string auth_code : string created : string format: date-time description:

Time stamp of when the transaction occurred

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

order_number : string type : string comments : string batch_number : string total_refunds : number format: double total_completions : number format: double payment_method : string card : CardGetTransactionResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

The last 4 digits of the credit card used in the transaction

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match.

avs_result : integer description:

Result of street address and Postal/Zip match/mismatch. 0 in case of mismatch. 1 in case of match.

expiry_month : string maxLength: 2 description:

a 2 digit representation of the expiry month. For example March is 03.

expiry_year : string maxLength: 2 description:

a 2 digit representation of the expiry year. For example 2016 is 16.

cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } } billing : Address { name : string maxLength: 64 description:

Name of the person/business

address_line1 : string maxLength: 64 description:

Street address

address_line2 : string maxLength: 64 description:

Additional address information(eg; suite number, apartment number, etc)

city : string maxLength: 32 description:

The city

province : string description:

characters (2)

Valid ISO 3166-1 country code

postal_code : string maxLength: 16 description:

Postal/Zip code

phone_number : string pattern: ^\d{1,20}$ description:

Phone number

email_address : string maxLength: 64 description:

Email Address

} shipping : Address { name : string maxLength: 64 description:

Name of the person/business

address_line1 : string maxLength: 64 description:

Street address

address_line2 : string maxLength: 64 description:

Additional address information(eg; suite number, apartment number, etc)

city : string maxLength: 32 description:

The city

province : string description:

characters (2)

Valid ISO 3166-1 country code

postal_code : string maxLength: 16 description:

Postal/Zip code

phone_number : string pattern: ^\d{1,20}$ description:

Phone number

email_address : string maxLength: 64 description:

Email Address

} custom : Custom { ref1 : string maxLength: 256 description:

custom reference field 1

ref2 : string maxLength: 256 description:

custom reference field 2

ref3 : string maxLength: 256 description:

custom reference field 3

ref4 : string maxLength: 256 description:

custom reference field 4

ref5 : string maxLength: 256 description:

custom reference field 5

} adjusted_by : array of Adjustment { id : number format: integer type : string approval : number format: integer message : string amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

created : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

url : string } links : array of Link { ref : string pattern: ^[a-zA-z]{1,16}$ description:

Eg. "void" or "return"

href : string maxLength: 256 description:

Url to perform the void, return, completion etc.

method : string pattern: ^[a-zA-z]{1,16}$ description:

Http method. post, put, get etc.

} }

ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description:

Not used. Always returns an empty string.

card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

POST

/payments/{merchant_data}/continue

3D Secure or Interac Online payments

Description

Continues 3D Secure or Interac Online payment processing.

Parameters

Required	In	Name	Description	Schema
true	path	merchant_data	The merchant_data attribute value returned from the initiating Payments API request. The value represents a unique payment ID.	string
true	body	continue_request		ContinueRequest

Parameter Schema Definitions
ContinueRequest { payment_method* : string description: For a 3D Secure payment process the value for this property will always be 'card'. For an Interac Online process the value for this property will always be 'interac'. card_response : CardResponse { For a 3D Secure payment process. pa_res* : string description: For a 3D Secure payment process this stores the Authentication Code (PaRes). NOTE: Only used for 3DS 1, use cres for 3DS 2. cres* : string description: For a 3D Secure payment process this stores the Authentication Code. } interac_response : InteracResponse { For an Interac Online payment process. idebit_track2* : string maxLength: 256 description: Assigned by financial institution. Contains PAN, Expiry Date, and Transaction ID. idebit_isslang* : string maxLength: 2 description: The payments language code that is en or fr. idebit_version* : number format: integer description: Always 1. This value is in the redirect Bambora initially sends. idebit_issconf* : string maxLength: 32 description: Issuer Confirmation Number from online banking to be displayed on the merchant's confirmation page. Must be URL decoded. idebit_issname* : string maxLength: 32 description: Financial institution's name to be displayed on the merchant's confirmation page. Must be URL decoded. idebit_amount* : number format: integer description: This is the amount of the transaction, in cents. For example, $13.25 would be represented by 1325. idebit_invoice* : string maxLength: 32 description: The original trnOrderNumber you submitted to Bambora. } }

Parameter Schema Definitions

ContinueRequest { payment_method* : string description:

For a 3D Secure payment process the value for this property will always be 'card'. For an Interac Online process the value for this property will always be 'interac'.

card_response : CardResponse { For a 3D Secure payment process. pa_res* : string description:

For a 3D Secure payment process this stores the Authentication Code (PaRes). NOTE: Only used for 3DS 1, use cres for 3DS 2.

cres* : string description:

For a 3D Secure payment process this stores the Authentication Code.

} interac_response : InteracResponse { For an Interac Online payment process. idebit_track2* : string maxLength: 256 description:

Assigned by financial institution. Contains PAN, Expiry Date, and Transaction ID.

idebit_isslang* : string maxLength: 2 description:

The payments language code that is en or fr.

idebit_version* : number format: integer description:

Always 1. This value is in the redirect Bambora initially sends.

idebit_issconf* : string maxLength: 32 description:

Issuer Confirmation Number from online banking to be displayed on the merchant's confirmation page. Must be URL decoded.

idebit_issname* : string maxLength: 32 description:

Financial institution's name to be displayed on the merchant's confirmation page. Must be URL decoded.

idebit_amount* : number format: integer description:

This is the amount of the transaction, in cents. For example, $13.25 would be represented by 1325.

idebit_invoice* : string maxLength: 32 description:

The original trnOrderNumber you submitted to Bambora.

} }

Responses

Code	Description	Schema
200	Payment response containing the payment details as well as if the transaction was approved or declined.	PaymentResponse
400	Bad Request	ErrorResponse
401	Authentication Failure	ErrorResponse
402	Business Rule Violation or Decline	ErrorResponse
403	Authorization Failure	ErrorResponse
405	Invalid Request Method	ErrorResponse
500	Internal Server Error	ErrorResponse

Response Schema Definitions
PaymentResponse { id : string maxLength: 9 description: transaction Id authorizing_merchant_id : integer description: The id of the merchant that authorized the transaction. approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code created : string format: date-time description: Time stamp of when the transaction occurred order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC maxLength: 16 description: Payment transaction type risk_score : number format: double description: The risk score represents the percentage of probability that the transaction is fraudulent. For example, a score of 10 represents a 10% possibility that the transaction is fraudulent. amount : number format: double maxLength: 9 description: A decimal value in dollars. Uses up to two decimal places. payment_method : string Enum (8) card token payment_profile cash cheque interac apple_pay google_pay description: Payment method custom : Custom { ref1 : string maxLength: 256 description: custom reference field 1 ref2 : string maxLength: 256 description: custom reference field 2 ref3 : string maxLength: 256 description: custom reference field 3 ref4 : string maxLength: 256 description: custom reference field 4 ref5 : string maxLength: 256 description: custom reference field 5 } card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } 3d_secure : 3DSecureResponse { 3D Secure result data status* : string description: Status of 3D secure authentication for the transaction. One of: Success, Attempted, Rejected, Failed, Unavailable, or Error } merchant_data : string maxLength: 32 description: Returned only for 'interac' or 3D Secure payment requests. This value can be used as the {id} value when creating your 'continue' endpoint URL. contents : string description: Returned only for 'interac' or 3D Secure payment requests. This should be embedded in the user's browser client and this needs to be displayed to the customer to redirect them to the Interac login or 3D Secure processing page. interac_online : InteracOnlineResponse { Returned only in the final response from the 'continue' endpoint. idebit_issconf : string description: A numeric confirmation code of the payment idebit_issname : string description: Name of the account holder's financial institution } links : array of Link { ref : string pattern: ^[a-zA-z]{1,16}$ description: Eg. "void" or "return" href : string maxLength: 256 description: Url to perform the void, return, completion etc. method : string pattern: ^[a-zA-z]{1,16}$ description: Http method. post, put, get etc. } card_on_file : CardOnFileResponse { type : string Enum (7) not_card_on_file first_installment subsequent_installment first_recurring subsequent_recurring subsequent_customer_initiated subsequent_unscheduled description: not_card_on_file - A transaction where the credit card information is not stored on file. first_installment - The first payment in a series of installment payments. (Eg. Initial installment payment when purchasing a fridge.) subsequent_installment - A subsequent payment (ie. not the first) in a series of installment payments. (Eg. Next installment payment when purchasing a fridge.) first_recurring - The first payment in a series of scheduled payments with no expected end date. (Eg. Initial payment for a subscription service.) subsequent_recurring - A subsequent payment (ie. not the first) in a series of scheduled payments with no expected end date. (Eg. Next payment for a subscription service.) subsequent_customer_initiated - A recurring transaction that is initiated by the customer. (Eg. Customer reloads a prepaid cash card.) subsequent_unscheduled - An unscheduled recurring transaction that is initiated by the merchant. (Eg. Merchant auto-reloads a prepaid cash card for the customer when the balance on the card reaches a predetermined threshold.) series_id : number format: integer description: The identifier for the set of transactions that this transaction belongs to. } }
ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description: Not used. Always returns an empty string. card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }

Response Schema Definitions

PaymentResponse { id : string maxLength: 9 description:

transaction Id

authorizing_merchant_id : integer description:

The id of the merchant that authorized the transaction.

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

created : string format: date-time description:

Time stamp of when the transaction occurred

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC maxLength: 16 description:

Payment transaction type

risk_score : number format: double description:

The risk score represents the percentage of probability that the transaction is fraudulent. For example, a score of 10 represents a 10% possibility that the transaction is fraudulent.

amount : number format: double maxLength: 9 description:

A decimal value in dollars. Uses up to two decimal places.

payment_method : string Enum (8) card token payment_profile cash cheque interac apple_pay google_pay description:

Payment method

custom : Custom { ref1 : string maxLength: 256 description:

custom reference field 1

ref2 : string maxLength: 256 description:

custom reference field 2

ref3 : string maxLength: 256 description:

custom reference field 3

ref4 : string maxLength: 256 description:

custom reference field 4

ref5 : string maxLength: 256 description:

custom reference field 5

} card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} 3d_secure : 3DSecureResponse { 3D Secure result data status* : string description:

Status of 3D secure authentication for the transaction. One of: Success, Attempted, Rejected, Failed, Unavailable, or Error

} merchant_data : string maxLength: 32 description:

Returned only for 'interac' or 3D Secure payment requests. This value can be used as the {id} value when creating your 'continue' endpoint URL.

contents : string description:

interac_online : InteracOnlineResponse { Returned only in the final response from the 'continue' endpoint. idebit_issconf : string description:

A numeric confirmation code of the payment

idebit_issname : string description:

Name of the account holder's financial institution

} links : array of Link { ref : string pattern: ^[a-zA-z]{1,16}$ description:

Eg. "void" or "return"

href : string maxLength: 256 description:

Url to perform the void, return, completion etc.

method : string pattern: ^[a-zA-z]{1,16}$ description:

Http method. post, put, get etc.

not_card_on_file - A transaction where the credit card information is not stored on file.
first_installment - The first payment in a series of installment payments. (Eg. Initial installment payment when purchasing a fridge.)
subsequent_installment - A subsequent payment (ie. not the first) in a series of installment payments. (Eg. Next installment payment when purchasing a fridge.)
first_recurring - The first payment in a series of scheduled payments with no expected end date. (Eg. Initial payment for a subscription service.)
subsequent_recurring - A subsequent payment (ie. not the first) in a series of scheduled payments with no expected end date. (Eg. Next payment for a subscription service.)
subsequent_customer_initiated - A recurring transaction that is initiated by the customer. (Eg. Customer reloads a prepaid cash card.)
subsequent_unscheduled - An unscheduled recurring transaction that is initiated by the merchant. (Eg. Merchant auto-reloads a prepaid cash card for the customer when the balance on the card reaches a predetermined threshold.)

series_id : number format: integer description:

The identifier for the set of transactions that this transaction belongs to.

} }

ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description:

Not used. Always returns an empty string.

card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

Reports

POST

/reports

Search Query

Description

Query for transactions using a date range and optional search criteria. This method allows you to page your search results if you are expecting a lot of results to be returned. The page start value begins at 1 and the results will be limited to 500 rows. If no records are found the API will return a 200 response message with an empty array. For details on the parameters and allowed values for Criteria please visit the documentation http://dev.na.bambora.com

Parameters

Required	In	Name	Description	Schema
	body	search_query		SearchQuery

Parameter Schema Definitions
SearchQuery { name* : string Enum (2) Search TransHistoryMinimal description: Can be either 'Search' for all fields or 'TransHistoryMinimal' for a subset of the fields returned in the results. start_date* : string description: The start date (inclusive) '2015-04-22T10:03:19' in the timezone of your merchant account. end_date* : string description: The end date (inclusive) '2015-04-22T10:03:19' in the timezone of your merchant account. start_row* : number format: integer default: 1 description: Used to page the results. 1-based end_row* : number format: integer default: 2 description: Used to page the results. 1-based. This should always be 1 larger than start_row with a maximum difference of 500 between them. criteria : array of Criteria { field : number format: integer description: Refer to the table on this page for the searchable fields http://dev.na.bambora.com operator : string Enum (6) %3D %3C %3E %3C%3D %3E%3D START%20WITH description: URL encoded comparators such as less than, greater than, equals... Refer to the table on this page for the full list of comparators http://dev.na.bambora.com value : string description: The value you want to match against. } }

Parameter Schema Definitions

SearchQuery { name* : string Enum (2) Search TransHistoryMinimal description:

Can be either 'Search' for all fields or 'TransHistoryMinimal' for a subset of the fields returned in the results.

start_date* : string description:

The start date (inclusive) '2015-04-22T10:03:19' in the timezone of your merchant account.

end_date* : string description:

The end date (inclusive) '2015-04-22T10:03:19' in the timezone of your merchant account.

start_row* : number format: integer default: 1 description:

Used to page the results. 1-based

end_row* : number format: integer default: 2 description:

Used to page the results. 1-based. This should always be 1 larger than start_row with a maximum difference of 500 between them.

criteria : array of Criteria { field : number format: integer description:

Refer to the table on this page for the searchable fields http://dev.na.bambora.com

operator : string Enum (6) %3D %3C %3E %3C%3D %3E%3D START%20WITH description:

URL encoded comparators such as less than, greater than, equals... Refer to the table on this page for the full list of comparators http://dev.na.bambora.com

value : string description:

The value you want to match against.

} }

Responses

Code	Description	Schema
200	A transaction object.	SearchResult
400	Bad Request	ErrorResponse
401	Authentication Failure	ErrorResponse
402	Business Rule Violation or Decline	ErrorResponse
403	Authorization Failure	ErrorResponse
405	Invalid Request Method	ErrorResponse
500	Internal Server Error	ErrorResponse

Response Schema Definitions
SearchResult { records : array of SearchRecord { row_id : number format: integer trn_id : number format: integer trn_date_time : string description: 2015-04-22T10:03:19.323-07:00 trn_type : string trn_order_number : string trn_payment_method : string trn_comments : string trn_masked_card : string description: The credit card with the middle digits redacted with X's trn_amount : number format: float32 trn_returns : number format: float32 trn_completions : number format: float32 trn_voided : number format: integer trn_response : number format: integer trn_card_type : string description: MC VI etc trn_batch_no : number format: integer trn_avs_result : string description: Address Verification Service trn_cvd_result : number format: integer trn_cavv_result : string description: 3D Secure Code Result trn_card_expiry : string message_id : number format: integer message_text : string trn_card_owner : string trn_ip : string trn_approval_code : string trn_reference : number format: integer b_name : string b_email : string b_phone : string b_address1 : string b_address2 : string b_city : string b_province : string b_postal : string b_country : string s_name : string s_email : string s_phone : string s_address1 : string s_address2 : string s_city : string s_province : string s_postal : string s_country : string ref1 : string ref2 : string ref3 : string ref4 : string ref5 : string product_name : string product_id : string customer_code : string description: The Payment Profile ID used in this transaction, if appropriate. currency_abbr : string maxLength: 3 description: The currency for this transaction. merchant_id : integer description: The id of the merchant for this transaction. merchant_name : string description: The name of the merchant for this transaction. entry_method : string Enum (8) N A P S V Y T E maxLength: 1 description: How the transaction was initiated. N = Standard Entry, A = Apple Pay, P = Google Pay, S = EMV Swipe, V = Visa Checkout, Y = Unimag Card Swiper, T = EMV Chip Tap, E = EMV Chip Dip authorizing_merchant_id : integer description: The id of the merchant that authorized this transaction. } }
ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description: Not used. Always returns an empty string. card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }

Response Schema Definitions

SearchResult { records : array of SearchRecord { row_id : number format: integer trn_id : number format: integer trn_date_time : string description:

2015-04-22T10:03:19.323-07:00

trn_type : string trn_order_number : string trn_payment_method : string trn_comments : string trn_masked_card : string description:

The credit card with the middle digits redacted with X's

trn_amount : number format: float32 trn_returns : number format: float32 trn_completions : number format: float32 trn_voided : number format: integer trn_response : number format: integer trn_card_type : string description:

MC VI etc

trn_batch_no : number format: integer trn_avs_result : string description:

Address Verification Service

trn_cvd_result : number format: integer trn_cavv_result : string description:

3D Secure Code Result

trn_card_expiry : string message_id : number format: integer message_text : string trn_card_owner : string trn_ip : string trn_approval_code : string trn_reference : number format: integer b_name : string b_email : string b_phone : string b_address1 : string b_address2 : string b_city : string b_province : string b_postal : string b_country : string s_name : string s_email : string s_phone : string s_address1 : string s_address2 : string s_city : string s_province : string s_postal : string s_country : string ref1 : string ref2 : string ref3 : string ref4 : string ref5 : string product_name : string product_id : string customer_code : string description:

The Payment Profile ID used in this transaction, if appropriate.

currency_abbr : string maxLength: 3 description:

The currency for this transaction.

merchant_id : integer description:

The id of the merchant for this transaction.

merchant_name : string description:

The name of the merchant for this transaction.

entry_method : string Enum (8) N A P S V Y T E maxLength: 1 description:

How the transaction was initiated. N = Standard Entry, A = Apple Pay, P = Google Pay, S = EMV Swipe, V = Visa Checkout, Y = Unimag Card Swiper, T = EMV Chip Tap, E = EMV Chip Dip

authorizing_merchant_id : integer description:

The id of the merchant that authorized this transaction.

} }

ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description:

Not used. Always returns an empty string.

card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

GET

/reports/merchants

Merchant Report

Description

This report provides information about a merchant and their sub-merchants.

Parameters

No parameters

Responses

Code	Description	Schema
200	A merchant object.	MerchantReport
400	Bad Request	ErrorResponse
401	Authentication Failure	ErrorResponse
402	Business Rule Violation or Decline	ErrorResponse
403	Authorization Failure	ErrorResponse
405	Invalid Request Method	ErrorResponse
500	Internal Server Error	ErrorResponse

Response Schema Definitions
MerchantReport { data : array of MerchantRecord { merchant_id : number format: integer description: The id of the merchant. merchant_name : string maxLength: 64 description: The name of the merchant. website : string maxLength: 64 description: The merchant's website. address : MerchantAddress { street_address : string maxLength: 64 description: Street address province : string maxLength: 32 description: characters (2) country : string maxLength: 64 description: Country name postal_code : string maxLength: 16 description: Postal/Zip code } merchant_status : MerchantStatus { status : string Enum (4) Active Temporarily Disabled Disabled Closed maxLength: 32 description: The status of this merchant. state : string Enum (9) Created Approved Declined Pending Live Disabled Enabled Authorized Received maxLength: 10 description: The state of this merchant. live_date : string format: date description: The date this merchant went live. created_date : string format: date description: The date this merchant was created. authorized_date : string format: date description: The date this merchant was authorized. temp_disabled_date : string format: date description: The date this merchant was temp disabled. last_enabled_date : string format: date description: The date that an account was enabled after being 'temp disabled' disabled_date : string format: date description: The date this merchant was disabled. } processor : MerchantProcessor { processor_name : string maxLength: 32 description: The name of this processor. currency : string maxLength: 3 description: The currency abbreviation for this processor. } batch : Batch { batch_limit : number format: double description: Processing limit for batches. batch_line_limit : number format: double description: Processing limit per line for batches. eft_credit_lag : number format: integer description: Settlement lag for eft. } settlement : Settlement { credit_lag : number format: integer description: Settlement lag for credit. } cards : MerchantCards { mastercard_enabled : boolean description: Whether the merchant is configured to process MasterCard. visa_enabled : boolean description: Whether the merchant is configured to process Visa. amex_enabled : boolean description: Whether the merchant is configured to process Amex. discover_enabled : boolean description: Whether the merchant is configured to process Discover. diners_enabled : boolean description: Whether the merchant is configured to process Diners. jcb_enabled : boolean description: Whether the merchant is configured to process JCB. mastercard_debit_enabled : boolean description: Whether the merchant is configured to process MasterCard Debit. visa_debit_enabled : boolean description: Whether the merchant is configured to process Visa Debit. } features : MerchantFeatures { checkout_enabled : boolean description: Whether the merchant is configured to use Checkout. payment_profile_enabled : boolean description: Whether the merchant is configured to use Payment Profiles. recurring_billing_enabled : boolean description: Whether the merchant is configured to use Recurring Billing. credit_card_batch_enabled : boolean description: Whether the merchant is configured to use Credit Card Batch. eft_ach_enabled : boolean description: Whether the merchant is configured to use Eft/Ach. interac_online_enabled : boolean description: Whether the merchant is configured to use Interac Online. visa_src_enabled : boolean description: Whether the merchant is configured to use Visa Src. } } }
ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description: Not used. Always returns an empty string. card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }

Response Schema Definitions

MerchantReport { data : array of MerchantRecord { merchant_id : number format: integer description:

The id of the merchant.

merchant_name : string maxLength: 64 description:

The name of the merchant.

website : string maxLength: 64 description:

The merchant's website.

address : MerchantAddress { street_address : string maxLength: 64 description:

Street address

province : string maxLength: 32 description:

characters (2)

country : string maxLength: 64 description:

Country name

postal_code : string maxLength: 16 description:

Postal/Zip code

} merchant_status : MerchantStatus { status : string Enum (4) Active Temporarily Disabled Disabled Closed maxLength: 32 description:

The status of this merchant.

state : string Enum (9) Created Approved Declined Pending Live Disabled Enabled Authorized Received maxLength: 10 description:

The state of this merchant.

live_date : string format: date description:

The date this merchant went live.

created_date : string format: date description:

The date this merchant was created.

authorized_date : string format: date description:

The date this merchant was authorized.

temp_disabled_date : string format: date description:

The date this merchant was temp disabled.

last_enabled_date : string format: date description:

The date that an account was enabled after being 'temp disabled'

disabled_date : string format: date description:

The date this merchant was disabled.

} processor : MerchantProcessor { processor_name : string maxLength: 32 description:

The name of this processor.

currency : string maxLength: 3 description:

The currency abbreviation for this processor.

} batch : Batch { batch_limit : number format: double description:

Processing limit for batches.

batch_line_limit : number format: double description:

Processing limit per line for batches.

eft_credit_lag : number format: integer description:

Settlement lag for eft.

} settlement : Settlement { credit_lag : number format: integer description:

Settlement lag for credit.

} cards : MerchantCards { mastercard_enabled : boolean description:

Whether the merchant is configured to process MasterCard.

visa_enabled : boolean description:

Whether the merchant is configured to process Visa.

amex_enabled : boolean description:

Whether the merchant is configured to process Amex.

discover_enabled : boolean description:

Whether the merchant is configured to process Discover.

diners_enabled : boolean description:

Whether the merchant is configured to process Diners.

jcb_enabled : boolean description:

Whether the merchant is configured to process JCB.

mastercard_debit_enabled : boolean description:

Whether the merchant is configured to process MasterCard Debit.

visa_debit_enabled : boolean description:

Whether the merchant is configured to process Visa Debit.

} features : MerchantFeatures { checkout_enabled : boolean description:

Whether the merchant is configured to use Checkout.

payment_profile_enabled : boolean description:

Whether the merchant is configured to use Payment Profiles.

recurring_billing_enabled : boolean description:

Whether the merchant is configured to use Recurring Billing.

credit_card_batch_enabled : boolean description:

Whether the merchant is configured to use Credit Card Batch.

eft_ach_enabled : boolean description:

Whether the merchant is configured to use Eft/Ach.

interac_online_enabled : boolean description:

Whether the merchant is configured to use Interac Online.

visa_src_enabled : boolean description:

Whether the merchant is configured to use Visa Src.

} } }

ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description:

Not used. Always returns an empty string.

card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

GET

/reports/merchants/{merchantId}

Merchant Report

Description

This report provides information about a merchant's specific sub-merchant.

Parameters

Required	In	Name	Description	Schema
true	path	merchantId	The id of the sub-merchant.	integer

Responses

Code	Description	Schema
200	A merchant object.	MerchantReport
400	Bad Request	ErrorResponse
401	Authentication Failure	ErrorResponse
402	Business Rule Violation or Decline	ErrorResponse
403	Authorization Failure	ErrorResponse
405	Invalid Request Method	ErrorResponse
500	Internal Server Error	ErrorResponse

Response Schema Definitions
MerchantReport { data : array of MerchantRecord { merchant_id : number format: integer description: The id of the merchant. merchant_name : string maxLength: 64 description: The name of the merchant. website : string maxLength: 64 description: The merchant's website. address : MerchantAddress { street_address : string maxLength: 64 description: Street address province : string maxLength: 32 description: characters (2) country : string maxLength: 64 description: Country name postal_code : string maxLength: 16 description: Postal/Zip code } merchant_status : MerchantStatus { status : string Enum (4) Active Temporarily Disabled Disabled Closed maxLength: 32 description: The status of this merchant. state : string Enum (9) Created Approved Declined Pending Live Disabled Enabled Authorized Received maxLength: 10 description: The state of this merchant. live_date : string format: date description: The date this merchant went live. created_date : string format: date description: The date this merchant was created. authorized_date : string format: date description: The date this merchant was authorized. temp_disabled_date : string format: date description: The date this merchant was temp disabled. last_enabled_date : string format: date description: The date that an account was enabled after being 'temp disabled' disabled_date : string format: date description: The date this merchant was disabled. } processor : MerchantProcessor { processor_name : string maxLength: 32 description: The name of this processor. currency : string maxLength: 3 description: The currency abbreviation for this processor. } batch : Batch { batch_limit : number format: double description: Processing limit for batches. batch_line_limit : number format: double description: Processing limit per line for batches. eft_credit_lag : number format: integer description: Settlement lag for eft. } settlement : Settlement { credit_lag : number format: integer description: Settlement lag for credit. } cards : MerchantCards { mastercard_enabled : boolean description: Whether the merchant is configured to process MasterCard. visa_enabled : boolean description: Whether the merchant is configured to process Visa. amex_enabled : boolean description: Whether the merchant is configured to process Amex. discover_enabled : boolean description: Whether the merchant is configured to process Discover. diners_enabled : boolean description: Whether the merchant is configured to process Diners. jcb_enabled : boolean description: Whether the merchant is configured to process JCB. mastercard_debit_enabled : boolean description: Whether the merchant is configured to process MasterCard Debit. visa_debit_enabled : boolean description: Whether the merchant is configured to process Visa Debit. } features : MerchantFeatures { checkout_enabled : boolean description: Whether the merchant is configured to use Checkout. payment_profile_enabled : boolean description: Whether the merchant is configured to use Payment Profiles. recurring_billing_enabled : boolean description: Whether the merchant is configured to use Recurring Billing. credit_card_batch_enabled : boolean description: Whether the merchant is configured to use Credit Card Batch. eft_ach_enabled : boolean description: Whether the merchant is configured to use Eft/Ach. interac_online_enabled : boolean description: Whether the merchant is configured to use Interac Online. visa_src_enabled : boolean description: Whether the merchant is configured to use Visa Src. } } }
ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description: Not used. Always returns an empty string. card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }

Response Schema Definitions

MerchantReport { data : array of MerchantRecord { merchant_id : number format: integer description:

The id of the merchant.

merchant_name : string maxLength: 64 description:

The name of the merchant.

website : string maxLength: 64 description:

The merchant's website.

address : MerchantAddress { street_address : string maxLength: 64 description:

Street address

province : string maxLength: 32 description:

characters (2)

country : string maxLength: 64 description:

Country name

postal_code : string maxLength: 16 description:

Postal/Zip code

} merchant_status : MerchantStatus { status : string Enum (4) Active Temporarily Disabled Disabled Closed maxLength: 32 description:

The status of this merchant.

state : string Enum (9) Created Approved Declined Pending Live Disabled Enabled Authorized Received maxLength: 10 description:

The state of this merchant.

live_date : string format: date description:

The date this merchant went live.

created_date : string format: date description:

The date this merchant was created.

authorized_date : string format: date description:

The date this merchant was authorized.

temp_disabled_date : string format: date description:

The date this merchant was temp disabled.

last_enabled_date : string format: date description:

The date that an account was enabled after being 'temp disabled'

disabled_date : string format: date description:

The date this merchant was disabled.

} processor : MerchantProcessor { processor_name : string maxLength: 32 description:

The name of this processor.

currency : string maxLength: 3 description:

The currency abbreviation for this processor.

} batch : Batch { batch_limit : number format: double description:

Processing limit for batches.

batch_line_limit : number format: double description:

Processing limit per line for batches.

eft_credit_lag : number format: integer description:

Settlement lag for eft.

} settlement : Settlement { credit_lag : number format: integer description:

Settlement lag for credit.

} cards : MerchantCards { mastercard_enabled : boolean description:

Whether the merchant is configured to process MasterCard.

visa_enabled : boolean description:

Whether the merchant is configured to process Visa.

amex_enabled : boolean description:

Whether the merchant is configured to process Amex.

discover_enabled : boolean description:

Whether the merchant is configured to process Discover.

diners_enabled : boolean description:

Whether the merchant is configured to process Diners.

jcb_enabled : boolean description:

Whether the merchant is configured to process JCB.

mastercard_debit_enabled : boolean description:

Whether the merchant is configured to process MasterCard Debit.

visa_debit_enabled : boolean description:

Whether the merchant is configured to process Visa Debit.

} features : MerchantFeatures { checkout_enabled : boolean description:

Whether the merchant is configured to use Checkout.

payment_profile_enabled : boolean description:

Whether the merchant is configured to use Payment Profiles.

recurring_billing_enabled : boolean description:

Whether the merchant is configured to use Recurring Billing.

credit_card_batch_enabled : boolean description:

Whether the merchant is configured to use Credit Card Batch.

eft_ach_enabled : boolean description:

Whether the merchant is configured to use Eft/Ach.

interac_online_enabled : boolean description:

Whether the merchant is configured to use Interac Online.

visa_src_enabled : boolean description:

Whether the merchant is configured to use Visa Src.

} } }

ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description:

Not used. Always returns an empty string.

card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

GET

/reports/settlement

Settlement Report

Description

This report provides credit card settlement and fee information. It is helpful to understand the credit date, amount, and fees of each settlement. You can retrieve settlement data with up to a three-month range.

Note:

Our system calculates settlement using Pacific Time (PT) with midnight cut off.

Parameters

Required	In	Name	Description	Schema
true	query	start_date	The start date (inclusive) '2020-04-21'. Must be on or before end_date.	string
true	query	end_date	The end date (inclusive) '2020-05-30'. Must be no more than 3 months passed the start_date and cannot include today's date.	string

Responses

Code	Description	Schema
200	A settlement object.	CardSettlementReport
400	Bad Request	ErrorResponse
401	Authentication Failure	ErrorResponse
403	Authorization Failure	ErrorResponse
405	Invalid Request Method	ErrorResponse
500	Internal Server Error	ErrorResponse

Response Schema Definitions
CardSettlementReport { data : array of CardSettlementRecord { merchant_id : number format: integer description: The id of the merchant for this settlement. transactions_date : string format: date description: The day (PT) the transactions settled. currency : string maxLength: 3 description: The currency abbreviation for this settlement. settlement_net_amount : number format: double description: Shows the total net amount of the settlement. settlement_state : string Enum (11) Scheduled Generating In Process Approved Declined Transferred On Hold Accumulating Perform Settlement Under Minimum Threshold Pending Account Verification description: State of the settlement. settlement_date : string format: date description: The day (PT) the funds are expected to be processed by the bank and settled. If there is no date scheduled yet then it will return "0001-01-01" approved_transaction_count : number format: integer description: Total count of approved transactions declined_transaction_count : number format: integer description: Total count of declined transactions sale_amount_total : number format: double description: Total amount of sales in dollars and cents returned_amount_total : number format: double description: Total amount of returns in dollars and cents chargebacks_count : number format: integer description: Total count of chargebacks chargebacks_amount_total : number format: double description: Total amount of chargebacks in dollars and cents card_transaction_approved_rate : number format: double description: Rate for approved transactions card_transaction_declined_rate : number format: double description: Rate for declined transactions card_discount_rate : number format: double description: Card discount rate gst_tax_rate : number format: double description: GST rate applied to fees approved_transaction_fee_total : number format: double description: Total fees for approved transactions declined_transaction_fee_total : number format: double description: Total fees for declined transactions discount_rate_fee_total : number format: double description: Total of the per-transaction fees that is charged based upon the total amount of the transaction size. chargeback_fee_total : number format: double description: Chargeback fees are applied against transactions that were contested by a credit card owner. gst_tax_fee_total : number format: double description: The total GST applied to transaction fees. GST is only added to chargeback fees. reserves_held : number format: double description: The amount currently held in a Bambora reserve account. reserves_released : number format: double description: Amount released from the reserve account during the current statement period. reserves_forward : number format: double description: Total amount that Bambora held in a reserve account as of the previous statement period. } }
ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description: Not used. Always returns an empty string. card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }

Response Schema Definitions

CardSettlementReport { data : array of CardSettlementRecord { merchant_id : number format: integer description:

The id of the merchant for this settlement.

transactions_date : string format: date description:

The day (PT) the transactions settled.

currency : string maxLength: 3 description:

The currency abbreviation for this settlement.

settlement_net_amount : number format: double description:

Shows the total net amount of the settlement.

settlement_state : string Enum (11) Scheduled Generating In Process Approved Declined Transferred On Hold Accumulating Perform Settlement Under Minimum Threshold Pending Account Verification description:

State of the settlement.

settlement_date : string format: date description:

The day (PT) the funds are expected to be processed by the bank and settled. If there is no date scheduled yet then it will return "0001-01-01"

approved_transaction_count : number format: integer description:

Total count of approved transactions

declined_transaction_count : number format: integer description:

Total count of declined transactions

sale_amount_total : number format: double description:

Total amount of sales in dollars and cents

returned_amount_total : number format: double description:

Total amount of returns in dollars and cents

chargebacks_count : number format: integer description:

Total count of chargebacks

chargebacks_amount_total : number format: double description:

Total amount of chargebacks in dollars and cents

card_transaction_approved_rate : number format: double description:

Rate for approved transactions

card_transaction_declined_rate : number format: double description:

Rate for declined transactions

card_discount_rate : number format: double description:

Card discount rate

gst_tax_rate : number format: double description:

GST rate applied to fees

approved_transaction_fee_total : number format: double description:

Total fees for approved transactions

declined_transaction_fee_total : number format: double description:

Total fees for declined transactions

discount_rate_fee_total : number format: double description:

Total of the per-transaction fees that is charged based upon the total amount of the transaction size.

chargeback_fee_total : number format: double description:

Chargeback fees are applied against transactions that were contested by a credit card owner.

gst_tax_fee_total : number format: double description:

The total GST applied to transaction fees. GST is only added to chargeback fees.

reserves_held : number format: double description:

The amount currently held in a Bambora reserve account.

reserves_released : number format: double description:

Amount released from the reserve account during the current statement period.

reserves_forward : number format: double description:

Total amount that Bambora held in a reserve account as of the previous statement period.

} }

ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description:

Not used. Always returns an empty string.

card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

GET

/reports/statements

Statement Report

Description

This report provides details on fees applied to your monthly statement. For partners we also provide comission and fees charged to your sub merchants.

Note:

Our system calculates fees using Pacific Time (PT) with midnight cut off.

Parameters

Required	In	Name	Description	Schema
true	query	start_year	The start year.	number
true	query	start_month	The start month (inclusive).	number
true	query	end_year	The end year.	number
true	query	end_month	The end month (inclusive).	number

Responses

Code	Description	Schema
200	A statement object.	StatementReport
400	Bad Request	ErrorResponse
401	Authentication Failure	ErrorResponse
403	Authorization Failure	ErrorResponse
405	Invalid Request Method	ErrorResponse
500	Internal Server Error	ErrorResponse

Response Schema Definitions
StatementReport { data : array of StatementRecord { billing_period : string format: date description: The billing period that fees and commissions have been applied to. Billing periods are monthly where this field will always be set as the 1st day of the month. parent_id : number format: integer description: The id of the parent merchant for this statement. This field is only returned for channel partner accounts. parent_name : string description: The name of the parent merchant for this statement. This field is only returned for channel partner accounts. statement_id : number format: integer description: The id of the statement for the associated billing period. merchant_id : number format: integer description: The id of the merchant for this statement. merchant_name : string description: The name of the merchant for this statement. This field is only returned for channel partner accounts. fee_type : string description: The type of fee being charged. fee_volume : number format: integer description: The count of the associated fee being charged. fee_rate : number format: double description: The rate of the fee being charged. fee_amount : number format: double description: The fee amount being charged. commission_rate : number format: double description: The commission rate to be collected against the fee. This field is only returned for channel partner accounts. commission_amount : number format: double description: The commission amount collected against the fee. This field is only returned for channel partner accounts. } }
ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description: Not used. Always returns an empty string. card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }

Response Schema Definitions

StatementReport { data : array of StatementRecord { billing_period : string format: date description:

The billing period that fees and commissions have been applied to. Billing periods are monthly where this field will always be set as the 1st day of the month.

parent_id : number format: integer description:

The id of the parent merchant for this statement. This field is only returned for channel partner accounts.

parent_name : string description:

The name of the parent merchant for this statement. This field is only returned for channel partner accounts.

statement_id : number format: integer description:

The id of the statement for the associated billing period.

merchant_id : number format: integer description:

The id of the merchant for this statement.

merchant_name : string description:

The name of the merchant for this statement. This field is only returned for channel partner accounts.

fee_type : string description:

The type of fee being charged.

fee_volume : number format: integer description:

The count of the associated fee being charged.

fee_rate : number format: double description:

The rate of the fee being charged.

fee_amount : number format: double description:

The fee amount being charged.

commission_rate : number format: double description:

The commission rate to be collected against the fee. This field is only returned for channel partner accounts.

commission_amount : number format: double description:

The commission amount collected against the fee. This field is only returned for channel partner accounts.

} }

ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description:

Not used. Always returns an empty string.

card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

GET

/reports/commissions

Commissions Report

Description

This report provides details on fees applied to your FlexCommissions payouts.

Parameters

Required	In	Name	Description	Schema
false	query	from_date	Report from date	string
false	query	to_date	Report to date	string
false	query	report_days	Number of days from today to generate the report for	integer
false	query	filter_by	Filter on payment status	string
false	query	filter_value	Filer for payments with state - Scheduled, On Hold, Superseded, In Process, Approved, Declined, Pending Payment, Full Payment	string
false	query	start_row	The first row number in the result set.	integer
false	query	end_row	The last row number in the result set.	integer
false	query	version	API version. Current version: 1.0	integer

Responses

Code	Description	Schema
200	A commission object.	CommissionsReport
400	Bad Request	ErrorResponse
401	Authentication Failure	ErrorResponse
403	Authorization Failure	ErrorResponse
405	Invalid Request Method	ErrorResponse
500	Internal Server Error	ErrorResponse

Response Schema Definitions
CommissionsReport { data : array of CommissionsRecord { row_id : number format: integer description: The row id. payout_id : number format: integer description: The id of the commission payout. amount : string description: The amount of the commission payout. start_datetime : string format: date description: The start date for the report. end_datetime : string format: date description: The end date for the report. expected_settlement_date : string format: date description: The expected date the payout will reach the Partner. statement_id : number format: integer description: The statement that the commission payout will appear on. status : number format: integer description: The status of the commission payout. } }
ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description: Not used. Always returns an empty string. card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }

Response Schema Definitions

CommissionsReport { data : array of CommissionsRecord { row_id : number format: integer description:

The row id.

payout_id : number format: integer description:

The id of the commission payout.

amount : string description:

The amount of the commission payout.

start_datetime : string format: date description:

The start date for the report.

end_datetime : string format: date description:

The end date for the report.

expected_settlement_date : string format: date description:

The expected date the payout will reach the Partner.

statement_id : number format: integer description:

The statement that the commission payout will appear on.

status : number format: integer description:

The status of the commission payout.

} }

ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description:

Not used. Always returns an empty string.

card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

Profiles

POST

/profiles

Create Profile

Description

Create a new Payment Profile using either a card, a single-use token, a transaction id, or bank credentials. You must supply one of them. You may store a card and bank credentials on the same profile.

Parameters

Required	In	Name	Description	Schema
true	body	createProfileBody		ProfileBody

Parameter Schema Definitions
ProfileBody { card : ProfileFromCard { name* : string maxLength: 64 description: Card holder name. number* : string maxLength: 20 description: Credit card number (PAN) expiry_month* : string default: 02 maxLength: 2 description: eg. 02 for February. expiry_year* : string default: 17 maxLength: 2 description: eg. 17 for 2017. cvd : string default: 123 maxLength: 4 description: Security code on the back of the credit card. This can be set to mandatory in the back office. } bank_account : ProfileFromBankAccount { account_number* : string maxLength: 17 description: For U.S. and Canadian bank accounts. Specify the customer’s bank account number. Account number may vary in length. bank_account_holder* : string maxLength: 20 description: Account holder name. bank_account_type* : string minLength: 2 maxLength: 2 description: PC=U.S. Personal Checking account. PS=U.S. Personal Saving account. CC=U.S. Corporate Checking account. CS=U.S. Corporate Savings account. CA=Canadian account. branch_number : string minLength: 5 maxLength: 5 description: For Canadian bank accounts only. Specify the customer’s bank branch number. institution_number : string minLength: 3 maxLength: 3 description: For Canadian bank accounts only. Specify the institution number of the customer’s financial institution. routing_number : string minLength: 9 maxLength: 9 description: For U.S. bank accounts only. Specify the customer’s routing number. } create_from_id : ProfileFromTransactionId { create_from_id* : number format: integer minLength: 8 maxLength: 8 description: The id of the transaction the user wishes to create a profile from. } token : ProfileFromToken { name* : string maxLength: 64 description: Card holder name. code* : string maxLength: 64 description: The token received from the client-side tokenization service. } billing : Address { name : string maxLength: 64 description: Name of the person/business address_line1 : string maxLength: 64 description: Street address address_line2 : string maxLength: 64 description: Additional address information(eg; suite number, apartment number, etc) city : string maxLength: 32 description: The city province : string description: characters (2) country : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW maxLength: 2 description: Valid ISO 3166-1 country code postal_code : string maxLength: 16 description: Postal/Zip code phone_number : string pattern: ^\d{1,20}$ description: Phone number email_address : string maxLength: 64 description: Email Address } custom : Custom { ref1 : string maxLength: 256 description: custom reference field 1 ref2 : string maxLength: 256 description: custom reference field 2 ref3 : string maxLength: 256 description: custom reference field 3 ref4 : string maxLength: 256 description: custom reference field 4 ref5 : string maxLength: 256 description: custom reference field 5 } language : string maxLength: 3 description: characters comment : string maxLength: 256 description: Any comments that a user would like to attach to the Payment Profile validate : boolean description: Set to true to automatically process a pre-auth transaction for validation purposes. Processor token transactions require validation, and must be set to true. }

Parameter Schema Definitions

ProfileBody { card : ProfileFromCard { name* : string maxLength: 64 description:

Card holder name.

number* : string maxLength: 20 description:

Credit card number (PAN)

expiry_month* : string default: 02 maxLength: 2 description:

eg. 02 for February.

expiry_year* : string default: 17 maxLength: 2 description:

eg. 17 for 2017.

cvd : string default: 123 maxLength: 4 description:

Security code on the back of the credit card. This can be set to mandatory in the back office.

} bank_account : ProfileFromBankAccount { account_number* : string maxLength: 17 description:

For U.S. and Canadian bank accounts. Specify the customer’s bank account number. Account number may vary in length.

bank_account_holder* : string maxLength: 20 description:

Account holder name.

bank_account_type* : string minLength: 2 maxLength: 2 description:

PC=U.S. Personal Checking account. PS=U.S. Personal Saving account. CC=U.S. Corporate Checking account. CS=U.S. Corporate Savings account. CA=Canadian account.

branch_number : string minLength: 5 maxLength: 5 description:

For Canadian bank accounts only. Specify the customer’s bank branch number.

institution_number : string minLength: 3 maxLength: 3 description:

For Canadian bank accounts only. Specify the institution number of the customer’s financial institution.

routing_number : string minLength: 9 maxLength: 9 description:

For U.S. bank accounts only. Specify the customer’s routing number.

} create_from_id : ProfileFromTransactionId { create_from_id* : number format: integer minLength: 8 maxLength: 8 description:

The id of the transaction the user wishes to create a profile from.

} token : ProfileFromToken { name* : string maxLength: 64 description:

Card holder name.

code* : string maxLength: 64 description:

The token received from the client-side tokenization service.

} billing : Address { name : string maxLength: 64 description:

Name of the person/business

address_line1 : string maxLength: 64 description:

Street address

address_line2 : string maxLength: 64 description:

Additional address information(eg; suite number, apartment number, etc)

city : string maxLength: 32 description:

The city

province : string description:

characters (2)

Valid ISO 3166-1 country code

postal_code : string maxLength: 16 description:

Postal/Zip code

phone_number : string pattern: ^\d{1,20}$ description:

Phone number

email_address : string maxLength: 64 description:

Email Address

} custom : Custom { ref1 : string maxLength: 256 description:

custom reference field 1

ref2 : string maxLength: 256 description:

custom reference field 2

ref3 : string maxLength: 256 description:

custom reference field 3

ref4 : string maxLength: 256 description:

custom reference field 4

ref5 : string maxLength: 256 description:

custom reference field 5

} language : string maxLength: 3 description:

characters

comment : string maxLength: 256 description:

Any comments that a user would like to attach to the Payment Profile

validate : boolean description:

Set to true to automatically process a pre-auth transaction for validation purposes. Processor token transactions require validation, and must be set to true.

}

Responses

Code	Description	Schema
200	The Profile.	ProfileResponse
400	Bad Request	ErrorResponse
401	Authentication Failure	ErrorResponse
402	Business Rule Violation or Decline	ErrorResponse
403	Authorization Failure	ErrorResponse
405	Invalid Request Method	ErrorResponse
500	Internal Server Error	ErrorResponse

Response Schema Definitions
ProfileResponse { code : number format: integer message : string customer_code : string description: the ID of the payment profile. You need to keep track of this value. validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }
ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description: Not used. Always returns an empty string. card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }

Response Schema Definitions

ProfileResponse { code : number format: integer message : string customer_code : string description:

the ID of the payment profile. You need to keep track of this value.

validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description:

Not used. Always returns an empty string.

card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

GET

/profiles/{profileId}

Get profile

Description

Get a Payment Profile using the profile ID, also known as the Customer Code.

Parameters

Required	In	Name	Description	Schema
true	path	profileId	The profile id. (aka CustomerCode)	string

Responses

Code	Description	Schema
200	The Profile.	PaymentProfileResponse
400	Bad Request	ErrorResponse
401	Authentication Failure	ErrorResponse
402	Business Rule Violation or Decline	ErrorResponse
403	Authorization Failure	ErrorResponse
405	Invalid Request Method	ErrorResponse
500	Internal Server Error	ErrorResponse

Response Schema Definitions
PaymentProfileResponse { code : integer format: int32 maxLength: 2 description: Code message : string maxLength: 64 description: Message containing contextual information about the response customer_code : string maxLength: 32 description: Unique payment profile ID status : string description: characters(1) last_transaction : string format: date-time maxLength: 24 description: date and time of last transaction modified_date : string format: date-time maxLength: 24 description: date and time the profile was last modified language : string maxLength: 3 description: Language velocity_group : string profile_group : string account_ref : string card : GetProfileDefaultCard { name : string maxLength: 64 description: cardholder name number : string maxLength: 20 description: masked credit card number expiry_month : string default: 02 maxLength: 2 description: eg. 02 for February. expiry_year : string default: 17 maxLength: 2 description: eg. 17 for 2017. card_type : string Enum (5) AM DI JB MC NN'VI maxLength: 2 description: The type of card associated with the profile. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa } billing : Address { name : string maxLength: 64 description: Name of the person/business address_line1 : string maxLength: 64 description: Street address address_line2 : string maxLength: 64 description: Additional address information(eg; suite number, apartment number, etc) city : string maxLength: 32 description: The city province : string description: characters (2) country : string Enum (249) AD AE AF AG AI AL AM AO AQ AR AS AT AU AW AX AZ BA BB BD BE BF BG BH BI BJ BL BM BN BO BQ BR BS BT BV BW BY BZ CA CC CD CF CG CH CI CK CL CM CN CO CR CU CV CW CX CY CZ DE DJ DK DM DO DZ EC EE EG EH ER ES ET FI FJ FK FM FO FR GA GB GD GE GF GG GH GI GL GM GN GP GQ GR GS GT GU GW GY HK HM HN HR HT HU ID IE IL IM IN IO IQ IR IS IT JE JM JO JP KE KG KH KI KM KN KP KR KW KY KZ LA LB LC LI LK LR LS LT LU LV LY MA MC MD ME MF MG MH MK ML MM MN MO MP MQ MR MS MT MU MV MW MX MY MZ NA NC NE NF NG NI NL NO NP NR NU NZ OM PA PE PF PG PH PK PL PM PN PR PS PT PW PY QA RE RO RS RU RW SA SB SC SD SE SG SH SI SJ SK SL SM SN SO SR SS ST SV SX SY SZ TC TD TF TG TH TJ TK TL TM TN TO TR TT TV TW TZ UA UG UM US UY UZ VA VC VE VG VI VN VU WF WS YE YT ZA ZM ZW maxLength: 2 description: Valid ISO 3166-1 country code postal_code : string maxLength: 16 description: Postal/Zip code phone_number : string pattern: ^\d{1,20}$ description: Phone number email_address : string maxLength: 64 description: Email Address } custom : Custom { ref1 : string maxLength: 256 description: custom reference field 1 ref2 : string maxLength: 256 description: custom reference field 2 ref3 : string maxLength: 256 description: custom reference field 3 ref4 : string maxLength: 256 description: custom reference field 4 ref5 : string maxLength: 256 description: custom reference field 5 } }
ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description: Not used. Always returns an empty string. card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description: The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard last_four : string maxLength: 4 description: For all payments completed using a credit card, this field will contain the last four digits of the card number used. Payments completed using ApplePay will return last four digits of the Device Primary Account Number (DPAN) associated to the transaction. card_bin : string minLength: 6 maxLength: 8 description: For all payments completed using a credit card, this field will contain the Bank Identification Number (BIN) of the card used. The field will be set to either the first six or first eight digits of the card PAN. Payments completed using ApplePay will return the first six digits of the Device Primary Account Number (DPAN) associated to the transaction. This field will not be returned for credit card transactions processed using a Processor Token. cvd_result : integer description: Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided eci : integer description: The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead. address_match : integer description: Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match postal_result : integer description: Result of postal verification. 0 if the postal_code parameter does does not match the customers address records or if AVS was not processed for the transaction. 1 if the postal_code parameter matches the consumers address records at the issuing bank. avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description: A unique avs response code. For a description of each code see http://dev.na.bambora.com. message : string description: Message containing details of the avs status. Corresponding to each avs_id, there is an avs_message describing the status of address verification service. For example If avs_id = 5 then avs_message = Invalid AVS Response. processed : boolean description: Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed. } processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description: The payment token. reporting_token : string maxLength: 23 description: Token used for reporting. status : string Enum (2) success fail description: Status of the token. source : string minLength: 4 maxLength: 12 description: This will contain the name of the processor that is hosting the tokenization feature. source_data : SourceData { This will contain processor specific data related to the tokenization feature returned for informational use only. td_token_status : string minLength: 1 maxLength: 1 description: This field is returned only on response message and it will indicate the status of generating the PT and/or RT tokens. Valid values are: * 0 = successful – PT and/or RT were generated * 1 = PT token could not be generated * 2 = RT token could not be generated * 3 = PT and RT tokens could not be generated * 4 = Invalid instance value * 5 = PT not able to detokenize } } cavv_result : string description: Result code returned back from performing the 3D Secure Code validation. status_id : integer Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description. status : string Enum (4) 1 2 3 4 description: Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed error_id : integer Enum (3) 1 2 3 description: Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description. error : string Enum (3) 1 2 3 description: Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error } details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description: Transaction ID approved : integer description: Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved. message_id : integer maxLength: 3 description: Payment response code message : string maxLength: 256 description: Message containing information about the transactions status auth_code : string maxLength: 32 description: Auth Code trans_date : string description: The date it was created '2015-04-22T10:03:19.323-07:00' order_number : string default: Transaction Id maxLength: 32 description: Order number type : string Enum (6) P R VP VR PA PAC description: Payment transaction type amount : number format: double description: A decimal value in dollars. Uses up to two decimal places. cvd_id : integer maxLength: 2 description: CVD Response ID } }

Response Schema Definitions

PaymentProfileResponse { code : integer format: int32 maxLength: 2 description:

Code

message : string maxLength: 64 description:

Message containing contextual information about the response

customer_code : string maxLength: 32 description:

Unique payment profile ID

status : string description:

characters(1)

last_transaction : string format: date-time maxLength: 24 description:

date and time of last transaction

modified_date : string format: date-time maxLength: 24 description:

date and time the profile was last modified

language : string maxLength: 3 description:

Language

velocity_group : string profile_group : string account_ref : string card : GetProfileDefaultCard { name : string maxLength: 64 description:

cardholder name

number : string maxLength: 20 description:

masked credit card number

expiry_month : string default: 02 maxLength: 2 description:

eg. 02 for February.

expiry_year : string default: 17 maxLength: 2 description:

eg. 17 for 2017.

card_type : string Enum (5) AM DI JB MC NN'VI maxLength: 2 description:

The type of card associated with the profile. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa

} billing : Address { name : string maxLength: 64 description:

Name of the person/business

address_line1 : string maxLength: 64 description:

Street address

address_line2 : string maxLength: 64 description:

Additional address information(eg; suite number, apartment number, etc)

city : string maxLength: 32 description:

The city

province : string description:

characters (2)

Valid ISO 3166-1 country code

postal_code : string maxLength: 16 description:

Postal/Zip code

phone_number : string pattern: ^\d{1,20}$ description:

Phone number

email_address : string maxLength: 64 description:

Email Address

} custom : Custom { ref1 : string maxLength: 256 description:

custom reference field 1

ref2 : string maxLength: 256 description:

custom reference field 2

ref3 : string maxLength: 256 description:

custom reference field 3

ref4 : string maxLength: 256 description:

custom reference field 4

ref5 : string maxLength: 256 description:

custom reference field 5

} }

ErrorResponse { code : integer format: int32 category : integer format: int32 message : string reference : string description:

Not used. Always returns an empty string.

card : CardPurchaseResponse { card_type : string Enum (8) AM DI JB MC NN VI PV MD maxLength: 2 description:

The type of card used in the transaction. AM = American Express, DI = Diners, JB = JCB, MC = MasterCard, NN = Discover, VI = Visa, PV = Visa Debit, MD = Debit Mastercard

last_four : string maxLength: 4 description:

card_bin : string minLength: 6 maxLength: 8 description:

cvd_result : integer description:

Result of CVD verification. 1=CVD Match, 2=CVD Mismatch, 3=CVD Not Verified, 4=CVD Should have been present, 5=CVD Issuer unable to process request, 6=CVD Not Provided

eci : integer description:

The electronic commerce indicator (ECI) returned back in the transaction response. NOTE: No longer returned for 3DS 2.0, please see status_id instead.

address_match : integer description:

Result of Address verification. 0 if Adddress Verification Service(AVS) is disabled or AVS fails. 1 if AVS is enabled and address and postal/zip code match

postal_result : integer description:

avs : AvsResponse { id : string Enum (20) 0 5 9 A B C D E G I M N P R S U W X Y Z description:

A unique avs response code. For a description of each code see http://dev.na.bambora.com.

message : string description:

processed : boolean description:

Is true if the issuing bank has successfully processed an AVS check on the transaction. Is false if no AVS check was performed.

} processor_token : ProcessorTokenResponse { Token information generated from card request, or what was used to submit payment. payment_token : string minLength: 15 maxLength: 19 description:

The payment token.

reporting_token : string maxLength: 23 description:

Token used for reporting.

status : string Enum (2) success fail description:

Status of the token.

source : string minLength: 4 maxLength: 12 description:

This will contain the name of the processor that is hosting the tokenization feature.

} } cavv_result : string description:

Result code returned back from performing the 3D Secure Code validation.

status_id : integer Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. Set to a value of 1-4, see status for a text description.

status : string Enum (4) 1 2 3 4 description:

Status/result of a 3DS 2 transaction. 1 = Authenticated, 2 = Attempted, 3 = Non participating, 4 = Failed

error_id : integer Enum (3) 1 2 3 description:

Returned if status is 'Failed'. Set to a value of 1-3, see error for a text description.

error : string Enum (3) 1 2 3 description:

Returned if status is 'Failed'. 1 = 3D Secure service is not enabled, 2 = Service temporarily unavailble, 3 = Internal error

} details : array of Detail { field : string message : string } validation : CardValidation { id : string maxLength: 9 description:

Transaction ID

approved : integer description:

Approval status of payment transaction. 0 if the transaction is not approved. 1 if the transaction is approved.

message_id : integer maxLength: 3 description:

Payment response code

message : string maxLength: 256 description:

Message containing information about the transactions status

auth_code : string maxLength: 32 description:

Auth Code

trans_date : string description:

The date it was created '2015-04-22T10:03:19.323-07:00'

order_number : string default: Transaction Id maxLength: 32 description:

Order number

type : string Enum (6) P R VP VR PA PAC description:

Payment transaction type

amount : number format: double description:

A decimal value in dollars. Uses up to two decimal places.

cvd_id : integer maxLength: 2 description:

CVD Response ID

} }

PUT

/profiles/{profileId}

Update Profile

Description

Update an existing Payment Profile. For a single card profile supplying token or card data will work. For multi-card profiles you have to update the card data with the update and delete card endpoints.

Parameters

Required	In	Name	Description	Schema
true	path	profileId	The profile id. (aka CustomerCode)	string
true	body	updateProfileBody		ProfileBody