Jump to

• Request
• Response

Get Account AutoPay

get

/rest/apis/customer/v-model/accounts/{accountId}/autoPay/{autoPayId}

Request

Path Parameters

• accountId(required): string
  The Account ID is a system-assigned random number that stays with an account for life.

  Example:

  1589809032

• autoPayId(required): string
  Account Auto Pay ID is the unique, system-assigned identifier of the auto-pay record.

  Example:

  9162597011

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1CxAccAtPay

Type: object

Show Source

• _self: string
  _self
• autoPay: object autoPay

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "autoPay":{
            "type":"object",
            "properties":{
                "accountAutoPayId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Auto Pay ID"
                },
                "startDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Start Date indicates the date on which the alert starts showing for the account.",
                    "example":"2001-01-01"
                },
                "endDate":{
                    "type":"string",
                    "format":"date",
                    "description":"End Date indicates the date on which the alert stops showing for the account.",
                    "example":"2001-01-01"
                },
                "autoPaySource":{
                    "type":"object",
                    "properties":{
                        "autoPaySource":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Auto Pay Source"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "externalAccountId":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Use External Account ID to define the customer's bank account or credit card number.",
                    "example":"******789"
                },
                "expireDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Expires On date is used if the Auto Pay Source Code references a tender type that requires an expiration date.",
                    "example":"2001-01-01"
                },
                "entityName":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Name of the customer as it appears in the financial institution's system.",
                    "example":"Brazil, Mark"
                },
                "comments":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Comments can describe anything interesting / unusual about the automatic payment request."
                },
                "version":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"The version number is used for internal concurrency checks.",
                    "example":"2"
                },
                "autoPayMaxWithdrawalAmount":{
                    "type":"number",
                    "description":"Maximum Withdrawal Amount limits the amount of money that is automatically debited from an account.",
                    "example":"$50.00"
                },
                "autoPayMethod":{
                    "type":"string",
                    "enum":[
                        "C1DD",
                        "C1PA"
                    ],
                    "description":"Auto Pay Method defines whether the system should process automatic payments as Direct Debit or Payment Advice.\n* `C1DD` - Credit Card / Direct Debit,\n* `C1PA` - Payment Advice",
                    "example":"C1DD"
                }
            }
        }
    },
    "xml":{
        "name":"C1CxAccAtPay"
    }
}

Nested Schema : autoPay

Type: object

Show Source

• accountAutoPayId: string
  Maximum Length: 10

  Auto Pay ID
• autoPayMaxWithdrawalAmount: number
  Maximum Withdrawal Amount limits the amount of money that is automatically debited from an account.

  Example: $50.00
• autoPayMethod: string
  Allowed Values: [ "C1DD", "C1PA" ]

  Auto Pay Method defines whether the system should process automatic payments as Direct Debit or Payment Advice. * `C1DD` - Credit Card / Direct Debit, * `C1PA` - Payment Advice

  Example: C1DD
• autoPaySource: object autoPaySource
• comments: string
  Maximum Length: 254

  Comments can describe anything interesting / unusual about the automatic payment request.
• endDate: string (date)
  End Date indicates the date on which the alert stops showing for the account.

  Example: 2001-01-01
• entityName: string
  Maximum Length: 254

  Name of the customer as it appears in the financial institution's system.

  Example: Brazil, Mark
• expireDate: string (date)
  Expires On date is used if the Auto Pay Source Code references a tender type that requires an expiration date.

  Example: 2001-01-01
• externalAccountId: string
  Maximum Length: 50

  Use External Account ID to define the customer's bank account or credit card number.

  Example: ******789
• startDate: string (date)
  Start Date indicates the date on which the alert starts showing for the account.

  Example: 2001-01-01
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The version number is used for internal concurrency checks.

  Example: 2

{
    "type":"object",
    "properties":{
        "accountAutoPayId":{
            "type":"string",
            "maxLength":10,
            "description":"Auto Pay ID"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date indicates the date on which the alert starts showing for the account.",
            "example":"2001-01-01"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date indicates the date on which the alert stops showing for the account.",
            "example":"2001-01-01"
        },
        "autoPaySource":{
            "type":"object",
            "properties":{
                "autoPaySource":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Auto Pay Source"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "externalAccountId":{
            "type":"string",
            "maxLength":50,
            "description":"Use External Account ID to define the customer's bank account or credit card number.",
            "example":"******789"
        },
        "expireDate":{
            "type":"string",
            "format":"date",
            "description":"Expires On date is used if the Auto Pay Source Code references a tender type that requires an expiration date.",
            "example":"2001-01-01"
        },
        "entityName":{
            "type":"string",
            "maxLength":254,
            "description":"Name of the customer as it appears in the financial institution's system.",
            "example":"Brazil, Mark"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments can describe anything interesting / unusual about the automatic payment request."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The version number is used for internal concurrency checks.",
            "example":"2"
        },
        "autoPayMaxWithdrawalAmount":{
            "type":"number",
            "description":"Maximum Withdrawal Amount limits the amount of money that is automatically debited from an account.",
            "example":"$50.00"
        },
        "autoPayMethod":{
            "type":"string",
            "enum":[
                "C1DD",
                "C1PA"
            ],
            "description":"Auto Pay Method defines whether the system should process automatic payments as Direct Debit or Payment Advice.\n* `C1DD` - Credit Card / Direct Debit,\n* `C1PA` - Payment Advice",
            "example":"C1DD"
        }
    }
}

Nested Schema : autoPaySource

Type: object

Show Source

• _link: string
  _link
• autoPaySource: string
  Maximum Length: 12

  Auto Pay Source

{
    "type":"object",
    "properties":{
        "autoPaySource":{
            "type":"string",
            "maxLength":12,
            "description":"Auto Pay Source"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top