Bank of America · Schema

PaymentResponse

Payment transaction response

BankingCorporate BankingFinancePaymentsTreasuryCashProFortune 100

Properties

Name Type Description
paymentId string Unique payment identifier
clientReferenceId string Client-provided reference
status string Payment status
paymentType string Payment type
amount number
currency string
valueDate string
createdAt string
updatedAt string
statusMessage string Additional status information
View JSON Schema on GitHub

JSON Schema

paymentresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/bank-of-america/json-schema/paymentresponse-schema.json",
  "title": "PaymentResponse",
  "type": "object",
  "description": "Payment transaction response",
  "properties": {
    "paymentId": {
      "type": "string",
      "description": "Unique payment identifier"
    },
    "clientReferenceId": {
      "type": "string",
      "description": "Client-provided reference"
    },
    "status": {
      "type": "string",
      "description": "Payment status",
      "enum": [
        "pending",
        "processing",
        "completed",
        "rejected",
        "cancelled"
      ]
    },
    "paymentType": {
      "type": "string",
      "description": "Payment type"
    },
    "amount": {
      "type": "number",
      "format": "double"
    },
    "currency": {
      "type": "string"
    },
    "valueDate": {
      "type": "string",
      "format": "date"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "statusMessage": {
      "type": "string",
      "description": "Additional status information"
    }
  }
}