Skip to main content

QBO Payments

Script: New Credit Card Card Charge Window​

Description

Opens a New Window to allow a user to enter and charge a credit card. This script doesn't return any results. The results of the charge are retrieved using Get Charge Result script, usually by using a "Handler Script"

FileMaker Script Folder Path​

/Modules/QBO Payments/Public/New Credit Card Card Charge Window

Parameters​

none

Success Return​

none given

Error Return​

none given

Meta Data
  • Modification Count: 23
  • TimeStamp: 2020-06-05 14:31:22

Script: Get Card Charge Result​

Description

Retrieves the results of the last charge performed by this user

FileMaker Script Folder Path​

/Modules/QBO Payments/Public/Get Card Charge Result

Parameters​

none

Success Return​

none given

Error Return​

none given

Meta Data
  • Modification Count: 11
  • TimeStamp: 2020-05-25 23:36:57

Script: New Bank Account Card Window​

Description

Opens a New Window to allow a user to enter and charge a Bank Account. This script doesn't return any results. The results of the charge are retrieved using Get Bank Account Charge Result script, usually by using a "Handler Script"

FileMaker Script Folder Path​

/Modules/QBO Payments/Public/New Bank Account Card Window

Parameters​

none

Success Return​

none given

Error Return​

none given

Meta Data
  • Modification Count: 24
  • TimeStamp: 2020-06-05 14:18:12

Script: Get Bank Account Charge Result​

Description

Retrieves the results of the last bank withdrawal performed by this user

FileMaker Script Folder Path​

/Modules/QBO Payments/Public/Get Bank Account Charge Result

Parameters​

none

Success Return​

none given

Error Return​

none given

Meta Data
  • Modification Count: 11
  • TimeStamp: 2020-06-05 14:18:22

Script: Charge Card ( {card, amount, currency} )​

Description

exchanges card details for a token then charges the card/rusing the token instead of the card

FileMaker Script Folder Path​

/Modules/QBO Payments/Public/Charge Card ( {card, amount, currency} )

Parameters​

TypeNameDescriptionOptionalDefault
objectparams
stringparams.amountAmount of the transaction. Valid values range 0.00 through 99999.99.
stringparams.currencyCodethree-letter ISO 4217 currency code representing the currency in which the charge was made.✅USD
objectparams.cardcard object
objectparams.contextcontext object
booleanparams.context.mobiletrue if the charge occurs on a mobile device
booleanparams.context.isEcommercetrue if it is a web Charge

Success Return​

[
  {
    "type": "object",
    "name": "response",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "string",
    "name": "response.created",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "string",
    "name": "response.amount",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "string",
    "name": "response.token",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "string",
    "name": "response.id",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "string",
    "name": "authCode.id",
    "description": "",
    "optional": false,
    "default": ""
  }
]

Error Return​

none given

Meta Data
  • Modification Count: 44
  • TimeStamp: 2020-05-25 23:36:57

Script: Debit Bank Account ( { bankaccount, amount, paymentMode})​

Description

Debit a Bank Account

FileMaker Script Folder Path​

/Modules/QBO Payments/Public/Debit Bank Account ( { bankaccount, amount, paymentMode})

Parameters​

TypeNameDescriptionOptionalDefault
objectparams
stringparams.amount
stringparams.bankaccount.accountNumber
stringparams.bankaccount.accountType
stringparams.bankaccount.name
stringparams.bankaccount.phone
stringparams.bankaccount.routingNumber
stringparams.checkNumber✅
stringparams.context.deviceInfo.id✅
stringparams.context.deviceInfo.ipAddress✅
stringparams.context.deviceInfo.latitude✅
stringparams.context.deviceInfo.longitude✅
stringparams.context.deviceInfo.macAddress✅
stringparams.context.deviceInfo.phoneNumber✅
stringparams.context.deviceInfo.type✅
stringparams.description✅
stringparams.paymentMode- This is also known as the SEC Code. Valid options include: WEB —Internet-initiated entry mode, used for internet transactions.

Success Return​

[
  {
    "type": "object",
    "name": "response",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "string",
    "name": "response.created",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "string",
    "name": "response.amount",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "string",
    "name": "response.status",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "string",
    "name": "response.authCode",
    "description": "",
    "optional": false,
    "default": ""
  }
]

Error Return​

none given

Meta Data
  • Modification Count: 29
  • TimeStamp: 2020-05-25 23:36:57

Script: Create Card Token ( {card} )​

Description

exchanges card details for a token on Intuit Servers/ruse the token instead of the card

FileMaker Script Folder Path​

/Modules/QBO Payments/Public/Create Card Token ( {card} )

Parameters​

TypeNameDescriptionOptionalDefault
objectcard
stringcard.expYear
stringcard.expMonth
stringcard.cvc
stringcard.number
objectcard.address✅
stringcard.address.region✅
stringcard.address.postalCode✅
stringcard.address.streetAddress✅
stringcard.address.country✅
stringcard.address.city✅
stringcard.name✅

Success Return​

[
  {
    "type": "object",
    "name": "response",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "string",
    "name": "value",
    "description": " the token value",
    "optional": false,
    "default": ""
  }
]

Error Return​

none given

Meta Data
  • Modification Count: 39
  • TimeStamp: 2020-05-25 23:36:55

Script: Create Bank Account Token ( {bank} )​

Description

Create bank account token/rexchanges bank account details for a token on Intuit Servers/ruse the token instead of the bank account

FileMaker Script Folder Path​

/Modules/QBO Payments/Public/Create Bank Account Token ( {bank} )

Parameters​

TypeNameDescriptionOptionalDefault
objectbankAccount
stringbankAccount.accountNumber- minimum 4 characters,
stringbankAccount.accountType
stringbankAccount.name- The name of the bank account holder.
stringbankAccount.phone- A phone number associated with the account. Must be 10 digits
stringbankAccount.routingNumber- exactly 9 characters The bank routing number.

Success Return​

[
  {
    "type": "object",
    "name": "response",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "string",
    "name": "value",
    "description": "- the token value",
    "optional": false,
    "default": ""
  }
]

Error Return​

[
  {
    "type": "object",
    "name": "error",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "number",
    "name": "error.errorCode",
    "description": "",
    "optional": false,
    "default": ""
  },
  {
    "type": "...",
    "name": "",
    "description": "",
    "optional": false,
    "default": ""
  }
]
Meta Data
  • Modification Count: 42
  • TimeStamp: 2020-06-05 14:19:20

Script: Charge Card Token ( {chargeData })​

Description

none

FileMaker Script Folder Path​

/Modules/QBO Payments/Public/Charge Card Token ( {chargeData })

Parameters​

TypeNameDescriptionOptionalDefault
objectdata
stringdata.amountAmount of the transaction. Valid values range 0.00 through 99999.99.
stringdata.tokenOpaque representation of the credit card associated with this charge
stringdata.currencyThree-letter ISO 4217 currency code representing the currency in which the charge was made. ✅USD

Success Return​

none given

Error Return​

none given

Meta Data
  • Modification Count: 23
  • TimeStamp: 2020-05-25 23:36:55

Script: Charge Bank Account ( {chargeData} )​

Description

none

FileMaker Script Folder Path​

/Modules/QBO Payments/Public/Charge Bank Account ( {chargeData} )

Parameters​

TypeNameDescriptionOptionalDefault
objectdata
stringdata.amountAmount of the transaction. Valid values range 0.00 through 99999.99.
stringdata.tokenOpaque representation of the credit card associated with this charge
stringdata.paymentMode- the payment mode. This is also known as the SEC Code. Valid options include: WEB—Internet-initiated entry mode, used for internet transactions.

Success Return​

none given

Error Return​

none given

Meta Data
  • Modification Count: 22
  • TimeStamp: 2020-06-05 14:20:04

Script: Send Payment Request( {request} )​

Description

makes a request to the QBO Payments API/r#proxy2 replace/r/#/rapply defaults/rvalidate the JSON for required props, and logic

FileMaker Script Folder Path​

/Modules/QBO Payments/Public/Send Payment Request( {request} )

Parameters​

TypeNameDescriptionOptionalDefault
objectrequest
stringrequest.methodthe request method, either GET or POST✅GET
stringrequest.paththe part after https://api.intuit.com/quickbooks/v4/payments, ex. /tokens
stringrequest.datathe request body, required for POST
objectrequest.queryrequired for some operations✅

Success Return​

none given

Error Return​

none given

Meta Data
  • Modification Count: 29
  • TimeStamp: 2020-05-25 23:36:55