Jump to

• Request
• Response

Update a payment account

patch

/fscmRestApi/resources/11.13.18.05/publicSectorPaymentAccounts/{PaymentAccountId}

Request

Path Parameters

• PaymentAccountId(required): integer(int64)
  The unique identifier for a payment account.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• AccountDescription: string
  Title: Description

  Maximum Length: 360

  The description for the payment account.
• AccountNumber: string
  Title: Account Number

  Maximum Length: 30

  The payment account number.
• AccountStatus: string
  Title: Status

  Maximum Length: 1

  The status of the payment account.
• AccountType: string
  Maximum Length: 8

  The payment account type. The only valid value is Trust.
• LastActionBy: string
  Maximum Length: 64

  The user who last verified the payment account.
• LastActionDate: string (date-time)
  The date and time when the payment account was last verified.
• ProfileId: integer (int64)
  The registered public user profile that is associated with the payment account.
• VerificationStatus: string
  Title: Verification Status

  Maximum Length: 2

  The payment account verification status.

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"The registered public user profile that is associated with the payment account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AccountDescription":{
            "title":"Description",
            "maxLength":360,
            "type":"string",
            "description":"The description for the payment account.",
            "nullable":true
        },
        "AccountStatus":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "description":"The status of the payment account.",
            "nullable":false
        },
        "VerificationStatus":{
            "title":"Verification Status",
            "maxLength":2,
            "type":"string",
            "description":"The payment account verification status.",
            "nullable":true
        },
        "LastActionBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last verified the payment account.",
            "nullable":true
        },
        "AccountType":{
            "maxLength":8,
            "type":"string",
            "description":"The payment account type. The only valid value is Trust.",
            "nullable":false
        },
        "LastActionDate":{
            "type":"string",
            "description":"The date and time when the payment account was last verified.",
            "format":"date-time",
            "nullable":true
        },
        "AccountNumber":{
            "title":"Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The payment account number.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorPaymentAccounts-item-response

Type: object

Show Source

• AccountDescription: string
  Title: Description

  Maximum Length: 360

  The description for the payment account.
• AccountNumber: string
  Title: Account Number

  Maximum Length: 30

  The payment account number.
• AccountStatus: string
  Title: Status

  Maximum Length: 1

  The status of the payment account.
• AccountType: string
  Maximum Length: 8

  The payment account type. The only valid value is Trust.
• LastActionBy: string
  Maximum Length: 64

  The user who last verified the payment account.
• LastActionDate: string (date-time)
  The date and time when the payment account was last verified.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentAccountId: integer (int64)
  The unique identifier for a payment account.
• ProfileId: integer (int64)
  The registered public user profile that is associated with the payment account.
• VerificationStatus: string
  Title: Verification Status

  Maximum Length: 2

  The payment account verification status.

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"The registered public user profile that is associated with the payment account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountDescription":{
            "title":"Description",
            "maxLength":360,
            "type":"string",
            "description":"The description for the payment account.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountStatus":{
            "title":"Status",
            "maxLength":1,
            "type":"string",
            "description":"The status of the payment account.",
            "nullable":false,
            "x-queryable":true
        },
        "VerificationStatus":{
            "title":"Verification Status",
            "maxLength":2,
            "type":"string",
            "description":"The payment account verification status.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentAccountId":{
            "type":"integer",
            "description":"The unique identifier for a payment account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastActionBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last verified the payment account.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountType":{
            "maxLength":8,
            "type":"string",
            "description":"The payment account type. The only valid value is Trust.",
            "nullable":false,
            "x-queryable":true
        },
        "LastActionDate":{
            "type":"string",
            "description":"The date and time when the payment account was last verified.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "title":"Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The payment account number.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top