openapi: 3.2.0
info:
title: Program Miscellaneous API
version: '4.0'
servers:
- url: api-{corename}.{env}.gpsrv.com/intserv/4.0/
tags:
- name: Miscellaneous
paths:
/ping:
parameters:
- $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
post:
parameters: []
summary: Ping
tags:
- Miscellaneous
responses:
default:
content:
application/json:
schema:
type: object
properties:
status_code:
type:
- integer
- 'null'
format: int32
description: The response status code. May return a string for some statuses.
status:
type:
- string
- 'null'
description: The condition of a process or response
processing_time:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transaction_id:
type:
- string
- 'null'
description: An ID that represents an API transaction
provider_timestamp:
type:
- string
- 'null'
format: date-time
description: Store a related timestamp for reporting and troubleshooting purposes
provider_transaction_id:
type:
- string
- 'null'
description: Secondary transaction identifier (generated by a provider)
required:
- provider_timestamp
- provider_transaction_id
- transaction_id
system_timestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A system-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
response_data:
description: A structure for the response data. This endpoint does not return response data, so it will always be empty.
type: object
properties: {}
required:
- echo
- processing_time
- response_data
- rtoken
- status
- status_code
- system_timestamp
examples:
response:
value: "{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.022,\n \"response_data\": {},\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"A43ZQ5ZMR4XALONBW1G3\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-13 10:48:07\"\n}"
application/xml:
examples:
response:
value: "\n\n 0\n Success\n 0.049\n \n \n \n \n BE8Z7F78YSAS0EA1TBA8\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-13 12:42:45\n"
description: ''
description: 'Use the Ping endpoint to test API connectivity and permissions. Ping does not perform any functions on the system. Some use cases for Ping are:
* Testing access from an automated monitoring service
* Integrating with an API call to confirm assumptions and validate access'
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
transactionId:
type: string
minimum: 1
maximum: 60
description: 'Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 123e4567-e89b-12d3-a456-426614174000
required:
- transactionId
- apiLogin
- apiTransKey
- providerId
operationId: post_ping
/getPromontoryBankList:
parameters:
- $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
post:
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
status_code:
type:
- integer
- 'null'
format: int32
description: The response status code. May return a string for some statuses.
status:
type:
- string
- 'null'
description: The condition of a process or response
processing_time:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transaction_id:
type:
- string
- 'null'
description: An ID that represents an API transaction
provider_timestamp:
type:
- string
- 'null'
format: date-time
description: Store a related timestamp for reporting and troubleshooting purposes
provider_transaction_id:
type:
- string
- 'null'
description: Secondary transaction identifier (generated by a provider)
required:
- provider_timestamp
- provider_transaction_id
- transaction_id
system_timestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A system-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
response_data:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
balance:
type: object
description: A dictionary with keys being an account number (PRN) and values that are balance data objects
additionalProperties:
type: array
items:
description: Balance information
type: object
properties:
balance_date:
type: string
format: date-time
description: Timestamp when the balance was retrieved.
bank_name:
type: string
description: Name of the bank.
balance_amount:
type: number
format: float
description: Account balance
rate_tier_balance:
type: number
format: float
description: Rate-tier balance
accrued_interest:
type: number
format: float
description: Accrued interest amount
bank_number:
type: integer
format: int32
description: Bank number
rate_record_number:
type: integer
format: int32
description: Rate record number
required:
- accrued_interest
- balance_amount
- balance_date
- bank_name
- bank_number
- rate_record_number
- rate_tier_balance
required:
- balance
required:
- echo
- processing_time
- response_data
- rtoken
- status
- status_code
- system_timestamp
examples:
response:
value: "{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.424,\n \"response_data\": {\n \"balance\": {\n \"005461593202\": [\n {\n \"balance_date\": \"2025-07-15 00:00:00\",\n \"bank_name\": \"Test Bank 1\",\n \"balance_amount\": 1000,\n \"rate_tier_balance\": 0,\n \"accrued_interest\": 20,\n \"bank_number\": 1,\n \"rate_record_number\": 1\n }\n ],\n \"005461594202\": [\n {\n \"balance_date\": \"2025-07-15 00:00:00\",\n \"bank_name\": \"Test Bank 1\",\n \"balance_amount\": 1111,\n \"rate_tier_balance\": 0,\n \"accrued_interest\": 20,\n \"bank_number\": 1,\n \"rate_record_number\": 1\n }\n ]\n }\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"30f00606-2104-4b49-9ae1-5e715bd0fec3\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 15:55:26\"\n}"
application/xml:
examples:
response:
value: "\n\n 0\n Success\n 0.411\n \n \n \n \n 2025-07-15 00:00:00\n Test Bank 1\n 1000\n 0\n 20\n 1\n 1\n \n \n \n \n 2025-07-15 00:00:00\n Test Bank 1\n 1111\n 0\n 20\n 1\n 1\n \n \n \n \n \n \n \n d70e621a-94ca-4a85-9e77-e68db629bf5d\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 15:56:20\n"
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Your unique provider identifier from SoFi Tech Solutions.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 123e4567-e89b-12d3-a456-426614174000
accountNo:
type: string
pattern: ^.+$
description: 'The <> or <> of the account.
Pattern: PAN or PRN
Example: `"074103447228"`'
example: 074103447228
startDate:
type:
- string
- 'null'
format: date
description: 'The beginning date for the date range, either a date or a date-time.
Pattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss
Example: `"2016-01-01"`'
example: '2016-01-01'
endDate:
type:
- string
- 'null'
format: date
description: 'The end date for the date range, either a date or a date-time. Must be equal to or later than `startDate`.
Pattern: YYYY-MM-DD or YYYY-MM-DD hh:mm:ss
Example: `"2016-01-01"`'
example: '2016-01-01'
required:
- accountNo
- transactionId
- apiLogin
- apiTransKey
- providerId
tags:
- Miscellaneous
summary: Get Promontory Bank List
parameters: []
description: Use the Get Promontory Bank List endpoint to retrieve a list of Promontory Bank (now IntraFi) balances. This endpoint returns a list of the banks that are included in the deposit sweeps. Omit `startDate` and `endDate` parameters to retrieve a list of the most recent bank balances; otherwise, you receive all bank-balance records within the specified date range.
operationId: post_getpromontorybanklist
/getIngoCustomerId:
parameters:
- $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
post:
responses:
default:
description: ''
content:
application/json:
schema:
type: object
properties:
status_code:
type:
- integer
- 'null'
format: int32
description: The response status code. May return a string for some statuses.
status:
type:
- string
- 'null'
description: The condition of a process or response
processing_time:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transaction_id:
type:
- string
- 'null'
description: An ID that represents an API transaction
provider_timestamp:
type:
- string
- 'null'
format: date-time
description: Store a related timestamp for reporting and troubleshooting purposes
provider_transaction_id:
type:
- string
- 'null'
description: Secondary transaction identifier (generated by a provider)
required:
- provider_timestamp
- provider_transaction_id
- transaction_id
system_timestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A system-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
response_data:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
ingo_sso_token:
type: string
description: SSO Token used for SDK
ingo_customer_id:
type: string
description: ID for Ingo Money system
registered_card:
description: Card used to register with the Ingo system
type: object
properties:
status:
type: string
description: status of card registered on Ingo System
card_id:
type: integer
format: int32
description: card_id of card registered on Ingo System
card_number:
type: string
description: Masked card number of card registered on Ingo System
required:
- card_id
- card_number
- status
ingo_message:
type: string
description: Additional error messages from Ingo system
required:
- ingo_customer_id
- ingo_message
- ingo_sso_token
- registered_card
required:
- echo
- processing_time
- response_data
- rtoken
- status
- status_code
- system_timestamp
examples:
response:
value: "{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.022,\n \"response_data\": {\n \"ingo_customer_id\": \"xxxxxx\",\n \"ingo_sso_token\": \"xxxxxxxx\",\n \"registered_card\": {\n \"card_number\": \"xxxxxxxxx\",\n \"card_id\": \"xxxxxxxxx\",\n \"status\": \"xxxxxxxxx\"\n }\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"5ZMBW1G3R4ZQONAXAL34\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-14 10:45:17\"\n}"
application/xml:
examples:
response:
value: "\n\n 0\n Success\n 2025-07-14 10:45:17\n \n xxxxxx\n xxxxxxxx\n \n xxxxxxxxx\n xxxxxxxxx\n xxxxxxxxx\n \n \n 0.407\n \n QBW3R4ZM34NA1GLOXA5Z\n \n \n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n"
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Your unique provider identifier from SoFi Tech Solutions.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 123e4567-e89b-12d3-a456-426614174000
accountNo:
type: string
pattern: ^$|^([0-9]{12}|[0-9]{16})$
description: "The <> or <> of the account.\nPattern: PAN or PRN \nExample: `\"074103447228\"`"
example: 074103447228
mobileDeviceId:
type: string
minimum: 1
maximum: 255
description: 'Unique identifier for a cardholder''s device using the Ingo SDK. For mobile apps.
Pattern: 1–255 characters
Example: `"123456789009876"`'
example: '123456789009876'
required:
- accountNo
- mobileDeviceId
- transactionId
- apiLogin
- apiTransKey
- providerId
tags:
- Miscellaneous
summary: Get Ingo Customer ID
parameters: []
description: Use the Get Ingo Customer ID to retrieve customer identity information from third-party provider Ingo Money. Use the Ingo customer ID as needed.
operationId: post_getingocustomerid
/getCallStatus:
parameters:
- $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
post:
parameters: []
summary: Get Call Status
tags:
- Miscellaneous
responses:
default:
content:
application/json:
schema:
type: object
properties:
status_code:
type:
- integer
- 'null'
format: int32
description: The response status code. May return a string for some statuses.
status:
type:
- string
- 'null'
description: The condition of a process or response
processing_time:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transaction_id:
type:
- string
- 'null'
description: An ID that represents an API transaction
provider_timestamp:
type:
- string
- 'null'
format: date-time
description: Store a related timestamp for reporting and troubleshooting purposes
provider_transaction_id:
type:
- string
- 'null'
description: Secondary transaction identifier (generated by a provider)
required:
- provider_timestamp
- provider_transaction_id
- transaction_id
system_timestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A system-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
response_data:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
request_transaction_id:
type: string
description: The transaction_id of the original request
api_calls:
type: array
description: List of API calls
items:
type: object
properties:
gal_trans_id:
type: string
description: An ID used for internal tracking of the transaction
result_trans_id:
type:
- string
- 'null'
description: An ID used for internal tracking of the transaction
status_code:
type:
- string
- 'null'
description: The status of the original request
in_timestamp:
type:
- string
- 'null'
format: date-time
description: The datetime the original request
rtoken:
type:
- string
- 'null'
description: An ID used for internal tracking of the transaction
required:
- gal_trans_id
- in_timestamp
- result_trans_id
- rtoken
- status_code
required:
- api_calls
- request_transaction_id
required:
- echo
- processing_time
- response_data
- rtoken
- status
- status_code
- system_timestamp
examples:
response:
value: "{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.361,\n \"response_data\": {\n \"request_transaction_id\": \"3542f69d-f950-44b5-8146-68b1f5090d0e\",\n \"api_calls\": [\n {\n \"gal_trans_id\": \"360\",\n \"result_trans_id\": \"123\",\n \"status_code\": \"0\",\n \"in_timestamp\": \"2025-07-15 15:47:24\",\n \"rtoken\": \"11fb8506-00af-4463-b5ca-367adaad5717\"\n }\n ]\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"ca9d046a-f8dd-4230-af0d-3b095ce29830\"\n },\n \"rtoken\": \"8cc16de0-5eda-4e2a-968e-3b08fce6f778\",\n \"system_timestamp\": \"2025-07-15 15:47:25\"\n}"
application/xml:
examples:
response:
value: "\n\n 0\n Success\n 0.364\n \n ec77f4ed-f83e-40a1-bf6d-5c4948ed83e7\n \n \n 362\n 123\n 0\n 2025-07-15 15:47:58\n 5c41b108-ac91-49e5-8e38-e5e7f7c6faec\n \n \n \n \n \n \n 5bff3e4a-7030-44c3-9f68-eeab8ac6a4b4\n \n 8cc16de0-5eda-4e2a-968e-3b08fce6f778\n 2025-07-15 15:47:58\n"
description: ''
description: 'Use the Get Call Status endpoint to retrieve the response code of a specified API call.
This endpoint will only return data for transactions that are less than 2 days old.'
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
transactionId:
type: string
minimum: 1
maximum: 60
description: 'Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 123e4567-e89b-12d3-a456-426614174000
requestTransactionId:
type: string
description: 'The `transactionId` of the request to retrieve.
Pattern: Max 60 characters
Example: `"9633aa94-4810-4ecc-9408-927049df0f8d"`'
example: 9633aa94-4810-4ecc-9408-927049df0f8d
requestMethodName:
type: string
description: 'The name of the endpoint to retrieve.
Pattern: Max 100 characters
Example: `"activateCard"`'
example: activateCard
required:
- requestMethodName
- requestTransactionId
- transactionId
- apiLogin
- apiTransKey
- providerId
operationId: post_getcallstatus
/getProductInfo:
parameters:
- $ref: '#/components/parameters/ResponseContentTypeHeaderParam'
post:
tags:
- Miscellaneous
parameters: []
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
apiLogin:
type: string
description: 'Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: `"AbC123-9999"`'
example: AbC123-9999
apiTransKey:
type: string
description: 'Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: `"4sb62fh6w4h7w34g"`'
example: 4sb62fh6w4h7w34g
providerId:
type: integer
format: int32
description: 'Your unique provider identifier from SoFi Tech Solutions.
Pattern: Max 10 digits
Example: `9999`'
example: 9999
transactionId:
type: string
minimum: 1
maximum: 60
description: 'Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: `"9845dk-39fdk3fj3-4483483478"`'
example: 123e4567-e89b-12d3-a456-426614174000
searchCriteria:
type: string
description: 'String containing the search criteria. Must be of the type specified in `searchCriteriaType`.
Pattern: Alphanumeric
Example: `"5544"`'
example: '5544'
searchCriteriaType:
type: integer
format: int32
enum:
- 1
- 2
description: 'Type of criteria in `searchCriteria`:
* `1` — Product ID
* `2` — Product name
Pattern: Integer
Example: `1`'
example: 1
required:
- searchCriteria
- searchCriteriaType
- transactionId
- apiLogin
- apiTransKey
- providerId
summary: Get Product Info
description: Use the Get Product Info endpoint to search existing products and retrieve some of the related > configurations.
responses:
default:
content:
application/json:
schema:
type: object
properties:
status_code:
type:
- integer
- 'null'
format: int32
description: The response status code. May return a string for some statuses.
status:
type:
- string
- 'null'
description: The condition of a process or response
processing_time:
type:
- number
- 'null'
format: float
description: The time elapsed in processing the transaction
echo:
description: A structure that contains transaction ID information
type:
- object
- 'null'
properties:
transaction_id:
type:
- string
- 'null'
description: An ID that represents an API transaction
provider_timestamp:
type:
- string
- 'null'
format: date-time
description: Store a related timestamp for reporting and troubleshooting purposes
provider_transaction_id:
type:
- string
- 'null'
description: Secondary transaction identifier (generated by a provider)
required:
- provider_timestamp
- provider_transaction_id
- transaction_id
system_timestamp:
type:
- string
- 'null'
format: date-time
description: A system generated timestamp
rtoken:
type:
- string
- 'null'
description: A system-generated ID used for tracking
errors:
type: array
description: A list of errors generated while the request was processed
items:
type: string
response_data:
description: A structure for the response data. It can be empty but usually will contain information.
type:
- object
- 'null'
properties:
products:
type: object
additionalProperties:
type: object
properties:
apy:
type: string
description: The annual percentage yield calculated from SAVIR, compounded interest daily. If this product supports tiered interest, this field returns the literal string from SAVIR.
intmx:
type:
- number
- 'null'
format: float
description: This field is not currently returned by this endpoint.
interest_tiers:
type: array
description: This object is not currently returned by this endpoint.
items:
type: object
properties:
tier_min_amt:
type: number
format: float
description: This field is not currently returned by this endpoint.
tier_max_amt:
type:
- number
- 'null'
format: float
description: This field is not currently returned by this endpoint.
interest_rate:
type: number
format: float
description: This field is not currently returned by this endpoint.
apy:
type: number
format: float
description: This field is not currently returned by this endpoint.
required:
- apy
- interest_rate
- tier_max_amt
- tier_min_amt
prod_id:
type: string
description: ID for the product
description:
type:
- string
- 'null'
description: Description of the product
base_bin:
type: string
description: The active base <> for the product
product_bin:
type: string
description: The active base BIN for the product
base_bins:
type:
- array
- 'null'
description: A list of base BINs for the product. Also shows which BINs are active.
items:
type: object
properties:
base_bin:
type: string
description: Base BIN
active:
type:
- string
- 'null'
description: 'Whether the base BIN is active: `Y` or `N`'
required:
- base_bin
hold_days:
type:
- integer
- 'null'
format: int32
description: Hold days for the product
max_pin_retries:
type:
- integer
- 'null'
format: int32
description: Maximum number of PIN retries
prog_id:
type:
- string
- 'null'
description: The program ID for the product
prog_name:
type:
- string
- 'null'
description: The name of the program
type:
type:
- string
- 'null'
description: Type of product
max_balance:
type:
- number
- 'null'
format: float
description: The max balance allowed
mcc_restrictions:
type: array
items:
type: object
properties:
range_start:
type:
- integer
- 'null'
format: int32
description: Starting MCC for the range to deny
range_end:
type:
- integer
- 'null'
format: int32
description: Ending MCC for the range to deny
online_only:
type:
- string
- 'null'
description: Whether this MCC restriction is applied to online transactions only
required:
- online_only
- range_end
- range_start
auth_limits:
type: array
items:
type: object
properties:
period:
type:
- string
- 'null'
description: The timespan that the authorization limit applies to. A combination of one or more digits followed by a "period" designator character, e.g., 15D is 15 days.
amount:
type: number
format: float
description: Amount of the limit
count:
type:
- integer
- 'null'
format: int32
description: Authorization count limit
category:
type:
- string
- 'null'
description: Category of the `auth_limit`
domestic_flag:
type:
- string
- 'null'
description: ' `Y` — Domestic only `N` — International only. `A` — All'
required:
- amount
- category
- domestic_flag
- period
required:
- auth_limits
- base_bin
- base_bins
- description
- hold_days
- max_balance
- max_pin_retries
- mcc_restrictions
- prod_id
- product_bin
- prog_id
- prog_name
- type
required:
- products
required:
- echo
- processing_time
- response_data
- rtoken
- status
- status_code
- system_timestamp
examples:
response:
value: "{\n \"status_code\": 0,\n \"status\": \"Success\",\n \"processing_time\": 0.113,\n \"response_data\": {\n \"products\": {\n \"5544\": {\n \"prod_id\": \"5544\",\n \"description\": \"MyProgram Digital First\",\n \"base_bin\": \"99991600\",\n \"product_bin\": \"99991600\",\n \"base_bins\": [\n {\n \"base_bin\": \"99991600\",\n \"active\": \"Y\"\n }\n ],\n \"hold_days\": \"3\",\n \"max_pin_retries\": \"3\",\n \"prog_id\": \"88888\",\n \"prog_name\": \"MyProgram\",\n \"type\": \"Personalized MasterCard\",\n \"max_balance\": 75000,\n \"mcc_restrictions\": [\n {\n \"range_start\": \"6010\",\n \"range_end\": \"6010\",\n \"online_only\": \"N\"\n },\n {\n \"range_start\": \"6051\",\n \"range_end\": \"6051\",\n \"online_only\": \"N\"\n }\n ],\n \"auth_limits\": [\n {\n \"period\": \"1D\",\n \"amount\": \"1515\",\n \"count\": null,\n \"category\": \"ATL ATM Daily WD Limit\",\n \"domestic_flag\": \"A\"\n },\n {\n \"period\": \"1M\",\n \"amount\": \"1500\",\n \"count\": null,\n \"category\": \"CBA Cash Back Monthly\",\n \"domestic_flag\": \"A\"\n },\n {\n \"period\": \"1M\",\n \"amount\": \"15000\",\n \"count\": null,\n \"category\": \"PCL Combine Monthly Limit\",\n \"domestic_flag\": \"A\"\n }\n ],\n \"apy\": \"0\"\n }\n }\n },\n \"echo\": {\n \"provider_transaction_id\": \"\",\n \"provider_timestamp\": null,\n \"transaction_id\": \"b51bc523-0983-4118-94e6-5efbd612d87c\"\n },\n \"system_timestamp\": \"2024-06-10 13:13:34\",\n \"rtoken\": \"466108a9-b887-422b-8edb-c1eaa9ceb96d\"\n}"
application/xml:
examples:
response:
value: "\n \n 0\n Success\n 0.113\n \n \n <5544>\n 5544\n MyProgram Digital First\n 99991600\n 99991600\n \n 99991600\n Y\n \n 3\n 3\n 88888\n MyProgram\n Personalized MasterCard\n 75000\n \n 6010\n 6010\n N\n \n \n 6051\n 6051\n N\n \n \n 1D\n 1515\n \n ATL ATM Daily WD Limit\n A\n \n \n 1M\n 1500\n \n CBA Cash Back Monthly\n A\n \n \n 1M\n 15000\n \n PCL Combine Monthly Limit\n A\n \n 0\n 5544>\n \n \n \n \n \n b51bc523-0983-4118-94e6-5efbd612d87c\n \n 2024-06-10 13:13:34\n 466108a9-b887-422b-8edb-c1eaa9ceb96d\n \n"
description: ''
operationId: post_getproductinfo
components:
parameters:
ResponseContentTypeHeaderParam:
name: response-content-type
in: header
description: Use this header instead of the standard `accept` header to specify the response format.
schema:
type: string
enum:
- xml
- json
default: json
x-readme:
samples-languages:
- curl
- python
- node
- java
- go
- ruby
- javascript
explorer-enabled: true
proxy-enabled: true