openapi: 3.2.0
info:
  title: Jp Morgan Chase Payments API
  version: '1.0'
  description: 'Operations tagged Payments across 2 of this provider''s published API definitions: jp-morgan-chase-global-payments-openapi.yml, jp-morgan-chase-payment-initiation-service-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.payments.jpmorgan.com/payment/v2
  description: PRODUCTION - MTLS
- url: https://api-mock.payments.jpmorgan.com/payment/v2
  description: MOCK
- url: https://api-sandbox.payments.jpmorgan.com/payment/v2
  description: CLIENT TESTING - MTLS
- url: https://apigateway.jpmorgan.com/tsapi/paybybank/v2
  description: PRODUCTION
- url: https://apigatewayqaf.jpmorgan.com/tsapi/paybybank/v2
  description: CLIENT TESTING
- url: https://apigatewaycat.jpmorgan.com/tsapi/paybybank/v2
  description: CLIENT TESTING
- url: https://api-mock.payments.jpmorgan.com/tsapi/paybybank/v2
  description: MOCK
tags:
- name: Payments
  description: API to initiate payments
paths:
  /payments:
    summary: Payments Initiation API
    description: Initiate and retrieve payments
    post:
      summary: Initiate Payments
      description: 'Initiate Payments


        > Mock responses displayed with JOSE are signed and encrypted and may not be human-readable. Use the JSON toggle to view the underlying mock payload data in a readable format.

        >

        > Payment Initiation requests must use the `Content-Type: application/jose` header'
      tags:
      - Payments
      operationId: createPayment
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
      - $ref: '#/components/parameters/RequestId'
      requestBody:
        $ref: '#/components/requestBodies/InitiatePayment'
      responses:
        '200':
          $ref: '#/components/responses/200-PaymentInitiationDuplicate'
        '201':
          $ref: '#/components/responses/201-PaymentInitiationCreated'
        '400':
          $ref: '#/components/responses/400-BadRequest'
        '401':
          $ref: '#/components/responses/401-UnAuthorized'
        '403':
          $ref: '#/components/responses/403-Forbidden'
        '422':
          $ref: '#/components/responses/422-UnprocessableEntity'
        '503':
          $ref: '#/components/responses/503-ServiceUnavailable'
      callbacks:
        paymentEvent:
          x-tags:
          - Webhooks
          webhooks:
            post:
              summary: Payment Webhooks
              operationId: publishWebhook
              requestBody:
                description: 'Payment Events


                  | type | description |

                  |---|---|

                  | Payment.`Accepted` | Payment instruction initiation has been accepted and will be processed |

                  | Payment.`Canceled` | Payment instruction has been canceled by instruction of the customer |

                  | Payment.`Rejected` | Payment Instruction has been rejected |

                  | Payment.`Completed` | Payment Instruction has been fully processed |

                  | Payment.`Returned` | Payment Returned |

                  | Payment.`Processing` | Payment Processing |

                  '
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/Webhook'
                    examples:
                      Alternate Payments - Push To Card Status:
                        $ref: '#/components/examples/AlternateP2CPaymentStatusWebhook-CE'
                      Alternate Payments - Push To Card - TP3 Status:
                        $ref: '#/components/examples/AlternateP2CTP3PaymentStatusWebhook-CE'
                      Alternate Payments - Push To Card - TP3 Rejected Status:
                        $ref: '#/components/examples/AlternateP2CRejectedStatusWebhook-CE'
                      Alternate Payments - Kinexys Digital Payments (DDA to BDA) Completed Status:
                        $ref: '#/components/examples/AlternateKinexysDigitalPaymentsDDAtoBDAStatusWebhook-CE'
                      ACH Batch:
                        $ref: '#/components/examples/ACHBatch-CE'
              responses:
                '204':
                  description: Success - No Content
    get:
      summary: Query Payments by `endToEndId` or `paymentId`
      description: "<!-- theme: success -->\n\n> Query Payments by `endToEndId` or `paymentId`. \n\n> Optionally, specify `view=FULL` to get an expanded representation for each payment."
      tags:
      - Payments
      operationId: getPayments
      parameters:
      - $ref: '#/components/parameters/EndToEndId'
      - $ref: '#/components/parameters/PaymentIdQuery'
      - $ref: '#/components/parameters/View'
      - $ref: '#/components/parameters/PaymentType'
      - $ref: '#/components/parameters/ViewOnlyRequestId'
      responses:
        '200':
          $ref: '#/components/responses/200-PaymentQueryOK'
        '400':
          $ref: '#/components/responses/400-BadRequest'
        '401':
          $ref: '#/components/responses/401-UnAuthorized'
        '403':
          $ref: '#/components/responses/403-Forbidden'
        '404':
          $ref: '#/components/responses/404-NotFound'
        '503':
          $ref: '#/components/responses/503-ServiceUnavailable'
    servers:
    - url: https://api.payments.jpmorgan.com/payment/v2
      description: PRODUCTION - MTLS
    - url: https://api-mock.payments.jpmorgan.com/payment/v2
      description: MOCK
    - url: https://api-sandbox.payments.jpmorgan.com/payment/v2
      description: CLIENT TESTING - MTLS
  /payments/{paymentId}:
    get:
      summary: Retrieve Payment by `paymentId`
      description: "Retrieves a payment resource by providing the `paymentId`; \noptionally, specify `view=FULL` to get an expanded representation for the payment."
      operationId: getPayment
      tags:
      - Payments
      parameters:
      - $ref: '#/components/parameters/PaymentId'
      - $ref: '#/components/parameters/View'
      - $ref: '#/components/parameters/ViewOnlyRequestId'
      responses:
        '200':
          $ref: '#/components/responses/200-PaymentDetailOK'
        '400':
          $ref: '#/components/responses/400-BadRequest'
        '401':
          $ref: '#/components/responses/401-UnAuthorized'
        '403':
          $ref: '#/components/responses/403-Forbidden'
        '404':
          $ref: '#/components/responses/404-NotFound'
        '503':
          $ref: '#/components/responses/503-ServiceUnavailable'
    servers:
    - url: https://api.payments.jpmorgan.com/payment/v2
      description: PRODUCTION - MTLS
    - url: https://api-mock.payments.jpmorgan.com/payment/v2
      description: MOCK
    - url: https://api-sandbox.payments.jpmorgan.com/payment/v2
      description: CLIENT TESTING - MTLS
  /payments/{id}/acknowledge:
    post:
      summary: Acknowledge Payments
      description: Acknowledges the payment request that was previously setup.
      tags:
      - Payments
      operationId: acknowledgePayments
      parameters:
      - name: id
        in: path
        required: true
        description: A unique ID of the payment
        schema:
          $ref: '#/components/schemas/UniqueResourceIdentifier'
        examples:
          PaymentResponseGermanyRTP:
            value: a14a49b4-b21e-416e-ab8d-c0e57efbd2ea
      responses:
        '200':
          $ref: '#/components/responses/200-Acknowledged'
        '400':
          $ref: '#/components/responses/400-BadRequest-Non-State-Change'
        '401':
          $ref: '#/components/responses/401-Unauthorized'
        '403':
          $ref: '#/components/responses/403-Forbidden_2'
        '404':
          $ref: '#/components/responses/404-NotFound_2'
        '503':
          $ref: '#/components/responses/503-ServiceUnavailable_2'
    servers:
    - url: https://apigateway.jpmorgan.com/tsapi/paybybank/v2
      description: PRODUCTION
    - url: https://apigatewayqaf.jpmorgan.com/tsapi/paybybank/v2
      description: CLIENT TESTING
    - url: https://apigatewaycat.jpmorgan.com/tsapi/paybybank/v2
      description: CLIENT TESTING
    - url: https://api-mock.payments.jpmorgan.com/tsapi/paybybank/v2
      description: MOCK
  /payments/{id}:
    get:
      summary: Retrieve Payments
      description: Retrieves the details of the payment request by Id.
      tags:
      - Payments
      operationId: retrievePaymentsDetails
      parameters:
      - name: id
        in: path
        required: true
        description: A unique ID of the payment
        schema:
          $ref: '#/components/schemas/UniqueResourceIdentifier'
        examples:
          PaymentResponseGermanyRTP:
            value: a14a49b4-b21e-416e-ab8d-c0e57efbd2ea
      responses:
        '200':
          $ref: '#/components/responses/200-Successful'
        '400':
          $ref: '#/components/responses/400-BadRequest-Non-State-Change'
        '401':
          $ref: '#/components/responses/401-Unauthorized'
        '403':
          $ref: '#/components/responses/403-Forbidden_2'
        '404':
          $ref: '#/components/responses/404-NotFound_2'
        '503':
          $ref: '#/components/responses/503-ServiceUnavailable_2'
    servers:
    - url: https://apigateway.jpmorgan.com/tsapi/paybybank/v2
      description: PRODUCTION
    - url: https://apigatewayqaf.jpmorgan.com/tsapi/paybybank/v2
      description: CLIENT TESTING
    - url: https://apigatewaycat.jpmorgan.com/tsapi/paybybank/v2
      description: CLIENT TESTING
    - url: https://api-mock.payments.jpmorgan.com/tsapi/paybybank/v2
      description: MOCK
components:
  schemas:
    ChargesInformation:
      title: Charges Information
      description: Information regarding the charge bearer and the relevant charges
      type: object
      properties:
        chargeBearer:
          type: string
          enum:
          - CREDITOR
          - DEBTOR
          - SHARED
          description: Party bearing transaction fees
        value:
          $ref: '#/components/schemas/Value'
    UnstructuredInformation:
      type: object
      title: UnstructuredInformation
      description: Unstructured remittance information
      properties:
        text:
          type: string
          minLength: 1
          maxLength: 210
          description: "Maximum number of lines and characters supported per\nmarket/instrument :-\n\n| Market/Instrument             | Maximum length limits |\n|-------------------------------|-----------------------|\n| UK FPS         \t              | 1 line, 140 characters|\n| SEPA Instant                  | 1 line, 140 characters|\n|Singapore RTP                  | 1 line, 140 characters|\n| AUS RTP                       | 2 lines,140 characters|\n| HKG FPS                       | 1 line, 140 characters|\n| IND IMPS                      | 1 line, 140 characters|\n| Brazil RTP                   | 1 line, 140 characters|\n| Mexico RTP                    | 210 characters        |\n| Indonesia RTP                 | 1 line, 140 characters|\n| US RTP                        | 1 line, 140 characters|\n| Push To Card US and Push To Card CA | 1 line, 16 characters (Numbers, alphabets, SPACE and special chars  `-./,$@&amp;` allowed)                      \t|\n| Blockchain - Kinexys Digital Payments System  |1 line, 140 characters |\n| ACH US                        | 1 line, 80 characters |\n| ACH (BACS)                    | 1 line, 18 characters |\n| ACH (SEPA                     | 1 line, 140 characters|"
        valueType:
          type: string
          enum:
          - MARKET_PLACE_NAME
          - SERVICE_COUNTRY_CODE
          - YOUR_REFERENCE
          - TRAVEL_REASON
          - CARD_TRANSACTION_REFERENCE
          description: remittance information type.
    BirthDate:
      title: BirthDate
      type: object
      description: Date of Birth
      properties:
        birthDate:
          type: string
          format: date
          description: "Birth date in `YYYY-MM-DD` format eg. 1984-05-19. \n\n**ACH specific usage conditions:**\n  - When `birthDate` is provided, the country of birth becomes mandatory."
          example: '1984-05-19'
    OtherPaymentReferences:
      type: object
      title: OtherPaymentReferences
      description: Other Payment Reference Identifiers
      properties:
        relatedReferenceId:
          type: string
          minLength: 1
          description: Related reference Identifier, applicable for *ACH* and **WIRES** only.
        uetr:
          type: string
          minLength: 36
          maxLength: 36
          description: A Unique End-to-end Transaction Reference (commonly known as a UETR) is a string of 36 unique characters featured in all payment instruction messages carried over SWIFT.
    AdditionalContext:
      title: Additional Context
      type: array
      description: Additional details about the error based on a standard (e.g. ISO or Clearing codes)
      items:
        $ref: '#/components/schemas/StandardCodeContext'
      minItems: 1
      maxItems: 5
    PaymentDetails:
      title: PaymentDetails
      type: object
      description: A collection of payment details.
      properties:
        payments:
          type: array
          items:
            $ref: '#/components/schemas/PaymentDetail'
          minItems: 1
          maxItems: 25
    Event:
      title: Event notification
      description: Event Notification Data Common Component
      type: object
      required:
      - id
      - specversion
      - type
      - time
      - source
      - data
      properties:
        specversion:
          type: string
          description: 'The version of the CloudEvents specification which the event uses

            '
          default: '1.0'
        id:
          type: string
          description: Unique Event Identifier
        time:
          description: event occurrence timestamp. An RFC-3339 compliant date-time format.
          type: string
          format: date-time
        type:
          description: Type of event being published
          type: string
          example: Payment.Completed
        source:
          description: Identifies the context in which an event happened. Often this will include information such as the type of the event source, the organization publishing the event or the process that produced the event.
          type: string
          format: uri-reference
        dataschema:
          description: URI of the event data schema
          type: string
          format: uri
        data:
          description: 'Data is an arbitrary object, that represents an underlying data being delivered through event notification

            e.g Payment outcome, User onboarding outcome, Beneficiary screening outcome'
          type: object
          title: EventData
    SignedContent:
      title: SignedContent
      type: string
      pattern: ^[A-Za-z0-9_-]+\.([A-Za-z0-9_-]+)\.[A-Za-z0-9_-]+$
      description: "A JWS (JSON Web Signature) Compact Serialization string with an **attached** payload.\n\n**JWS is a [JOSE specification](https://jose.readthedocs.io/en/latest/) that defines a compact,\n  URL-safe means of representing signed content using JSON-based data structures.\n  It ensures that the sender's identity can be verified and that the content has not\n  been tampered with during transmission, providing non-repudiation of interactions\n  between parties.**\n\n**Structure**: `Base64URL(header).Base64URL(payload).Base64URL(signature)`\n\n- **Base64URL(header)** – JOSE header containing `alg` (e.g. RS256), `typ` (JOSE) and optionally `kid`\n- **Base64URL(payload)** – The Request/Response body JSON object, Base64URL-encoded\n- **Base64URL(signature)** – Digital signature computed over the ASCII bytes of header.`payload`\n\n## Attached Payloads\n\n  This API uses **attached** JWS signatures: the payload is embedded in the JWS itself \n  (the middle `payload` segment), and the resulting compact serialization string is \n  sent as the HTTP request/response body. **Detached** payloads (*where the payload \n  is transmitted separately from the JWS*) are not supported.\n\n## Signed Example\n\n<details>\n<summary>Signed Request Payload</summary>\n`eyJhbGciOiJSUzI1NiIsImtpZCI6IjEyMzQ1Njc4OTAiLCJ0eXAiOiJKT1NFIn0.\neyJyZXF1ZXN0ZWRFeGVjdXRpb25EYXRlIjoiMjAyNC0xMC0yMiIsInBheW1lbnRJZGVudGlmaWVycyI6\neyJlbmRUb0VuZElkIjoiVUtGUFNURVNUIn0sInZhbHVlIjp7ImN1cnJlbmN5IjoiR0JQIiwiYW1vdW50\nIjoiMS4wMSJ9LCJ0cmFuc2ZlclR5cGUiOiJDUkVESVQiLCJwYXltZW50VHlwZSI6IlJUUCIsImRlYnRv\nciI6eyJhY2NvdW50Ijp7ImFjY291bnROdW1iZXIiOiIxMjM0NTY3ODkwIn19LCJkZWJ0b3JBZ2VudCI6\neyJmaW5hbmNpYWxJbnN0aXR1dGlvbklkcyI6W3siaWQiOiJDSEFTR0IyTCIsImlkVHlwZSI6IkJJQyJ9\nXX0sImNyZWRpdG9yIjp7ImFjY291bnQiOnsiYWNjb3VudE51bWJlciI6Ijk4NzY1NDMyMSJ9LCJuYW1l\nIjoiR0IgVGVzdCBBY2Njb3VudCJ9LCJjcmVkaXRvckFnZW50Ijp7ImZpbmFuY2lhbEluc3RpdHV0aW9u\nSWRzIjpbeyJpZCI6IjA0MjkyMCIsImlkVHlwZSI6IkNMRUFSSU5HX1NZU1RFTV9JRCJ9XX19.\nSflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c`\n</details>\n\n \n<details>\n<summary>Signed Response Payload</summary>\n`eyJhbGciOiJSUzI1NiIsImtpZCI6IjEyMzQ1Njc4OTAiLCJ0eXAiOiJKT1NFIn0.\n  eyJwYXltZW50SWQiOiI5NTM2NDAxOC1iZTMyLTRjNzEtOTYxOC1mMWNlYmE3OGYyOGMiLCJwYXltZW50\n  U3RhdHVzIjoiQUNDRVBURUQiLCJwYXltZW50U3ViU3RhdHVzIjoiQUNDRVBURUQiLCJzdGF0dXNVcGRh\n  dGVkQXQiOiIyMDI2LTAzLTE3VDA5OjE3OjIzWiIsInJlcXVlc3RlZEV4ZWN1dGlvbkRhdGUiOiIyMDI0\n  LTEwLTIyIiwicGF5bWVudElkZW50aWZpZXJzIjp7ImVuZFRvRW5kSWQiOiJVS0ZQU1RFU1QifSwidHJh\n  bnNmZXJUeXBlIjoiQ1JFRElUIiwicGF5bWVudFR5cGUiOiJSVFAifQ.\n  SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c`\n</details>"
      example: REDACTED.JWT.TOKEN
    IndividualIdentification:
      type: object
      title: Individual Identification
      description: Individual Identification Schemes
      required:
      - individualIds
      properties:
        individualIds:
          type: array
          minItems: 1
          maxItems: 16
          items:
            $ref: '#/components/schemas/IndividualId'
    UnstructuredAddress:
      title: UnstructuredAddress
      type: array
      description: Unstructured Addresses
      minItems: 1
      maxItems: 7
      items:
        type: string
        minLength: 1
        maxLength: 70
    FxInformationReadOnly:
      title: FX Information
      description: Provides information on foreign exchange details
      type: object
      properties:
        exchangeRate:
          $ref: '#/components/schemas/RateDecimal'
        exchangeRateType:
          type: string
          minLength: 1
          maxLength: 20
          description: Specifies the type used to complete the currency exchange.
          example: SPOT
        rateId:
          type: string
          minLength: 1
          maxLength: 36
          description: Rate identifier
        contractId:
          type: string
          minLength: 1
          maxLength: 36
          description: Contract identifier
        appliedRate:
          $ref: '#/components/schemas/Decimal'
    UltimateParty:
      type: object
      title: UltimateParty
      description: The Ultimate Party (*Ultimate Creditor or Ultimate Debtor*)
      additionalProperties: false
      properties:
        partyId:
          $ref: '#/components/schemas/PartyId'
        name:
          type: string
          minLength: 1
          maxLength: 140
          description: "- Mandatory for US RTP and US FEDNOW\n- Mandatory for CA ACH\n- Maximum length constraints:\n    - Push To Card  - 25"
        account:
          $ref: '#/components/schemas/UltimateDebtorAccount'
        countriesOfNationality:
          type: array
          description: ISO 3166-1 alpha-2 Country Code representing the Nationality of an individual.
          items:
            $ref: '#/components/schemas/IsoCountryCode'
          minItems: 1
          maxItems: 5
        dateAndPlaceOfBirth:
          $ref: '#/components/schemas/DateAndPlaceOfBirth'
        countryOfResidence:
          $ref: '#/components/schemas/IsoCountryCode'
        postalAddress:
          $ref: '#/components/schemas/Address'
        contactDetails:
          $ref: '#/components/schemas/ContactDetails'
      example:
        partyId:
          individualIds:
          - individualId: '87654321'
        name: Aisha Khan
        postalAddress:
          addressType: BIZZ
          streetName: Fratton Park
          buildingNumber: '411'
          postalCode: PO48RA
          city: Portsmouth
          country: GB
          countrySubDivision: HAM
    Error:
      type: object
      title: Error
      description: Common Error Model
      properties:
        title:
          type: string
          title: Short humanly-readable title of the error.
          minLength: 1
          maxLength: 100
        httpStatus:
          type: integer
          format: int32
          default: 400
          minimum: 400
          maximum: 503
          title: HTTP Status Code
        traceId:
          type: string
          title: JPMC Assigned traced identifier
          minLength: 55
          maxLength: 128
        requestId:
          type: string
          title: The 'client originated' requestId
          minLength: 1
          maxLength: 128
        context:
          type: array
          title: Provides additional context and detail on the validation errors
          items:
            $ref: '#/components/schemas/ErrorContext'
          minItems: 1
          maxItems: 100
      required:
      - title
      readOnly: true
    AdditionalInstitutions:
      title: AdditionalInstitutions
      type: array
      description: 'Additional Institutions:

        - Applicable to UK RTP and Mexico RTP (foreign remittances)'
      minItems: 1
      maxItems: 10
      items:
        $ref: '#/components/schemas/AdditionalInstitution'
    TransferType:
      title: TransferType
      type: string
      enum:
      - CREDIT
      - DEBIT
      description: "Indicates the direction of the money movement. The transaction is either a `credit` push transfer or a direct `debit` pull transfer.\n**Supported values**:-\n  | Market/Instrument    | Transfer type \t |\n  |----------------------|-----------------|\n  | Credit Transfers     |     CREDIT      |\n  | Direct-Debits        |     DEBIT       |"
    CreditorPrivateId:
      type: object
      title: Creditor Private Identification
      description: Private Party Identification of a Creditor within the context of a mandate amendment
      properties:
        partyId:
          $ref: '#/components/schemas/PartyId'
        name:
          type: string
          minLength: 1
          maxLength: 140
          description: Name of the party
      example:
        partyId:
          organizationIds:
          - organizationId: '123456'
            schemeName:
              proprietary: JPMCOID
        name: ABAC Plc
    SettlementAccountDetails:
      type: object
      description: Settlement Account Details
      title: Settlement Account Details
      required:
      - accountNumber
      properties:
        accountNumber:
          type: string
          minLength: 1
          maxLength: 128
        accountType:
          $ref: '#/components/schemas/DebtorAccountType'
        accountCurrency:
          $ref: '#/components/schemas/IsoCurrencyCode'
        companyId:
          type: string
          minLength: 1
          maxLength: 35
    EndToEndId:
      type: string
      title: EndToEndId
      minLength: 1
      maxLength: 128
      x-faker: random.uuid
      description: 'Customer assigned Unique identifier to unambiguously identify the Payment transaction.

        This identification is passed on, unchanged, throughout the entire end-to-end chain.'
      example: AD202109311354152
    Purpose:
      type: object
      title: Purpose
      description: "This field is mandatory for Singapore Faster Payments. Underlying reason for the payment transaction, eg., a charity payment, or  a commercial agreement between the creditor and the debtor. \n\n**Not applicable for** :-\n - UK FPS\n - Push To Card"
      properties:
        code:
          type: string
          minLength: 1
          maxLength: 4
          description: Purpose of the payment in coded form
        proprietary:
          type: string
          minLength: 2
          maxLength: 24
          description: Purpose of the payment in proprietary form
      minProperties: 1
      maxProperties: 1
    PaymentIdentifiers:
      type: object
      title: PaymentIdentifiers
      description: Identifiers associated with the Payment Instruction throughout its lifecycle.
      required:
      - endToEndId
      properties:
        endToEndId:
          $ref: '#/components/schemas/EndToEndId'
        otherPaymentReferences:
          $ref: '#/components/schemas/OtherPaymentReferences'
    PaymentType:
      title: PaymentType
      type: string
      enum:
      - RTP
      - WIRE
      - ACH
      - CARD
      - VENMO
      - PAYPAL
      - BLOCKCHAIN
      - INTERAC
      - ZELLE
      - DEFAULT
      default: DEFAULT
      description: "The type of payment being initiated\n      \n**Use**:\n  - **RTP** for Realtime Payments\n  - **ACH** for  ACH Payments\n  - **BLOCKCHAIN** for payments via Kinexys Digital Payments\n  - **WIRE** for Wire Payments\n  - **CARD** for Push to Card Payments\n  - **VENMO** for Venmo payments\n  - **PAYPAL** for Paypal payments\n  - **INTERAC** for Interac Payments\n  - **ZELLE** for Zelle Payments\n   - **DEFAULT** for other payments."
    FinancialInstitutionIdType:
      type: string
      enum:
      - BIC
      - USABA
      - SORT_CODE
      - CLEARING_SYSTEM_ID
    View:
      type: string
      enum:
      - SUMMARY
      - FULL
      default: SUMMARY
    PaymentReadOnlyView:
      type: object
      title: Payment
      description: Representation of the payment instruction.
      required:
      - requestedExecutionDate
      - paymentIdentifiers
      - transferType
      - paymentType
      properties:
        requestedExecutionDate:
          type: string
          format: date
          description: "Requested execution date of the payment instruction (e.g. value date) in ISO 8601 `yyyy-mm-dd` format,\n must be either the current or future date.\n- This is the value date for EMEA ACH Payments "
        paymentIdentifiers:
          $ref: '#/components/schemas/PaymentIdentifiersReadOnly'
        value:
          $ref: '#/components/schemas/PaymentValue'
        transferType:
          $ref: '#/components/schemas/TransferType'
        paymentType:
          $ref: '#/components/schemas/PaymentType'
        paymentTypeInformation:
          $ref: '#/components/schemas/PaymentTypeInformation'
        debtor:
          $ref: '#/components/schemas/Party'
        debtorAgent:
          $ref: '#/components/schemas/DebtorAgent'
        creditor:
          $ref: '#/components/schemas/Party'
        creditorAgent:
          $ref: '#/components/schemas/CreditorAgent'
        additionalParties:
          $ref: '#/components/schemas/AdditionalParties'
        paymentPurpose:
          $ref: '#/components/schemas/PaymentPurpose'
        remittanceInformation:
          $ref: '#/components/schemas/RemittanceInformation'
        taxInformation:
          $ref: '#/components/schemas/TaxInformation'
        regulatoryReporting:
          $ref: '#/components/schemas/RegulatoryReporting'
        settlementInformation:
          $ref: '#/components/schemas/SettlementInformation'
        mandateInformation:
          $ref: '#/components/schemas/MandateInformation'
        fxInformation:
          $ref: '#/components/schemas/FxInformationReadOnly'
        secureVerification:
          type: array
          description: Applies only for Interac proxy payments
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/SecureVerification'
        paymentExpiresAt:
          type: string
          format: date-time
          description: Applies only for Interac proxy Payments. Format expected - ISO 8601 `YYYY-MM-DDThh:mm:ss`+/-time offset to UTC
        chargesInformation:
          $ref: '#/components/schemas/ChargesInformation'
    RegulatoryReporting:
      title: RegulatoryReporting
      type: object
      description: Regulatory reporting information
      minProperties: 1
      properties:
        authority:
          type: object
          title: Authority
          description: Capture details about the authority requiring the regulatory reporting information
          properties:
            name:
              type: string
              description: Name of the authority
              minLength: 1
              maxLength: 140
            country:
              type: string
              description: ISO 3166-1 Alpha-2 Country Code
              minLength: 2
              maxLength: 2
              pattern: ^[A-Z]{2}$
              example: AU
        details:
          type: array
          description: Detailed information for the regulatory reporting
          items:
            type: object
            properties:
              type:
                type: string
                description: Type of information supplied
                minLength: 1
                maxLength: 35
              country:
                type: string
                description: ISO 3166-1 Alpha-2 Country Code
                minLength: 2
                maxLength: 2
                pattern: ^[A-Z]{2}$
                example: AU
              code:
                type: string
                description: Specifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form
                minLength: 1
                maxLength: 10
              additionalInfo:
                type: array
                description: Additional information that cater for specific domestic regulatory requirements
                items:
                  type: string
                  minLength: 1
                  maxLength: 35
                minItems: 0
                maxItems: 100
          minItems: 1
          maxItems: 100
    RemittanceInformation:
      type: object
      title: RemittanceInformation
      description: Mandatory for Malaysia NPP Payments, optional for other markets
      properties:
        unstructuredInformation:
          type: array
          description: Remittance information provided in an unstructured format
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/UnstructuredInformation'
        structuredInformation:
          type: array
          description: 'Remittance information provided in a structured format


            Applicable Faster Payment Markets:

            - Malaysia

            - US'
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/StructuredInformation'
        agentInstructions:
          title: Agent instructions
          type: object
          description: Agent instructions required for the payment transfer
          properties:
            nextAgentInstructions:
              $ref: '#/components/schemas/AgentInstructions'
            creditorAgentInstructions:
              $ref: '#/components/schemas/AgentInstructions'
            debtorAgentInstructions:
              $ref: '#/components/schemas/AgentInstructions'
        foreignCurrency:
          $ref: '#/components/schemas/IsoCurrencyCode'
          description: Only applicable for Mexico Faster Payments
        fx:
          $ref: '#/components/schemas/Fx'
    PaymentStatusBasic:
      type: object
      title: PaymentStatusBasic
      description: Representation of the basic payment status
      properties:
        paymentId:
          $ref: '#/components/schemas/PaymentId'
        valueDate:
          type: string
          format: date
          description: The value date of the payment in YYYY-MM-DD format
        paymentStatus:
          type: string
          enum:
          - RECEIVED
          - ACCEPTED
          - PROCESSING
          - CANCELED
          - REJECTED
          - COMPLETED
          - RETURNED
          description: The payment status indicates the current state of the payment
        paymentSubStatus:
          type: string
          description: The payment sub status provides the granular level payment status
          enum:
          - RECEIVED
          - ACCEPTED
          - PROCESSING_BY_JPM
          - PENDING_CLIENT_ACTION
          - PENDING_COMPLIANCE_REVIEW
          - PENDING_FRAUD_REVIEW
          - PENDING_FUNDING_REVIEW
          - PENDING_JPM_REVIEW
          - SCHEDULED
          - PENDING_POSTING
          - CANCELED
          - REJECTED
          - REJECTED_BY_JPM
          - COMPLETED_BY_JPM
          - SENT_TO_CLEARING
          - DELIVERED_TO_RECIPIENT
          - RETURNED
        statusUpdatedAt:
          type: string
          format: date-time
          description: 'The last updated date and time of the payment status in ISO 8601 format.

            The date &amp; time are expressed in UTC timezone (without offset)'
        gpi:
          type: object
          title: GPIStatus
          description: GPI status as provided by SWIFT network
          properties:
            status:
              type: string
              minLength: 4
              maxLength: 4
              description: Specifies the status of a single payment transaction
            statusDescription:
              type: string
              minLength: 1
              maxLength: 35
            reason:
              type: string
              minLength: 4
              maxLength: 4
              description: Provides the reason for a payment status
        exceptions:
          type: array
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/ErrorContext'
        clearingSystem:
          $ref: '#/components/schemas/ClearingSystem'
        paymentRedirection:
          $ref: '#/components/schemas/PaymentRedirection'
      required:
      - paymentId
      - paymentStatus
      - statusUpdatedAt
    TransactionIdentifier:
      type: string
      minLength: 1
      maxLength: 128
      title: transactionIdentifier
      description: "Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. \n\n> This is the Transaction Reference Number (**TRN**) for a **WIRE** payment."
    IsoCountryCode:
      title: IsoCountryCode
      type: string
      description: ISO 3166-1 Alpha-2 Country Code
      minLength: 2
      maxLength: 2
      pattern: ^[A-Z]{2}$
      example: AU
    PaymentIdentifiersReadOnly:
      type: object
      title: PaymentIdentifiersReadOnly
      description: Identifiers associated with the Payment Instruction throughout its lifecycle.
      required:
      - endToEndId
      properties:
        endToEndId:
          $ref: '#/components/schemas/EndToEndId'
        paymentBatchId:
          type: string
          minLength: 1
          description: "JPMC issued batch Id for the payment \n**NOTE: Applicable only for payments batched by JPMC. i.e ACH**"
        achTraceNumber:
          type: string
          minLength: 1
          description: Original ACH transaction JPMC trace number
        otherPaymentReferences:
          $ref: '#/components/schemas/OtherPaymentReferencesReadOnly'
    MandateInformation:
      type: object
      title: Mandate Information
      description: "Mandate related information. Applicable to the following Direct Debit markets:\n  | Market   | \n  |----------|\n  | SG       |  \n  | AU       |  \n  | MY       |  \n  | UK       |  \n  | SEPA     | "
      properties:
        mandateId:
          type: string
          minLength: 1
          maxLength: 35
          description: "\nMandate id to be provided for direct debit payment initiation.\n  | Market/Instrument               | Length limits           |\n  |---------------------------------|-------------------------|\n  | SGP RTP                         |  35 Max                 | \n  | AU RTP                          |  35 Max                 |\n  | ACH (BACS)                      |  6  Min - 18 Max        |\n  | ACH (SEPA)                      |  35 Max                 |"
        sequenceType:
          $ref: '#/components/schemas/SequenceType'
        signatureDate:
          type: string
          format: date
          description: Date of mandate signature. *Required for SEPA.*
        electronicSignature:
          type: string
          minLength: 1
          maxLength: 2048
          description: Electronic signature of the mandate
        amendmentInformation:
          type: object
          title: Amendment information
          description: The mandate amendment information which captures instructions to amend an existing mandate.
          properties:
            originalMandateId:
              type: string
              minLength: 1
              maxLength: 35
              description: The original mandate identifier
            originalCreditorId:
              $ref: '#/components/schemas/CreditorPrivateId'
            originalDebtor:
              $ref: '#/components/schemas/Account'
      minProperties: 1
    AgentInstructions:
      title: Agent Instructions
      description: Instructions for party agents(Creditor, Debtor or additional parties)
      type: array
      minItems: 1
      maxItems: 3
      items:
        title: AgentInstruction
        type: object
        description: Agent instruction details
        properties:
          code:
            description: "Specifies the  agent instruction from a predefined list of codes.\n\n**Creditor Agent Instruction Codes EMEA/WHEM**:\n  - **CHQB** : Pay creditor customer only by cheque. \n  - **HOLD** : creditor customer/claimant will call; pay upon identification.\n  - **PHOB** : Please advise/contact creditor/claimant by phone.\n  - **TELB** : Please advise/contact creditor/claimant by the most efficient means of telecommunication.\n\n---\n\n**Debtor Agent Instruction Codes EMEA**:\n  - **ACC** : Instructions following are for the creditor agent.\n  - **ADVBEN** : Advise Beneficiary\n  - **ADVREM** : Advise Remitter\n  - **BNF** : The information that follows is for the creditor agent.\n  - **FXEQUIV** : Instruction to pay in FX equivalent\n  - **INS** : The debtor which instructed the Sender to execute the transaction.\n  - **INT** : Instructions for the Intermediary Agent of the message.\n\n**Debtor Agent Instruction Codes EMEA/WHEM**:\n- ACC\n- BENONLY \n- BENOUR\n- BNF\n- CHECK\n- CHEQUE\n- DEDUCT\n- FIND\n- HOLD\n- INS\n- INT\n- NOCRDED\n- NODEDUCT\n- NOFIND\n- NOPREADV\n- PHON\n- PHONBEN\n- PHONIBK\n- PREADV\n- PREADVISE\n- REC\n- SENDCNS\n- TELE\n- TELEBEN\n- TELEIBK\n- TELEX\n- TELEXBEN\n- TELEXIBK"
            type: string
            minLength: 1
            maxLength: 140
            example: HOLD
          instruction:
            description: Optional special agent(s) instruction code/text approved for use.
            minLength: 1
            maxLength: 2048
            type: string
    SequenceType:
      title: Sequence Type
      type: string
      description: 'Signals the nature of a payment within a series for a direct debit collection.

        |Sequence Type | Description                                                     |

        |--------------|-----------------------------------------------------------------|

        |**FIRST**     |**FRST** - Indicates the initial direct debit collection in a series|

        |**RECURRING** |**RCUR** - Used for subsequent collections within an ongoing direct debit agreement|

        |**ONE_OFF**   |**OOFF** - Signifies a single standalone direct debit collection which is not part of a recurring mandate.|

        |**FINAL**     |**FNAL** - Marks the last collection within a recurring direct debit agreement.|'
      enum:
      - FIRST
      - RECURRING
      - ONE_OFF
      - FINAL
    InitiatingParty:
      type: object
      title: Initiating Party
      description: The initiating Party
      additionalProperties: false
      properties:
        partyId:
          $ref: '#/components/schemas/PartyId'
        name:
          type: string
          minLength: 1
          maxLength: 140
          description: Name of the party
        dateAndPlaceOfBirth:
          $ref: '#/components/schemas/DateAndPlaceOfBirth'
        countryOfResidence:
          $ref: '#/components/schemas/IsoCountryCode'
        postalAddress:
          $ref: '#/components/schemas/Address'
      example:
        partyId:
          organizationIds:
          - organizationId: BANK
    IdempotencyKey:
      title: Idempotency Key
      description: A unique string that enables the API support idempotency by safely retrying requests without accidentally performing the same operation twice.
      type: string
      minLength: 1
      maxLength: 36
      example: 1b036f9c-8c84-4ce6-b1dd-5979472945a1
    AdditionalCreditor:
      title: AdditionalCreditor
      type: object
      description: 'Additional creditor parties.

        - To support RTP payment flows for TP4, TP5 &amp; TPx use cases.'
      properties:
        organizationIds:
          description: Collection of registration information held against an organization.
          type: array
          minItems: 1
          maxItems: 16
          items:
            $ref: '#/components/schemas/OrganizationId'
        name:
          type: string
          minLength: 1
          maxLength: 140
        dateAndPlaceOfBirth:
          $ref: '#/components/schemas/DateAndPlaceOfBirth'
        countryOfResidence:
          $ref: '#/components/schemas/IsoCountryCode'
        postalAddress:
          $ref: '#/components/schemas/Address'
        contactDetails:
          $ref: '#/components/schemas/ContactDetails'
        financialInstitutionIds:
          type: array
          minItems: 1
          maxItems: 3
          items:
            $ref: '#/components/schemas/AdditionalCreditorFinancialInstitutionId'
      required:
      - name
    AlternateAccountIdentifiers:
      type: array
      title: Alternate Account Identifiers
      description: One or more values that can be used as alternate identifiers for an account.
      minItems: 1
      maxItems: 10
      items:
        $ref: '#/components/schemas/AlternateAccountIdentifier'
    SettlementInformation:
      title: Settlement Information
      description: Settlement Account Information
      type: object
      properties:
        settlementAccount:
          $ref: '#/components/schemas/SettlementAccountDetails'
        interbankSettlementAmount:
          $ref: '#/components/schemas/Value'
    TaxEntry:
      type: object
      title: TaxEntry
      description: Tax entry details
      minProperties: 1
      maxProperties: 4
      properties:
        invoicePriorTax:
          description: Invoice amount before VAT
          $ref: '#/components/schemas/Decimal'
        incomeCode:
          type: string
          description: Income code associated with the tax
          minLength: 1
          maxLength: 3
        vatAmount:
          $ref: '#/components/schemas/Decimal'
        taxAmount:
          $ref: '#/components/schemas/Value'
    FxInformation:
      title: FX Information
      description: Provides information on foreign exchange details
      type: object
      properties:
        exchangeRate:
          $ref: '#/components/schemas/RateDecimal'
        exchangeRateType:
          type: string
          minLength: 1
          maxLength: 20
          description: Specifies the type used to complete the currency exchange.
          example: SPOT
        rateId:
          type: string
          minLength: 1
          maxLength: 36
          description: Rate identifier
        contractId:
          type: string
          minLength: 1
          maxLength: 36
          description: Contract identifier
    Value:
      description: Amount Value in a given currency.
      title: Amount Value
      type: object
      required:
      - currency
      - amount
      properties:
        currency:
          $ref: '#/components/schemas/IsoCurrencyCode'
        amount:
          $ref: '#/components/schemas/Decimal'
    PaymentDetail:
      title: PaymentDetail
      description: Payment Detail
      allOf:
      - $ref: '#/components/schemas/PaymentStatusBasic'
      - $ref: '#/components/schemas/PaymentReadOnlyView'
    Fx:
      type: object
      title: Fx
      description: Foreign Exchange Information
      properties:
        appliedRate:
          $ref: '#/components/schemas/Decimal'
    IntermediaryAgent:
      title: IntermediaryAgent
      type: object
      description: 'An agent between the debtor''s agent and the creditor''s agent.

        Usage: If more than one intermediary agent is present, then IntermediaryAgent1 identifies the agent between the DebtorAgent and the IntermediaryAgent2.'
      properties:
        position:
          type: integer
          minimum: 1
          maximum: 3
          format: int32
          description: Position of the Intermediary Agent
        name:
          type: string
          minLength: 1
          maxLength: 140
          description: Name of the agent
        financialInstitutionIds:
          type: array
          minItems: 1
          maxItems: 3
          items:
            $ref: '#/components/schemas/DebtorFinancialInstitutionId'
        postalAddress:
          $ref: '#/components/schemas/Address'
    DebtorFinancialInstitutionId:
      title: DebtorFinancialInstitutionId
      description: Debtor FinancialInstitution Id
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 11
          description: 'Financial Institution Identifier

            - US RTP: Use `USABA`

            - CAD ACH CREDIT, BRAZIL TED WIRE and other markets requiring member Ids, use the Clearing System Member Id: `CLEARING_SYSTEM_ID`

            - UK FI Clients: Use `SORT_CODE`

            - For all other instruments/markets: `BIC`'
        idType:
          $ref: '#/components/schemas/FinancialInstitutionIdType'
        branchNumber:
          type: string
          minLength: 1
          maxLength: 5
          description: 'Branch of the bank or financial institution.

            - Applicable and Mandatory for Brazil PIX only'
      required:
      - id
      - idType
    DeliveryMethod:
      type: string
      minLength: 1
      maxLength: 4
      title: DeliveryMethod
      description: 'Method used to deliver the remittance advice information


        The following methods are allowed


        | Code | Description                      |

        |------|----------------------------------|

        | EMAL | Email                            |

        | URID | Uniform Resource Identifier      |'
    IsoCurrencyCode:
      title: IsoCurrencyCode
      type: string
      description: ISO 4217 Alpha-3 Currency Code
      minLength: 3
      maxLength: 3
      pattern: ^[A-Z]{3}$
      example: AUD
    OtherPaymentReferencesReadOnly:
      type: object
      title: OtherPaymentReferencesReadOnly
      description: Other Payment Reference Identifiers
      properties:
        relatedReferenceId:
          type: string
          minLength: 1
          description: Related reference Identifier, applicable for *ACH* and **WIRES** only.
        uetr:
          type: string
          minLength: 36
          maxLength: 36
          description: A Unique End-to-end Transaction Reference (commonly known as a UETR) is a string of 36 unique characters featured in all payment instruction messages carried over SWIFT.
        transactionIdentifier:
          $ref: '#/components/schemas/TransactionIdentifier'
    OrganizationId:
      title: OrganizationId
      type: object
      required:
      - organizationId
      description: "Collection of registration information held against the party.\nIt can be used when the underlying payer is a Legal Entity. It should be used together with Ultimate Debtor Name and address, and it should contain the payment account number of the underlying payer. In case the transfer has not been initiated from a payment account, the value populated should be a unique transaction identifier of the underlying payer which permits the traceability of the transaction back to them.\n\nApplicable markets and rules: - Can be used for ultimateDebtor, ultimateCreditor and additionalCreditors for the following RTP markets:\n  - SEPA \n  - Mexico \n  - UK\n  - United States\n\n***Australia Faster Payments - Only to be used for ultimateCreditor. For Australia Faster Payments, only id and schemeName.proprietary fields are applicable\nACH markets:\n  - Chile\nWIRE Payments:\n  - WHEM\n  - LATAM\n  - EMEA\n  - APAC"
      properties:
        organizationId:
          type: string
          description: 'Formally Issued Organization Identifier - **Note**: For AU Superannuation payment (category payment), populate with USI number for the Superannuation fund.'
          minLength: 1
          maxLength: 35
        bic:
          type: string
          description: "Business Identifier Code, mean a unique code to identify \nany business as defined by the ISO9362 standard."
          minLength: 8
          maxLength: 11
        issuer:
          type: string
          description: Entity that assigns the identification
          minLength: 1
          maxLength: 35
        schemeName:
          description: Name of the identification scheme
          title: SchemeName
          type: object
          minProperties: 1
          maxProperties: 1
          properties:
            code:
              type: string
              description: Name of the identification scheme in a coded form
              minLength: 1
              maxLength: 4
            proprietary:
              type: string
              description: Specifies the type of scheme with a proprietary value - For AU Superannuation payment (category payment), populate "USI"
              minLength: 1
              maxLength: 35
    StructuredInformation:
      type: object
      title: StructuredInformation
      description: Structured Remittance Information
      properties:
        creditReference:
          type: object
          title: Credit Reference
          description: Credit Reference
          properties:
            reference:
              type: string
              description: Unique reference to unambiguously refer to the payment transaction.
              minLength: 1
              maxLength: 140
            issuer:
              type: string
              minLength: 1
              maxLength: 35
            type:
              type: object
              title: Type
              description: Type of Credit Reference
              properties:
                code:
                  type: string
                  minLength: 1
                  maxLength: 4
                proprietary:
                  type: string
                  minLength: 2
                  maxLength: 24
              minProperties: 1
              maxProperties: 1
        additionalRemittanceInformation:
          type: string
          minLength: 1
          maxLength: 1000
          description: '**Applicable Faster Payment Markets**:

            - **Malaysia**: Max length supported - 250 characters

            - **US**: mandatory if structuredInformation object is used     '
        referredDocumentInformation:
          type: object
          title: Referred Document Information
          description: Details of the referred document with respect to the remittance information.
          properties:
            type:
              type: object
              title: Type
              description: Type of Referred Document
              properties:
                code:
                  type: string
                  description: Document type in a coded form.
                  minLength: 1
                  maxLength: 4
                proprietary:
                  type: string
                  description: Proprietary identification of the type of the remittance document
                  minLength: 1
                  maxLength: 35
              minProperties: 1
              maxProperties: 1
            documentDate:
              type: string
              format: date
              description: ISO 8601 date format in `yyyy-mm-dd`
            documentIdentifier:
              type: string
              description: Unique and unambiguous identification of the referred document.
              minLength: 1
              maxLength: 35
            issuer:
              type: string
              description: Identification of the issuer of the reference document type.
              minLength: 1
              maxLength: 35
        referredDocumentAmount:
          title: Referred Document Amount
          description: Amounts related to the referred document.
          type: array
          minItems: 1
          maxItems: 16
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                - DUE_PAYABLE
                - DISCOUNT_APPLIED
                - CREDIT_NOTE
                - REMITTED
                - TAX
                - TRANSACTION_FOREIGN_CURRENCY
                - COMMISSION
                - OTHER_CHARGES
                - ADJUSTED_AMOUNT
              value:
                $ref: '#/components/schemas/Value'
              additionalInformation:
                type: string
                description: Additional information about the referred document amount.
                minLength: 1
                maxLength: 140
        invoicer:
          $ref: '#/components/schemas/Invoicer'
        invoicee:
          $ref: '#/components/schemas/Invoicee'
        deliveryDetails:
          $ref: '#/components/schemas/DeliveryDetails'
    OrganizationIdentification:
      type: object
      title: Organization Identification
      description: Organization Identification Schemes
      required:
      - organizationIds
      properties:
        organizationIds:
          type: array
          minItems: 1
          maxItems: 16
          items:
            $ref: '#/components/schemas/OrganizationId'
    AmountValue:
      description: Instructed Amount Value in a given currency.
      title: Amount Value
      type: object
      required:
      - currency
      - amount
      properties:
        currency:
          $ref: '#/components/schemas/IsoCurrencyCode'
        amount:
          $ref: '#/components/schemas/AmountDecimal'
    EquivalentValue:
      title: Equivalent Value
      type: object
      description: 'Amount of money to be moved between debtor and creditor, before deduction of charges,

        expressed in the currency of the debtor''s account, and to be moved in a different currency.

        **Usage**: The debtor agent will convert the equivalent amount into the amount to be moved.'
      required:
      - equivalentAmount
      properties:
        equivalentAmount:
          type: object
          title: EquivalentAmount
          description: The equivalent amount
          properties:
            currency:
              $ref: '#/components/schemas/IsoCurrencyCode'
            amount:
              $ref: '#/components/schemas/Decimal'
            currencyOfTransfer:
              type: string
              description: Specifies the currency of the transferred amount, which is different from the currency of the debtor's account.
              minLength: 3
              maxLength: 3
              pattern: ^[A-Z]{3}$
              example: EUR
          required:
          - currency
          - amount
          - currencyOfTransfer
    PrimaryAccountDetailsPreviousInstructingAgent:
      type: object
      title: PrimaryAccountDetailsPreviousInstructingAgent
      description: Primary account details of the previous instructing agent
      required:
      - accountNumber
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 70
          description: Name of the account, as assigned by the account servicing institution
        accountNumber:
          $ref: '#/components/schemas/AccountId'
        accountType:
          $ref: '#/components/schemas/AccountType'
        accountCurrency:
          $ref: '#/components/schemas/IsoCurrencyCode'
    Decimal:
      title: Decimal
      type: string
      description: A String representation of a (potentially) whole number or decimal positive number. - *Amount should be more than 0.01 with maximum of two decimal places allowed in most markets.*
      minLength: 1
      maxLength: 40
      pattern: ^\d+(\.\d+)?$
    PaymentEvent:
      title: PaymentEvent
      type: object
      description: Payment Event Data
      properties:
        payments:
          description: A collection of payment statuses
          type: array
          minItems: 1
          maxItems: 50
          items:
            $ref: '#/components/schemas/PaymentStatus'
      required:
      - payments
    SecureVerification:
      type: object
      title: SecureVerification
      description: Secure verification object containing key and secret for authentication
      properties:
        key:
          type: string
          minLength: 1
          maxLength: 256
          description: Key identifies the security question
        secret:
          type: string
          minLength: 1
          maxLength: 256
          description: Authenticate the key using secret answer to the question
    AlternateAccountDetails:
      type: object
      title: Alternate Account Details
      description: Alternate Account Details
      required:
      - alternateAccountIdentifiers
      properties:
        alternateAccountIdentifiers:
          $ref: '#/components/schemas/AlternateAccountIdentifiers'
    AlternateAccountIdentifier:
      title: AlternateAccountIdentifier
      type: object
      description: "- Alternate Account Identifier eg. email, program id, proprietary.\n\n- Mandatory for **Push To Card**:\n  - Use program id while specifying the identifier for debtor details\n\n- Each `identifier` entry **MUST** identify its context as assigned by the\n  associated account platform as an idType. "
      required:
      - identifier
      - idType
      properties:
        identifier:
          type: string
          minLength: 1
          maxLength: 500
          description: The Alternate Account Identifier value
        idType:
          type: string
          description: "One or more values that can be used as alternative identifiers for an account. \n  | Identifier Type    | Description                                                         |\n  | -------------------| --------------------------------------------------------------------|\n  | PROGRAM_ID         | A client program identifier.                                        |\n  | EMAIL              | Email                                                               |\n  | PROPRIETARY        | A proprietary identifier that can be used to identify an account    |\n\nWhen idType is set to PROPRIETARY, proprietarySchemeName MUST be provided."
          enum:
          - PROGRAM_ID
          - EMAIL
          - PROPRIETARY
        proprietarySchemeName:
          type: string
          enum:
          - MSISDN
          - NRIC
          - UEN
          - VPA
          - EMAL
          - ORGN
          - TELI
          - AUBN
          - PSPT
          - BREG
          - MBNO
          - ARMN
          - MOBN
          - SVID
          - CPF
          - CNPJ
          - EVP
          - QRCD
          - ACCN
          - ALIS
          - NIDN
          - EWALLETID
          - SSID
          - SHID
          description: "Specifies the type of Proxy account. Required if\nidType is set to PROPRIETARY\n\nProprietary types applicable per market and instrument:\n\n- **RTP - Singapore**: \n  - **MSISDN** - Mobile number \n  - **UEN** - Unique Entity Number\n  - **VPA** - Virtual Payment Address\n  - **NRIC** - IC number \n\n- **RTP - Australia**:\n  - **EMAL** - Email Address\n  - **TELI** - Telephone Number\n  - **AUBN** - Australia Business number\n  - **ORGN** - Organization Id\n\n- **RTP - Malaysia**:\n  - **MBNO** - Mobile number\n  - **NRIC** - IC number \n  - **PSPT** - Passport number \n  - **ARMN** - Army or Police Number \n  - **BREG** - Business registration number\n\n\n- **RTP - Hong Kong**:\n  - **EMAL** - Email Address\n  - **MOBN** - Mobile Number (or fixed-line number)\n  - **SVID** - FPS Identifier\n\n- **RTP - Brazil**:\n  - **CPF** - Tax ID of Individual\n  - **CNPJ** - Tax ID of Corporate\n  - **EVP** - Random Key\n  - **QRCD** - QR Code\n  - **EMAL** - Email id \n  - **MOBN** - Mobile number \n\n\n- **RTP - Mexico**:\n  - **MOBN** - Mobile number\n  - **BANK** - Transfer to a Bank identifier \n  - **CARD** - Transfer to a debit card number\n\n\n- **RTP - Indonesia**:\n  - **MOBN** - Mobile number\n  - **EMAL** - Email id \n  - **CARD** - Transfer to a debit card number   \n  - **ALIS** - eMoney transfer\n  \n- **RTP - THB**:\n  - **MOBN** - Mobile number\n  - **NIDN** - National ID number\n  - **EWALLETID** - EWALLET ID  \n        \n- **Alternate Payments**:\n  - **EMAL** - Email Address \n  - **TELI** - Telephone Number\n  - **ACCN** - Alternate account number\n  - **ALIS** - Alias identification\n*For Zelle only EMAL and TELI are applicable*"
    Webhook:
      title: Webhook
      description: Representation of a Webhook Event
      type: object
      allOf:
      - $ref: '#/components/schemas/Event'
      - $ref: '#/components/schemas/PaymentEventData'
    PaymentValue:
      title: PaymentValue
      type: object
      description: Payment value
      oneOf:
      - $ref: '#/components/schemas/AmountValue'
      - $ref: '#/components/schemas/EquivalentValue'
    RequestId:
      type: string
      minLength: 1
      maxLength: 128
      description: Client provided unique identifier for the current request invocation
    CardAccountDetails:
      title: CardAccountDetails
      type: object
      description: "Card Account Identifier, mandatory for **Push to Card(P2C)**.\n  - To be used while specifying the account identifier for creditor details"
      required:
      - card
      properties:
        card:
          title: Card
          type: object
          description: representation of a card account Identifier
          required:
          - pan
          properties:
            pan:
              type: string
              minLength: 13
              maxLength: 19
              description: A Card's Primary Account Number which is a unique sequence of numbers in accordance with ISO/IEC 7812 standard.
            network:
              type: string
              enum:
              - VI
              - MC
              description: 'The card network to which the card belongs. The Card Network String is an acronym based on the values below:

                | Acronym | Full Name   |

                |---------|-------------|

                | VI      | Visa        |

                | MC      | MasterCard  |'
            expiryDate:
              type: string
              description: Acceptable format - YYMM
              pattern: ^(?:[0-9]{2})(0[1-9]|1[0-2])$
            accountCurrency:
              $ref: '#/components/schemas/IsoCurrencyCode'
    PaymentPurpose:
      title: PaymentPurpose
      type: object
      description: The Payment's purpose
      additionalProperties: false
      properties:
        purpose:
          $ref: '#/components/schemas/Purpose'
        categoryPurpose:
          $ref: '#/components/schemas/CategoryPurpose'
      minProperties: 1
    ErrorContext:
      title: ErrorContext
      type: object
      required:
      - message
      properties:
        code:
          type: string
          description: JPMC Short code that identifies the error - publicly cataloged and documented
          minLength: 5
          maxLength: 5
          pattern: ^[0-9]+$
        message:
          type: string
          description: Human readable textual description of the error
          minLength: 1
          maxLength: 140
        location:
          type: string
          title: The component of the request impacted, can either be 'body', 'query', 'header', or 'path'
          description: The location of the error occurred in the request.
          minLength: 1
          maxLength: 99
          enum:
          - BODY
          - PATH
          - QUERY
          - HEADER
        field:
          type: string
          description: The field which caused the error. Where the location of the error occurred is BODY, the field would contain the JSON Path expression
          minLength: 1
          maxLength: 99
          pattern: ^[\$0-9a-zA-Z-_.()\[\]{}'"\s@=><!?,]+$
        additionalContext:
          $ref: '#/components/schemas/AdditionalContext'
      description: Error Context
    LocalInstrument:
      title: Local Instrument
      type: object
      description: Specifies a user community specific instrument
      properties:
        code:
          type: string
          pattern: ^[-_.A-Z0-9]{2,10}$
          description: "Specifies the local instrument, as published in an external local instrument code list.\n|LocalInstrumentCode  | Meaning\n|--------------------|-----------------\n|**SDCL**            | Same Day Clearing\n|**IN**              | International Payments\n|**CCD**             | Urgent Payment Net Settlement Corporate Credit or Debit (**CCD**)\n|**IAT**             | Same Day Value International ACH Transactions (**IAT**)\n|**PPD**             | Pre-arranged Payments or Deposit Transfer(**PPD**) \n|**CTX**             | Corporate Trade Exchange\n|**CIE**             | Customer Initiated Entry\n|**ARC**             | Accounts Receivable Entry\n|**POP**             | Point of Purchase\n|**RCK**             | Re-presented Check Entry\n|**BOC**             | Back office Conversion\n|**POS**             | Point of Sale\n|**WEB**             | **WEB** Initiated Entry - Used for authorizing payment over the internet.\n|**TEL**             | **TELEPHONE** Initiated Entry - Used for authorizing payment via telephone.\n\n- For **US ACH**: it is mandatory to include a 3 character **SEC** code.\n\n> A Standard Entry Class (**SEC**) code is a mandatory three-letter code that describes how a payment was authorized\nby the consumer or business receiving an ACH transaction. This is meant to be specified as a localInstructment code for \nACH transactions."
        proprietary:
          type: string
          pattern: ^[-_.A-Z0-9]{1,35}$
          description: Specifies the local instrument, as a proprietary code.
    UltimateDebtorAccount:
      title: UltimateDebtorAccount
      oneOf:
      - $ref: '#/components/schemas/DebtorAccountDetails'
      - $ref: '#/components/schemas/DebtorAlternateAccountDetails'
      - $ref: '#/components/schemas/CardAccountDetails'
    VatBranchCode:
      title: VatBranchCode
      type: string
      description: VAT Branch Code
      minLength: 5
      maxLength: 5
    StandardCodeContext:
      title: Standard Code Context
      description: Schema representing a standard code context such as ISO or Clearing codes
      type: object
      required:
      - code
      - message
      - type
      properties:
        type:
          title: CategoryType
          type: string
          description: 'Category of the error code such as ISO or a Clearing Code (NACHA, BACS etc)

            |Category Type | Description

            |--------------|-----------------

            |**ISO20022**       | ISO Codes based on an ISO standard e.g. ISO20022

            |**CLEARING_NACHA**  | Clearing codes

            |**EXTERNAL**  | External code sets '
          minLength: 2
          maxLength: 16
        code:
          type: string
          description: Short code that identifies the error - publicly cataloged and documented
          minLength: 2
          maxLength: 10
          pattern: ^[a-zA-Z0-9]+$
        message:
          type: string
          description: Human readable textual description of the error
          minLength: 1
          maxLength: 140
    Payment:
      type: object
      title: Payment
      description: Representation of the payment instruction.
      required:
      - requestedExecutionDate
      - paymentIdentifiers
      - value
      - transferType
      - paymentType
      - debtor
      - debtorAgent
      - creditor
      properties:
        requestedExecutionDate:
          type: string
          format: date
          description: "Requested execution date of the payment instruction (e.g. value date) in ISO 8601 `yyyy-mm-dd` format,\n must be either the current or future date.\n- This is the value date for EMEA ACH Payments "
        paymentIdentifiers:
          $ref: '#/components/schemas/PaymentIdentifiers'
        value:
          $ref: '#/components/schemas/PaymentValue'
        transferType:
          $ref: '#/components/schemas/TransferType'
        paymentType:
          $ref: '#/components/schemas/PaymentType'
        paymentTypeInformation:
          $ref: '#/components/schemas/PaymentTypeInformation'
        debtor:
          $ref: '#/components/schemas/Party'
        debtorAgent:
          $ref: '#/components/schemas/DebtorAgent'
        creditor:
          $ref: '#/components/schemas/Party'
        creditorAgent:
          $ref: '#/components/schemas/CreditorAgent'
        additionalParties:
          $ref: '#/components/schemas/AdditionalParties'
        paymentPurpose:
          $ref: '#/components/schemas/PaymentPurpose'
        remittanceInformation:
          $ref: '#/components/schemas/RemittanceInformation'
        taxInformation:
          $ref: '#/components/schemas/TaxInformation'
        regulatoryReporting:
          $ref: '#/components/schemas/RegulatoryReporting'
        settlementInformation:
          $ref: '#/components/schemas/SettlementInformation'
        mandateInformation:
          $ref: '#/components/schemas/MandateInformation'
        fxInformation:
          $ref: '#/components/schemas/FxInformation'
        secureVerification:
          type: array
          description: Applies only for Interac proxy payments
          minItems: 1
          maxItems: 10
          items:
            $ref: '#/components/schemas/SecureVerification'
        paymentExpiresAt:
          type: string
          format: date-time
          description: Applies only for Interac proxy Payments. Format expected - ISO 8601 `YYYY-MM-DDThh:mm:ss`+/-time offset to UTC
        chargesInformation:
          $ref: '#/components/schemas/ChargesInformation'
      additionalProperties: false
    ContactDetails:
      title: ContactDetails
      type: object
      description: Party contact details
      minProperties: 1
      properties:
        phoneNumber:
          type: string
          minLength: 1
          maxLength: 35
          pattern: ^\+[0-9]{1,3}-[0-9()+\-]{1,35}$
          description: Phone number as defined by the Telecom services
        mobileNumber:
          type: string
          minLength: 1
          maxLength: 35
          pattern: ^\+[0-9]{1,3}-[0-9()+\-]{1,35}$
          description: Mobile phone number as defined by the Telecom services
        faxNumber:
          type: string
          minLength: 1
          maxLength: 30
          pattern: ^\+[0-9]{1,3}-[0-9()+\-]{1,30}$
          description: FAX number as defined by the Telecom services
        emailAddress:
          type: string
          minLength: 1
          maxLength: 256
          description: Electronic mail address
        emailPurpose:
          type: string
          minLength: 1
          maxLength: 35
          description: Purpose for which an email address may be used.
        jobTitle:
          type: string
          minLength: 1
          maxLength: 35
          description: Job title as per organisation records.
        responsibility:
          type: string
          minLength: 1
          maxLength: 35
          description: Role of a person in an organisation.
        department:
          type: string
          minLength: 1
          maxLength: 70
          description: Identification of a division within the organisation.
    PaymentRedirection:
      title: PaymentRedirection
      type: object
      description: 'Represents details of a payment that has been redirected to another bank account


        **Applicable only for UK FPS**'
      properties:
        accountNumber:
          type: string
          description: Account number
          minLength: 1
          maxLength: 8
        financialInstitutionIds:
          type: array
          minItems: 1
          maxItems: 1
          items:
            $ref: '#/components/schemas/CreditorFinancialInstitutionId'
      required:
      - accountNumber
      - financialInstitutionIds
    CreditorAgent:
      title: CreditorAgent
      type: object
      description: 'The Bank or financial institution of the creditor(the party receiving the payment)

        - Not applicable for **Push To Card**, **Push To Wallet** and **Interac**

        - Mandatory for pay by account and optional for pay by proxy.

        - Mandatory for Mexico RTP if the creditor is a bank

        - Mandatory for US ACH (IAT and NON IAT)'
      required:
      - financialInstitutionIds
      additionalProperties: false
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 140
          description: Name of the agent
        financialInstitutionIds:
          type: array
          minItems: 1
          maxItems: 3
          items:
            $ref: '#/components/schemas/CreditorFinancialInstitutionId'
        postalAddress:
          $ref: '#/components/schemas/Address'
        additionalInstitutions:
          $ref: '#/components/schemas/AdditionalInstitutions'
    TaxInformation:
      type: object
      title: TaxInformation
      description: 'Mandatory for Brazil PIX (Pay To Account scenario), Thailand PromptPay (e-WHT) and Chile Low value ACH payments

        Optional for Mexico RTP


        - Tax Amount is only applicable for Mexico RTP and WIRES'
      properties:
        type:
          type: string
          minLength: 1
          description: Specifies the Type of Tax applied (applicable for Mexico WIRES)
          example: VATX
        taxAmount:
          $ref: '#/components/schemas/Value'
        creditorTaxInformation:
          $ref: '#/components/schemas/CreditorTaxInformation'
        debtorTaxInformation:
          $ref: '#/components/schemas/DebtorTaxInformation'
        taxEntries:
          type: array
          description: 'List of tax entries


            Applicable for Thailand PromptPay (e-WHT)'
          items:
            $ref: '#/components/schemas/TaxEntry'
          minItems: 1
          maxItems: 3
    CategoryPurpose:
      type: object
      title: CategoryPurpose
      description: Specifies the high level purpose of the payment based on a set of pre-defined categories.
      properties:
        code:
          type: string
          description: 'A code denoting the high level purpose of a payment based on a set of pre-defined categories.

            |Code                | Meaning

            |--------------------|-----------------

            |**SALA**            | Salary

            |**PENS**            | Pension

            |**TAXS**            | Tax Payment

            |**SUPP**            | Supplier Payment

            |**INTC**            | Intercompany payment

            |**CORT**            | Financial Payment

            |**VATX**            | Value Added Tax

            **Note**: Not applicable for Hong Kong'
          enum:
          - SALA
          - PENS
          - TAXS
          - SUPP
          - INTC
          - CORT
          - VATX
        proprietary:
          type: string
          minLength: 2
          maxLength: 24
          description: "Category Purpose in proprietary coded form:\n| proprietary      \t    | Description                  \t|Market\n|---------------------\t|------------------------------\t|--------------------\n| **CXSALA**          \t| Salary and Benefits Payments \t|**Hong Kong RTP**: Credit transfer, **Indonesia RTP**\n| **CXBSNS**          \t| General Business Payment    \t|**Hong Kong RTP**: Credit transfer\n| **CXMRCH**          \t| FPS Merchant Payment        \t|**Hong Kong RTP**: Credit transfer\n| **CXTOPU**          \t| Account Top-up Payment      \t|**Hong Kong RTP**: Credit transfer\n| **WEALTH_TRANSFER** \t|                              \t|**Indonesia RTP***\n| **INVESTMENT**      \t|                              \t|**Indonesia RTP***\n| **PURCHASE**        \t|                              \t|**Indonesia RTP***\n| **ACCTVERIFY**      \t|                              \t| **US ACH**\n| **RECLAIM**         \t|                              \t| **US ACH**\n| **RETRY_PYMT**      \t|                              \t| **US ACH**\n| **REVERSA**         \t|                              \t| **US ACH**\n| **HCCLAIMPMT**      \t|                              \t| **US ACH**\n| **OTHER**           \t|                              \t|**Indonesia RTP***\n\n**Note**:  Free form text is also allowed for **US ACH** but limited to 10 chars"
      minProperties: 1
      maxProperties: 1
    BasicAddress:
      type: object
      title: Basic Address
      description: Address type
      properties:
        city:
          type: string
          description: City or town name
          minLength: 1
          maxLength: 35
        countrySubDivision:
          $ref: '#/components/schemas/IsoCountrySubdivisionCode'
        country:
          $ref: '#/components/schemas/IsoCountryCode'
    IsoCountrySubdivisionCode:
      title: IsoCountrySubdivisionCode
      type: string
      description: ISO 3166-2 Alphanumeric Country Subdivision Code
      minLength: 1
      maxLength: 35
    DeviceInfo:
      type: object
      title: Device Information
      description: 'Device details of a party partaking in the money movement. *Applicable and mandatory for Malaysia NPP Payments*.


        **Refer the table below for the applicable and mandatory markets**


        | Markets        | Significance |

        |----------------|--------------|

        |   Malaysia     | MANDATORY    |'
      properties:
        ipAddress:
          type: string
          minLength: 0
          maxLength: 39
          description: 'Device IP address


            **Refer the table below for the applicable and mandatory markets**


            | Markets        | Significance |

            |----------------|--------------|

            |   Malaysia     | MANDATORY    |'
        geoCoordinates:
          type: object
          title: GeoCoordinates
          description: "Contains the geographical coordinates.\n\n**Applicable for Direct Debit Payments Only(transferType=DEBIT). This has to be populated for the CREDITOR.** \n\n**Refer the table below for the applicable and mandatory markets**\n\n| Markets        | Significance |\n|----------------|--------------|\n|   Malaysia     | MANDATORY    | "
          properties:
            latitude:
              type: string
              minLength: 0
              maxLength: 12
              example: '3.140853'
            longitude:
              type: string
              minLength: 0
              maxLength: 12
              example: '101.693207'
    PaymentId:
      title: PaymentId
      type: string
      minLength: 1
      maxLength: 128
      description: Unique payment initiation identification number
      example: 253f67f3-b640-44cb-aabd-2cc348b52678
    Address:
      title: Address
      type: object
      description: Representation of an Address
      minProperties: 1
      properties:
        type:
          type: string
          enum:
          - ADDR
          - BIZZ
          - DLVY
          - HOME
          - MLTO
          - PBOX
        addressLines:
          $ref: '#/components/schemas/UnstructuredAddress'
        buildingName:
          type: string
          description: Name of the building or house.
          minLength: 1
          maxLength: 35
        buildingNumber:
          type: string
          minLength: 1
          maxLength: 16
        department:
          type: string
          description: Identification of a division of a large organisation or building.
          minLength: 1
          maxLength: 70
        subDepartment:
          type: string
          description: Identification of a division of a large organisation or building.
          minLength: 1
          maxLength: 70
        floor:
          type: string
          description: Floor or storey within a building
          minLength: 1
          maxLength: 70
        postBox:
          type: string
          description: Numbered box in a post office, assigned to a person or organisation, where letters are kept until called for
          minLength: 1
          maxLength: 16
        room:
          type: string
          description: Building room number
          minLength: 1
          maxLength: 70
        streetName:
          type: string
          minLength: 1
          maxLength: 70
        district:
          type: string
          description: Identifies a subdivision within a country sub-division.
          minLength: 1
          maxLength: 35
        city:
          type: string
          minLength: 1
          maxLength: 35
        cityLocation:
          type: string
          description: Specific location name within the city.
          minLength: 1
          maxLength: 35
        postalCode:
          type: string
          minLength: 1
          maxLength: 20
        countrySubDivision:
          $ref: '#/components/schemas/IsoCountrySubdivisionCode'
        country:
          $ref: '#/components/schemas/IsoCountryCode'
    AdditionalInstitution:
      type: object
      title: AdditionalInstitution
      description: Only applicable to UK Faster Payments and Mexico RTP (foreign remittances)
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 35
        idType:
          $ref: '#/components/schemas/FinancialInstitutionIdType'
        name:
          type: string
          minLength: 1
          maxLength: 140
        isForeignParty:
          type: boolean
        postalAddress:
          $ref: '#/components/schemas/Address'
      required:
      - id
      - idType
    DeliveryDetails:
      title: Delivery Details
      description: Details of the delivery method and address for remittance information
      type: object
      properties:
        deliveryMethod:
          $ref: '#/components/schemas/DeliveryMethod'
        deliveryAddress:
          type: string
          minLength: 1
          maxLength: 2048
          description: 'Electronic address to which an agent is to send the remittance information.       '
    AccountId:
      title: AccountId
      type: string
      minLength: 1
      maxLength: 128
      description: "This field captures a regular account number .\n\n**Maximum length supported for different instruments and markets**:\n\n  | Market/Instrument               \t| Maximum length limits                                         |\n  |-----------------------------------|---------------------------------------------------------------|\n  | UK FPS                          \t| 8 (7 digit A/C numbers should be padded with a leading zero) \t|\n  | SGP RTP                         \t| 35                                                           \t|\n  | AUS RTP                         \t| 35                                                           \t|\n  | HKG FPS                         \t| 35                                                           \t|\n  | IND IMPS                        \t| 35                                                           \t|\n  | P2C US/CA                       \t| 16                                                           \t|\n  | BRA PIX                         \t| 34                                                           \t|\n  | MEX SPEI                        \t| 16                                                           \t|\n  | USA RTP                         \t| 31                                                           \t|\n  | SEPA Instant                    \t| 34 (IBAN)                                                     |\n  | P2I INTERAC                     \t| 35                                                            |\n  | Blockchain (Kinexys) Payments     | 34                                                            |\n  | Chile ACH                       \t| 34                                                            |\n  | US ACH IAT                       \t| 35                                                            |\n  | US ACH NON-IAT                   \t| 17                                                            |\n  | CAD ACH                          \t| 12                                                            |\n  | ACH (BACS)                       \t| 8                                                             |\n  | ACH (SEPA)                       \t| 34 (IBAN)                                                     |"
    PaymentInitiationDuplicateResponse:
      title: DuplicatePaymentResponse
      type: object
      description: Duplicate payment
      required:
      - duplicateOf
      - links
      properties:
        duplicateOf:
          type: object
          title: DuplicateOf
          description: Details of the original Payment Instruction that is identified as a duplicate.
          required:
          - paymentId
          - paymentIdentifiers
          properties:
            paymentId:
              $ref: '#/components/schemas/PaymentId'
            paymentIdentifiers:
              type: object
              title: PaymentIdentifiers
              description: Identifiers associated with the Payment Instruction throughout its lifecycle.
              properties:
                endToEndId:
                  $ref: '#/components/schemas/EndToEndId'
              required:
              - endToEndId
        links:
          type: object
          title: Links
          description: Links to relevant resources associated with the duplicate payment.
          required:
          - payment
          properties:
            payment:
              type: string
              description: URI (Relative URI) of the referenced payment resource.
              example: /payment/v2/payments/95364018-be32-4c71-9618-f1ceba78f28c
              format: uri-reference
              pattern: ^/[a-zA-Z0-9/_\-\.~:\?#\[\]@!\$&'\(\)\*\+,;=%]+$
        reason:
          type: object
          title: Reason
          description: Details of the duplicate reason.
          required:
          - code
          - location
          - message
          properties:
            code:
              type: string
              example: '11909'
              minLength: 5
              maxLength: 5
              pattern: ^[0-9]+$
            location:
              type: string
              enum:
              - BODY
              - HEADER
              - QUERY
              - PATH
              example: BODY
            message:
              type: string
              example: This is a business duplicate, refer to documentation.
              minLength: 1
              maxLength: 140
    DebtorAccountType:
      type: string
      description: 'Mandatory for `SEPA Instant` - Use IBAN

        Mandatory for Blockchain Payments - `DDA`, `BDA` (Blockchain Deposit Account)

        Field not applicable to Alternate Payments (Wallet, Cards)'
      enum:
      - DDA
      - VAM
      - IBAN
      - BDA
      - CACC
      - SVGS
      - CARD
      - EMBEDDED_DDA
      - LIMITED_DDA
      - WALLET
    Account:
      title: Account
      description: Representation of a bank account. Features of the model may vary between different account types.
      oneOf:
      - $ref: '#/components/schemas/PrimaryAccountDetails'
      - $ref: '#/components/schemas/AlternateAccountDetails'
      - $ref: '#/components/schemas/CardAccountDetails'
      example:
        accountNumber: '2367836484747'
        accountType: DDA
        accountCurrency: AUD
    CreditorFinancialInstitutionId:
      type: object
      title: CreditorFinancialInstitutionId
      description: Creditor Financial InstitutionId
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 11
          description: "**BIC**:\n\nSWIFT BIC. Applicable and Mandatory for RTP markets:\n  - Singapore\n  - Malaysia\n\nOptional markets:\n  - SEPA Instant\n  - Mexico\n\nMandatory for Blockchain(Kinexys) Payments:\n  - US\n  - SEPA\n\n**CLEARING_SYSTEM_ID**:\n\nClearing system identifier/member identifier. Applicable and Mandatory for\nRTP markets:\n\n  - UK\n  - Australia\n  - India\n  - Hong Kong\n  - US\n  - Brazil\n\n**ACH**: \n  - Chile\n  - Canada \n\n**WIRE**:\n  - BRAZIL TED"
        idType:
          $ref: '#/components/schemas/FinancialInstitutionIdType'
        branchNumber:
          type: string
          minLength: 1
          maxLength: 5
          description: Branch of the bank or financial institution.
      required:
      - id
      - idType
    AdditionalCreditorFinancialInstitutionId:
      title: AdditionalCreditorFinancialInstitutionId
      description: Additional Creditor FinancialInstitution Id
      type: object
      properties:
        id:
          type: string
          description: Financial Institution Identifier
          minLength: 1
          maxLength: 11
        idType:
          $ref: '#/components/schemas/FinancialInstitutionIdType'
        branchNumber:
          type: string
          description: 'Branch of the bank or financial institution.

            - Applicable and Mandatory for Brazil PIX only'
          minLength: 1
          maxLength: 5
      required:
      - id
      - idType
    RateDecimal:
      title: RateDecimal
      type: string
      description: 'A String representation of a (potentially) decimal positive rate value. '
      minLength: 1
      maxLength: 6
      pattern: ^\d+(\.\d+)?$
      example: '5.00'
    ClearingSystem:
      type: object
      description: Details of the clearing system used to process the payment instruction
      title: ClearingSystem
      properties:
        name:
          type: string
          description: Name of the clearing system
          minLength: 3
          maxLength: 10
        reference:
          type: string
          description: A unique reference assigned by the clearing system to unambiguously identify the instruction
          minLength: 1
          maxLength: 128
    PaymentContext:
      title: Payment Context
      type: string
      description: 'Specifies the context of the payment flow:

        - **WIRES** Specific payment context:

        |Payment Context  | description

        |-----------------|-----------------

        |**FI**           | Financial Instition initiated flow

        |**CUSTOMER**     | CUSTOMER  Initated flow'
      enum:
      - FI
      - CUSTOMER
    CreditorTaxInformation:
      type: object
      description: Creditor Tax Information
      title: CreditorTaxInformation
      required:
      - taxId
      properties:
        taxId:
          type: string
          minLength: 1
          maxLength: 35
          description: 'Maximum lengths allowed per instrument/market :-

            - **Chile ACH**: 35'
        taxpayerCategory:
          type: string
          enum:
          - INDIVIDUAL
          - CORPORATE
        vatBranchCode:
          $ref: '#/components/schemas/VatBranchCode'
    IndividualId:
      type: object
      title: IndividualId
      required:
      - individualId
      description: "Can be used if organization ID is not populated, when the underlying payer is an Individual. It should be used together with Ultimate Debtor Name and address, and it should contain the payment account number of the underlying payer. In case the transfer has not been initiated from a payment account, the value populated should be a unique transaction identifier of the underlying payer which permits the traceability of the transaction back to them\n\nApplicable RTP markets:\n\n    SEPA \n    Mexico \n    UK\n    United States\n\nACH markets:\n\n    Chile"
      properties:
        individualId:
          type: string
          description: Unique and unambiguous identification of an individual
          minLength: 1
          maxLength: 35
        issuer:
          type: string
          description: Entity that assigns the identification
          minLength: 1
          maxLength: 35
        schemeName:
          description: Name of the identification scheme
          title: SchemeName
          type: object
          minProperties: 1
          maxProperties: 1
          properties:
            code:
              type: string
              description: Name of the identification scheme in a coded form
              minLength: 1
              maxLength: 4
            proprietary:
              type: string
              description: 'Specifies the type of scheme with a proprietary value.

                - **Note**: For AU Superannuation payment (category payment), populate "USI"'
              minLength: 1
              maxLength: 35
    Invoicee:
      type: object
      title: Invoicee
      description: Invoicee party identification
      properties:
        partyId:
          $ref: '#/components/schemas/PartyId'
        name:
          type: string
          minLength: 1
          maxLength: 140
          description: Name of the party
        dateAndPlaceOfBirth:
          $ref: '#/components/schemas/DateAndPlaceOfBirth'
        countryOfResidence:
          $ref: '#/components/schemas/IsoCountryCode'
        postalAddress:
          $ref: '#/components/schemas/Address'
    DebtorAlternateAccountDetails:
      type: object
      description: Alternate account details
      title: AlternateAccountDetails
      required:
      - alternateAccountIdentifier
      properties:
        alternateAccountIdentifier:
          $ref: '#/components/schemas/AlternateAccountIdentifier'
        accountType:
          $ref: '#/components/schemas/DebtorAccountType'
        accountCurrency:
          $ref: '#/components/schemas/IsoCurrencyCode'
    PaymentStatus:
      type: object
      title: PaymentStatus
      description: Representation of the payment status
      properties:
        paymentId:
          $ref: '#/components/schemas/PaymentId'
        valueDate:
          type: string
          format: date
          description: The value date of the payment in YYYY-MM-DD format
        paymentStatus:
          type: string
          enum:
          - RECEIVED
          - ACCEPTED
          - PROCESSING
          - CANCELED
          - REJECTED
          - COMPLETED
          - RETURNED
          description: The payment status indicates the current state of the payment
        paymentSubStatus:
          type: string
          description: The payment sub status provides the granular level payment status
          enum:
          - RECEIVED
          - ACCEPTED
          - PROCESSING_BY_JPM
          - PENDING_CLIENT_ACTION
          - PENDING_COMPLIANCE_REVIEW
          - PENDING_FRAUD_REVIEW
          - PENDING_FUNDING_REVIEW
          - PENDING_JPM_REVIEW
          - SCHEDULED
          - PENDING_POSTING
          - CANCELED
          - REJECTED
          - REJECTED_BY_JPM
          - COMPLETED_BY_JPM
          - SENT_TO_CLEARING
          - DELIVERED_TO_RECIPIENT
          - RETURNED
        statusUpdatedAt:
          type: string
          format: date-time
          description: 'The last updated date and time of the payment status in ISO 8601 format.

            The date &amp; time are expressed in UTC timezone (without offset)'
        gpi:
          type: object
          title: GPIStatusInfo
          description: GPI status as provided by SWIFT network
          properties:
            status:
              type: string
              description: Specifies the status of a single payment transaction
            statusDescription:
              type: string
            reason:
              type: string
              description: Provides the reason for a payment status
        paymentIdentifiers:
          $ref: '#/components/schemas/PaymentIdentifiersReadOnly'
        paymentType:
          $ref: '#/components/schemas/PaymentType'
        transferType:
          $ref: '#/components/schemas/TransferType'
        requestedExecutionDate:
          type: string
          format: date
          description: "Requested execution date of the payment instruction (e.g. value date) in ISO 8601 `yyyy-mm-dd` format,\n must be either the current or future date.\n- This is the value date for EMEA ACH Payments "
        exceptions:
          type: array
          minItems: 1
          maxItems: 100
          items:
            $ref: '#/components/schemas/ErrorContext'
        fxInformation:
          $ref: '#/components/schemas/FxInformationReadOnly'
        clearingSystem:
          $ref: '#/components/schemas/ClearingSystem'
        paymentRedirection:
          $ref: '#/components/schemas/PaymentRedirection'
      required:
      - paymentId
      - paymentStatus
      - statusUpdatedAt
      - paymentIdentifiers
      - paymentType
      - transferType
      - requestedExecutionDate
      additionalProperties: false
    PreviousInstructingAgentFinancialInstitutionId:
      title: PreviousInstructingAgentFinancialInstitutionId
      description: Previous Instructing Agent Financial Institution Id
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 11
          description: Financial Institution Identifier
        idType:
          $ref: '#/components/schemas/FinancialInstitutionIdType'
        branchNumber:
          type: string
          minLength: 1
          maxLength: 5
          description: 'Branch of the bank or financial institution.

            - Applicable and Mandatory for Brazil PIX only'
      required:
      - id
      - idType
    DebtorAccountId:
      title: DebtorAccountId
      type: string
      minLength: 1
      maxLength: 128
      description: "Applicable and mandatory for RTP, ACH, Wires and Blockchain (Kinexys) Payments only\n\nThis field is to provide the regular account number when it is a pay by\nAccount instruction. if pay by proxy this does not need to be filled.\n\n**Maximum length supported for each instrument and market**:-\n\n  | Market/Instrument               \t| Maximum length limits                                         |\n  |-----------------------------------|---------------------------------------------------------------|\n  | UK FPS                          \t| 8 (7 digit A/C numbers should be padded with a leading zero) \t|\n  | SGP RTP                         \t| 35                                                           \t|\n  | AUS RTP                         \t| 35                                                           \t|\n  | HKG FPS                         \t| 35                                                           \t|\n  | IND IMPS                        \t| 35                                                           \t|\n  | P2C US/CA                       \t| 16                                                           \t|\n  | BRA PIX                         \t| 34                                                           \t|\n  | MEX SPIE                        \t| 16                                                           \t|\n  | USA RTP                         \t| 31                                                           \t|\n  | SEPA Instant                    \t| 34 (IBAN)                                                     |\n  | P2I INTERAC                     \t| 35                                                            |\n  | Blockchain (Kinexys) Payments      \t| 34                                                            |\n  | Chile ACH                       \t| 34                                                            |\n  | US ACH IAT                       \t| 35                                                            |\n  | US ACH NON-IAT                   \t| 17                                                            |\n  | CAD ACH                          \t| 12                                                            |"
    DebtorAccountDetails:
      type: object
      description: Primary account details
      title: PrimaryAccountDetails
      required:
      - accountNumber
      properties:
        accountNumber:
          $ref: '#/components/schemas/DebtorAccountId'
        accountType:
          $ref: '#/components/schemas/DebtorAccountType'
        accountCurrency:
          $ref: '#/components/schemas/IsoCurrencyCode'
        companyId:
          type: string
          description: Applicable to ACH Payments. Special reference on certain payment types for returns routing.
          minLength: 1
          maxLength: 35
    AmountDecimal:
      title: PaymentAmountDecimal
      type: string
      description: A String representation of a (potentially) whole number or decimal positive number. - Amount should be more than 0.01 with maximum of two decimal places allowed in most markets.
      minLength: 1
      maxLength: 40
      pattern: ^\d+(\.\d+)?$
    DateAndPlaceOfBirth:
      title: DateAndPlaceOfBirth
      description: Date and place of birth.
      allOf:
      - $ref: '#/components/schemas/BasicAddress'
      - $ref: '#/components/schemas/BirthDate'
    DebtorTaxInformation:
      type: object
      description: Debtor Tax Information
      title: DebtorTaxInformation
      required:
      - taxId
      properties:
        taxId:
          type: string
          minLength: 1
          maxLength: 35
        taxpayerCategory:
          type: string
          enum:
          - INDIVIDUAL
          - CORPORATE
        vatBranchCode:
          $ref: '#/components/schemas/VatBranchCode'
    Party:
      type: object
      title: Party
      description: Party
      required:
      - account
      additionalProperties: false
      properties:
        account:
          $ref: '#/components/schemas/Account'
        name:
          type: string
          minLength: 1
          maxLength: 140
          description: "Party name \n\n**Creditor Specific Constraints**:\n\nMandatory for RTP Markets :- \n- UK FPS \n- SEPA Instant\n- US RTP\n- Singapore, Australia, Mexico, Hong Kong, Brazil Faster Payments - **mandatory for Pay to Account transactions**.\n\nMandatory For Alternate Payments: \n- **Push To Card** - US, Canada\n\nMandatory for ACH Payments:   \n- Chile\n- US\n\nMaximum length supported per instrument/market:\n\n| Market/Instrument               \t| Maximum length limits |\n|-----------------------------------|-----------------------|\n| UK FPS                          \t| 40 \t                  |\n| SEPA Instant                    \t| 34 (IBAN)             |\n| SGP RTP                         \t| 140                  \t|\n| AUS RTP                         \t| 140                  \t|\n| HKG FPS                         \t| 140                   |\n| IND IMPS                        \t| 140                  \t|\n| P2C US and CA                     | 30                  \t|\n| MEX SPIE                        \t| 40                   \t|\n| ACH CHILE                         | 70                   \t|\n| ACH US               \t            | 22                    |\n\n---\n\n**Debtor specific constraints**:\n\nMandatory and supported by:\n- **ACH Chile**\n- **Push To Card** (P2C)\n- **US RTP**\n- **US FEDNOW**\n- **SARIE IPS**\n- **P2I Interac**\n- **Push To Wallet**\n\nMaximum length supported per instrument/market:\n\n| Market/Instrument     | Maximum length limits |\n|-----------------------|-----------------------|\n| US RTP                | 140\t                  |\n| P2C US and CA         | 30                    |\n| ACH Chile             | 140                   |"
        postalAddress:
          $ref: '#/components/schemas/Address'
        contactDetails:
          $ref: '#/components/schemas/ContactDetails'
        dateAndPlaceOfBirth:
          $ref: '#/components/schemas/DateAndPlaceOfBirth'
        countryOfResidence:
          $ref: '#/components/schemas/IsoCountryCode'
        device:
          $ref: '#/components/schemas/DeviceInfo'
        partyId:
          $ref: '#/components/schemas/PartyId'
    Invoicer:
      type: object
      title: Invoicer
      description: Invoicer party identification
      properties:
        partyId:
          $ref: '#/components/schemas/PartyId'
        name:
          type: string
          minLength: 1
          maxLength: 140
          description: Name of the party
        dateAndPlaceOfBirth:
          $ref: '#/components/schemas/DateAndPlaceOfBirth'
        countryOfResidence:
          $ref: '#/components/schemas/IsoCountryCode'
        postalAddress:
          $ref: '#/components/schemas/Address'
    PreviousInstructingAgent:
      title: PreviousInstructingAgent
      type: object
      description: 'Agent that previously handled the payment instruction. Usage: If more than one previous instructing agent is present, then position must be used to represent their order accordingly.

        - To support RTP adn WIRE payment flows for TP4, TP5 &amp; TPx use cases.'
      additionalProperties: false
      properties:
        position:
          type: integer
          format: int32
          minimum: 1
          maximum: 3
          description: Position of the previous instructing agent in the payment chain
        name:
          type: string
          minLength: 1
          maxLength: 140
          description: Name of the previous instructing agent
        account:
          oneOf:
          - $ref: '#/components/schemas/PrimaryAccountDetailsPreviousInstructingAgent'
          - $ref: '#/components/schemas/AlternateAccountDetails'
        financialInstitutionIds:
          type: array
          minItems: 1
          maxItems: 3
          items:
            $ref: '#/components/schemas/PreviousInstructingAgentFinancialInstitutionId'
        postalAddress:
          $ref: '#/components/schemas/Address'
        isForeignParty:
          type: boolean
      required:
      - name
    PaymentInitiationResponse:
      title: PaymentInitiationResponse
      type: object
      description: Representation of the Payment initiation response
      properties:
        paymentId:
          $ref: '#/components/schemas/PaymentId'
        paymentStatus:
          type: string
          enum:
          - RECEIVED
          - ACCEPTED
          - PROCESSING
          - CANCELED
          - REJECTED
          - COMPLETED
          - RETURNED
          description: The payment status indicates the current state of the payment
        paymentSubStatus:
          type: string
          description: The payment sub status provides the granular level payment status
          enum:
          - RECEIVED
          - ACCEPTED
          - PROCESSING_BY_JPM
          - PENDING_CLIENT_ACTION
          - PENDING_COMPLIANCE_REVIEW
          - PENDING_FRAUD_REVIEW
          - PENDING_FUNDING_REVIEW
          - PENDING_JPM_REVIEW
          - SCHEDULED
          - PENDING_POSTING
          - CANCELED
          - REJECTED
          - REJECTED_BY_JPM
          - COMPLETED_BY_JPM
          - SENT_TO_CLEARING
          - DELIVERED_TO_RECIPIENT
          - RETURNED
        statusUpdatedAt:
          type: string
          format: date-time
          description: 'The last updated date and time of the payment status in ISO 8601 format.

            The date &amp; time are expressed in UTC timezone (without offset)'
        requestedExecutionDate:
          type: string
          format: date
          description: "Requested execution date of the payment instruction (e.g. value date) in ISO 8601 `yyyy-mm-dd` format,\n must be either the current or future date.\n- This is the value date for EMEA ACH Payments"
        paymentIdentifiers:
          type: object
          title: PaymentIdentifiers
          description: Identifiers associated with the Payment Instruction throughout its lifecycle.
          properties:
            endToEndId:
              $ref: '#/components/schemas/EndToEndId'
          required:
          - endToEndId
        paymentBatchId:
          type: string
          minLength: 1
          description: 'JPMC issued batch Id for the payment

            **NOTE: Applicable only for payments batched by JPMC. i.e ACH**'
        transferType:
          $ref: '#/components/schemas/TransferType'
        paymentType:
          $ref: '#/components/schemas/PaymentType'
      required:
      - paymentId
      - paymentStatus
      - statusUpdatedAt
      - requestedExecutionDate
      - paymentIdentifiers
      - transferType
      - paymentType
    PaymentEventData:
      title: Payment Event Data
      description: Representation of Payment Event Data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PaymentEvent'
    AdditionalParties:
      type: object
      title: Additional Parties
      description: Additional parties involved in the money movement.
      properties:
        ultimateDebtor:
          $ref: '#/components/schemas/UltimateParty'
        ultimateCreditor:
          $ref: '#/components/schemas/UltimateParty'
        initiatingParty:
          $ref: '#/components/schemas/InitiatingParty'
        instructedAgent:
          $ref: '#/components/schemas/DebtorFinancialInstitutionId'
        previousInstructingAgents:
          type: array
          minItems: 1
          maxItems: 3
          items:
            $ref: '#/components/schemas/PreviousInstructingAgent'
        additionalCreditors:
          type: array
          minItems: 1
          maxItems: 10
          items:
            $ref: '#/components/schemas/AdditionalCreditor'
        intermediaryAgents:
          type: array
          minItems: 1
          maxItems: 3
          items:
            $ref: '#/components/schemas/IntermediaryAgent'
    DebtorAgent:
      title: DebtorAgent
      type: object
      description: Debtor Agent
      additionalProperties: false
      minProperties: 1
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 140
          description: Name of the agent
        financialInstitutionIds:
          type: array
          description: Conditional for WIRE payments (PACS.008/PACS.009) and required for other payment types.
          minItems: 1
          maxItems: 3
          items:
            $ref: '#/components/schemas/DebtorFinancialInstitutionId'
        postalAddress:
          $ref: '#/components/schemas/Address'
        additionalInstitutions:
          $ref: '#/components/schemas/AdditionalInstitutions'
    PaymentTypeInformation:
      type: object
      title: Payment Type information
      description: A set of coded elements that further specifies the type of Payment
      minProperties: 1
      properties:
        serviceLevelCode:
          type: string
          description: 'Specifies an agreed service level under which the payment should be processed based on a set of pre-defined categories.


            |ServiceLevelCode | Meaning

            |-----------------|-----------------

            |**NURG**         | Non Urgent

            |**URGP**         | Urgent

            |**SDVA**         | Same Day Value

            |**URNS**         | Urgent Payment Net Settlement

            |**BKTR**         | Book'
          enum:
          - NURG
          - SEPA
          - SDVA
          - URNS
          - BKTR
          - URGP
        localInstrumentCode:
          $ref: '#/components/schemas/LocalInstrument'
        paymentContext:
          $ref: '#/components/schemas/PaymentContext'
        clearingSystem:
          $ref: '#/components/schemas/ClearingSystemClientVersion'
    PartyId:
      title: PartyId
      description: Party Identification
      oneOf:
      - $ref: '#/components/schemas/OrganizationIdentification'
      - $ref: '#/components/schemas/IndividualIdentification'
      example:
        organizationIds:
        - organizationId: '123456'
          schemeName:
            proprietary: JPMCOID
    ClearingSystemClientVersion:
      type: object
      title: ClearingSystem
      description: Clearing system used for the payment. The clearing system is a network that facilitates the transfer of funds between banks or financial institutions. It acts as an intermediary, ensuring that transactions are processed securely and efficiently.
      properties:
        name:
          type: string
          description: Name of the clearing system
          minLength: 3
          maxLength: 10
    AccountType:
      title: AccountType
      type: string
      enum:
      - DDA
      - BDA
      - CARD
      - LOAN
      - ODFT
      - NREX
      - CACC
      - SVGS
      - CACR
      - NROR
      - SNRR
      - TRAN
      - CLABE
      - VOSTRO
      - IBAN
      - BBAN
      - DFLT
      - SLRY
      - EMBEDDED_DDA
      - LIMITED_DDA
      - WALLET
      - VAM
      - INTERAC
      - PAYPAL
      - VENMO
      - OTHER
      description: "**Mandatory for** :\n - India IMPS\n - Malaysia NPP \n - Brazil RTP (Pay to account only)\n - Blockchain Payments \n - US ACH (IAT and NON IAT)\n\n**India IMPS**:\n  - LOAN - Loan account\n  - ODFT - Overdraft\n  - NREX - NonResidentExternal\n  - OTHER - For Book and cross branch with VRN accounts\n  - CACC - Cash Credit/Current account\n  - DDA - DDA account\n  - SVGS - Savings account\n  - CACR - Cash Credit Account\n  - NROR - Non-Resident Ordinary Account\n  - SNRR - Special Non-Resident Rupee Account\n\n**SEPA Instant**: IBAN\n\n**Hong Kong RTP**: BBAN\n\n**Malaysia NPP**:\n  - LOAN\n  - DFLT\n  - SVGS\n  - CACC\n\n**Brazil RTP**: \n  - CACC\n  - SLRY\n  - TRAN\n  - SVGS\n\n**Mexico RTP**: \n  - CLABE\n  - VOSTRO\n  - DDA\n\n**Blockchain Payments**:\n  - DDA\n  - BDA - Blockchain Deposit Account\n\n**US ACH**: \n  - CACC \n  - SVGS \n  - LOAN\n\nOptional for:\n  - CAD ACH\n\n**Not supported for**:\n- US RTP\n- Alternate Payments (Wallet, Cards)"
    PrimaryAccountDetails:
      type: object
      title: Primary Account Details
      description: Account Details
      required:
      - accountNumber
      properties:
        accountNumber:
          $ref: '#/components/schemas/AccountId'
        accountType:
          $ref: '#/components/schemas/AccountType'
        accountCurrency:
          $ref: '#/components/schemas/IsoCurrencyCode'
        companyId:
          type: string
          description: Applicable to ACH Payments. Special reference on certain payment types for returns routing.
          minLength: 1
          maxLength: 35
    ErrorContext_2:
      title: ErrorContext
      type: object
      properties:
        code:
          type: string
          description: JPMC Short code that identifies the error - publicly cataloged and documented
          minLength: 5
          maxLength: 5
        message:
          type: string
          description: Humanly readable textual description of the error
          minLength: 1
          maxLength: 99
        location:
          type: string
          description: The location of the error occurred in the request.
          enum:
          - BODY
          - PATH
          - QUERY
          - HEADER
          minLength: 1
          maxLength: 99
        field:
          type: string
          description: The field which caused the error. Where the location of error occurred is BODY the field would contain the JSON Path expression
          minLength: 1
          maxLength: 99
      required:
      - message
    ISOCurrencyCode:
      title: ISOCurrencyCode
      description: '**Currency of the money movement**: a 3 alpha character ISO 4217 currency code.'
      type: string
      minLength: 3
      maxLength: 3
      pattern: ^[A-Z]{3}$
      example: EUR
    AccountIdType:
      title: AccountIdType
      type: string
      description: The account identifier type
      enum:
      - SORT_CODE
      - IBAN
    ProviderName:
      title: ProviderName
      type: string
      description: "Optional name of a pre-selected Provider (sourced from the providers list). \n              \nProviding this field will skip the bank selection screen for the end-user using the payment link."
      example: uk-santander-oauth2
      minLength: 2
      maxLength: 64
    PaymentAmount:
      title: PaymentAmount
      type: object
      description: "The amount value and currency of a payment amount should be more than 0.01 with maximum of two decimal places allowed.\n\n**Payment amount limits vary depending upon markets and financial institutions.**\n\n**Refer to the table below for current limits.**\n\n  | Market                             | Payment limits (per transaction)| Reference|\n  | -----------------------------------|---------------------------------|----------|\n  | United Kingdom (FASTER_PAYMENTS)   | GBP 1,000,000                   | Refer to [Pay UK FPS Transaction Limits](https://www.wearepay.uk/what-we-do/payment-systems/faster-payment-system/transaction-limits/) for confirmation.|\n  | SEPA (SEPA_INSTANT_CREDIT_TRANSFER)| EUR 100,000                     | Refer to [European Payments Council(EPC) SEPA Instant Transaction Limits](https://www.europeanpaymentscouncil.eu/document-library/rulebooks/maximum-amount-instructions-under-2023-sepa-instant-credit-transfer-0) for confirmation.|\n  | SEPA (SEPA_CREDIT_TRANSFER)        | EUR 999,999,999.99              | Refer to [EPC SCT Rulebook](https://www.europeanpaymentscouncil.eu/what-we-do/epc-payment-schemes/sepa-credit-transfer/sepa-credit-transfer-rulebook-and)"
      properties:
        value:
          $ref: '#/components/schemas/Value_2'
        currency:
          $ref: '#/components/schemas/ISOCurrencyCode'
      required:
      - value
      - currency
    StatusUpdatedAt:
      title: StatusUpdatedAt
      type: string
      format: date-time
      description: The last updated date and time of the status, in ISO 8601 format.
    Value_2:
      title: Value
      type: string
      minLength: 3
      maxLength: 18
      pattern: ^(\d{1,15})\.(\d{2})$
      example: '10.50'
      description: The value representation of a monetary amount. The amount value should be more than 0.01 with maximum of two decimal places allowed.
    Error_2:
      title: Error
      type: object
      description: The error object returned by the API.
      properties:
        title:
          type: string
          description: Short humanly-readable title of the error
          minLength: 1
          maxLength: 99
        httpStatus:
          type: integer
          format: int32
          description: HTTP Status Code
        traceId:
          type: string
          description: JPMC assigned trace identifier
          minLength: 1
          maxLength: 99
        requestId:
          type: string
          description: The client originated requestId
          minLength: 1
          maxLength: 99
        context:
          type: array
          description: Provides additional context and detail on the validation errors
          minItems: 1
          maxItems: 99
          items:
            $ref: '#/components/schemas/ErrorContext_2'
      required:
      - title
    PaymentResponseMetadata:
      title: PaymentResponseMetadata
      type: object
      properties:
        id:
          $ref: '#/components/schemas/PaymentId_2'
        status:
          type: string
          description: "The status of the submitted payment request\n\n**Refer to the table below for the supported statuses**:\n\n  | Status        | Description                                                                         |\n  | --------------|-------------------------------------------------------------------------------------|\n  | **NONE**      | The initial status for a payment. Indicates nothing has happened yet                |\n  | **SENT**      | Payment has been SENT                                                               |\n  | **SETTLED**  | The Payment was seen on recipient's account                                         |\n  | **FAILED**    | Attempt ended with error status. The details can be found in statusMessage field    |\n  | **CANCELLED** | The Payment was unsucessful due to an unexpected error e.g. a user fails to authorize a payment. |"
        statusUpdatedAt:
          $ref: '#/components/schemas/StatusUpdatedAt'
        statusMessage:
          type: string
          description: 'A textual description of the status.


            ***NOTE: Only applicable when the status is FAILED or CANCELLED***'
          minLength: 1
          maxLength: 128
        createdAt:
          type: string
          format: date-time
          description: Indicates when the Payment request was created in the system. Follows ISO date time format.
        paymentLinkURL:
          type: string
          format: uri-reference
          description: An HTTPS URL to make the payment
        paymentQRCode:
          type: string
          description: An HTTPS URL to download the QR code image to make the payment.
        acknowledged:
          type: string
          description: Indicates if the payment has been acknowledged or not.
          readOnly: true
          default: UNKNOWN
          enum:
          - ACKNOWLEDGED
          - NOT_ACKNOWLEDGED
          - UNKNOWN
    Debtor:
      title: Debtor
      type: object
      description: 'The party that pays for goods and services or sends funds.

        *The debtor IBAN can be prefilled by the payment initiator:*

        - If prefilled, the user will not be allowed to change the IBAN afterwards.

        - The account selection experience will be skipped.'
      allOf:
      - $ref: '#/components/schemas/Party_2'
    PaymentId_2:
      allOf:
      - type: string
        description: A unique identifier of the payment
      - $ref: '#/components/schemas/UniqueResourceIdentifier'
    Reference:
      title: Reference
      type: string
      description: A free text field that can be used to provide a meaningful reference for a payment transaction
      minLength: 1
      maxLength: 35
    Market:
      title: Market
      type: string
      description: 'ISO 3166-1 alpha-2 country code for the market where the payment is initiated.


        - **Market Coverage**: `DE`, `ES`, `GB`, `IT`'
      minLength: 2
      maxLength: 2
      pattern: ^[A-Z]{2}$
    AccountId_2:
      title: AccountId
      type: string
      minLength: 6
      maxLength: 34
      description: "Debtor account number as identified by the bank or financial institution.\n\n**Maximum length supported for each instrument and market. Refer to the table below**\n\n  | Market                             | Maximum field length                                          |\n  | -----------------------------------|---------------------------------------------------------------|\n  | United Kingdom |\t14 ( 6 digit Sort Code and 8 digit Account Number - 7 digit A/C numbers should be padded with a leading zero) |\n  | SEPA           |  34 (IBAN)                                                    |"
    PaymentType_2:
      type: string
      description: "The type of payment.\n\n  List of supported payment types, their usage and categorization by region:\n\n  Payment Type             | Description\n  -------------------------|-----------------------------------------------------------------------\n  **REAL_TIME_PAYMENTS**   | *Real-time Payments (Instant)* - `FASTER_PAYMENTS`, `SEPA_INSTANT_CREDIT_TRANSFER`\n  **LOW_VALUE_PAYMENTS**    | *Low-value Retail Payments* -  `BACS`, `SEPA_CREDIT_TRANSFER`\n  **HIGH_VALUE_PAYMENTS** | *High Value Business Payments* -  `CHAPS`\n  ---\n\n | | **Real-time Payments (INSTANT)**       | **Low Value Payments** | **High-Value Payments**    |\n |:-----------------:|:--------------------------------------:|:--------------------------------------:|:----------------------------------:|\n | **UK**            | Faster Payments                        |           BACS                     | CHAPS |\n | **SEPA**          | SEPA Instant Credit Transfer           | SEPA Credit Transfer |                       |\n\n **Real-time payments**: refer to payment solutions that process and settle financial transactions in real-time, typically within seconds, without any waiting period.\n\n **Low-value payments**: pertain to high-volume, low-value transactions mainly conducted by individuals or businesses for day-to-day expenses. These payments are usually processed in batches, not in real-time.\n\n **High Value Payments**: refer to large-sum transactions that are typically exchanged between banks or financial institutions."
      enum:
      - REAL_TIME_PAYMENTS
      - LOW_VALUE_PAYMENTS
      - HIGH_VALUE_PAYMENTS
    Creditor:
      title: Creditor
      type: object
      description: The recipient of funds in the context of a payment.
      allOf:
      - $ref: '#/components/schemas/Party_2'
      required:
      - name
      - account
    PaymentResponse:
      allOf:
      - $ref: '#/components/schemas/PaymentResponseMetadata'
      - $ref: '#/components/schemas/Payments'
    Party_2:
      title: Party
      type: object
      description: Representation of a **Sender** or **Recipient** of funds within the context of a payment.
      properties:
        name:
          $ref: '#/components/schemas/Name'
        account:
          $ref: '#/components/schemas/Account_2'
    Account_2:
      title: Account
      type: object
      description: Captures account information
      properties:
        accountId:
          $ref: '#/components/schemas/AccountId_2'
        accountIdType:
          $ref: '#/components/schemas/AccountIdType'
      required:
      - accountId
      - accountIdType
    Payments:
      title: Payments
      type: object
      properties:
        paymentAmount:
          $ref: '#/components/schemas/PaymentAmount'
        paymentType:
          $ref: '#/components/schemas/PaymentType_2'
        market:
          $ref: '#/components/schemas/Market'
        redirectURL:
          type: string
          format: uri-reference
          description: An optional re-direct URL of the merchant where the end-user will be redirected to once they have successfully authorized the payment with their bank or financial institution.
        debtor:
          $ref: '#/components/schemas/Debtor'
        creditor:
          $ref: '#/components/schemas/Creditor'
        reference:
          $ref: '#/components/schemas/Reference'
        providerName:
          $ref: '#/components/schemas/ProviderName'
      required:
      - paymentAmount
      - paymentType
      - market
      - creditor
      - reference
    Name:
      title: Name
      type: string
      description: Name
      minLength: 1
      maxLength: 140
    UniqueResourceIdentifier:
      title: Identifier
      description: An immutable opaque string that uniquely identifies a resource.
      type: string
      minLength: 36
      maxLength: 36
      pattern: ^[-_.a-zA-Z0-9]{36}$
      example: 1b036f9c-8c84-4ce6-b1dd-5979472945a1
  examples:
    AlternateP2WZelle:
      summary: Alternate Payments - Zelle
      value:
        requestedExecutionDate: '2024-10-30'
        paymentIdentifiers:
          endToEndId: ZELLETEST
        transferType: CREDIT
        value:
          currency: USD
          amount: '0.1'
        paymentType: ZELLE
        debtor:
          name: John Doe
          account:
            accountNumber: '123456789'
        debtorAgent:
          financialInstitutionIds:
          - id: CHASUS33
            idType: BIC
        creditor:
          account:
            alternateAccountIdentifiers:
            - identifier: Jane.Doe@example.com
              idType: PROPRIETARY
              proprietarySchemeName: EMAL
          name: Jane Doe
    RealTimeSGFPS:
      summary: RTP - Payment Initiation - Singapore RTP
      value:
        requestedExecutionDate: '2024-10-03'
        paymentIdentifiers:
          endToEndId: SGFASTERPMT
        transferType: CREDIT
        value:
          currency: SGD
          amount: '10.01'
        paymentType: RTP
        debtor:
          account:
            accountNumber: '123456789'
            accountCurrency: SGD
            accountType: DDA
        debtorAgent:
          financialInstitutionIds:
          - id: CHASSGSG
            idType: BIC
        creditor:
          name: Jane Doe
          account:
            accountNumber: '999000111'
          postalAddress:
            streetName: Jefferson Drive
            buildingNumber: '23'
            postalCode: '289963'
            city: Singapore
            country: SG
        creditorAgent:
          financialInstitutionIds:
          - id: OCBCSGSG
            idType: BIC
        paymentPurpose:
          purpose:
            code: GDDS
        remittanceInformation:
          unstructuredInformation:
          - text: 'Payment for Furniture. Invoice #1211'
    ErrorNotFound:
      summary: Not Found
      value:
        title: Not Found
        httpStatus: 404
        traceId: 00-d45503a0a3fb4915bb5749e58cf01f1a-47ac5b7550a4064e-01
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
    PaymentInitiationDuplicateResponse:
      summary: Duplicate Payment Response
      value:
        duplicateOf:
          paymentId: 95364018-be32-4c71-9618-f1ceba78f28c
          paymentIdentifiers:
            endToEndId: E2E1234567890
        links:
          payment: /payment/v2/payments/95364018-be32-4c71-9618-f1ceba78f28c
        reason:
          code: '11909'
          location: BODY
          message: This is a business duplicate, refer to documentation.
    RealTimeAUNPPCrossBorderTP3:
      summary: RTP - Payment Initiation - Australia NPP Cross Border - TP3
      value:
        requestedExecutionDate: '2025-10-27'
        paymentIdentifiers:
          endToEndId: 20251014ABCDEFKX010OCB13784502-XBRD
        value:
          currency: AUD
          amount: '59.32'
        transferType: CREDIT
        paymentType: RTP
        paymentTypeInformation:
          localInstrumentCode:
            proprietary: NPCCT
        debtor:
          name: John Doe
          postalAddress:
            city: Sydney
            country: AU
          account:
            accountNumber: '19881111'
            accountCurrency: AUD
            accountType: DDA
        debtorAgent:
          financialInstitutionIds:
          - id: CHASAU2X
            idType: BIC
        creditor:
          account:
            accountNumber: '12345678'
          name: Jane Doe
          countryOfResidence: AU
          postalAddress:
            type: ADDR
            streetName: Station Street
            buildingNumber: '40'
            postalCode: '3000'
            city: Melbourne
            countrySubDivision: VIC
            country: AU
        creditorAgent:
          financialInstitutionIds:
          - id: '12456'
            idType: CLEARING_SYSTEM_ID
          name: National Australia Bank
          postalAddress:
            city: Melbourne
            country: AU
        additionalParties:
          ultimateDebtor:
            name: John Doe
            account:
              accountNumber: '1234567800'
            partyId:
              organizationIds:
              - organizationId: TX270009999
                issuer: AUS GOV TAX DEPT
                bic: MRMDUS33
            postalAddress:
              type: HOME
              buildingNumber: '14'
              streetName: Frost Street
              city: Beverley Hills
              country: US
    RealTimeSEPAInstantPmtQueryResponseFull:
      summary: SEPA Instant - Payment Query Response (FULL)
      value:
        payments:
        - paymentId: 98275a2d-1e88-beed-6938-0521a7e0xatt
          paymentStatus: PROCESSING
          paymentSubStatus: PROCESSING_BY_JPM
          statusUpdatedAt: '2024-10-15T14:15:22Z'
          requestedExecutionDate: '2024-10-15'
          paymentIdentifiers:
            endToEndId: SEPAINSTANTTEST-XBRD
          value:
            currency: EUR
            amount: '40.01'
          transferType: CREDIT
          paymentType: RTP
          debtor:
            account:
              accountNumber: DE12345678912345678963
            name: JPM Client Corp
            postalAddress:
              city: Frankfurt
              country: DE
          debtorAgent:
            financialInstitutionIds:
            - id: CHASDEFX
              idType: BIC
          creditor:
            account:
              accountNumber: DE4564567891234567899
            name: TEST ACCOUNT
            postalAddress:
              city: Berlin
              country: DE
          creditorAgent:
            financialInstitutionIds:
            - id: CHASDEFX
              idType: BIC
    RealTimeSEPAInstant:
      summary: RTP - Payment Initiation - SEPA Instant
      value:
        requestedExecutionDate: '2024-10-15'
        paymentIdentifiers:
          endToEndId: SEPAINSTANTTEST-XBRD
        value:
          currency: EUR
          amount: '40.01'
        transferType: CREDIT
        paymentType: RTP
        debtor:
          account:
            accountNumber: DE12345678912345678963
          name: JPM Client Corp
          postalAddress:
            city: Frankfurt
            country: DE
        debtorAgent:
          financialInstitutionIds:
          - id: CHASDEFX
            idType: BIC
        creditor:
          account:
            accountNumber: DE4564567891234567899
          name: TEST ACCOUNT
          postalAddress:
            city: Berlin
            country: DE
        creditorAgent:
          financialInstitutionIds:
          - id: CHASDEFX
            idType: BIC
    ErrorUnauthorized:
      summary: Authorization Failure
      value:
        title: Authorization Failure
        httpStatus: 403
        traceId: 00-d45503a0a3fb4915bb5749e58cf01f1a-47ac5b7550a4064e-01
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - code: '14000'
          message: Client forbidden from accessing the requested resource
    RealTimeINIMPSRDA:
      summary: RTP - Payment Initiation - India IMPS RDA Flow (Foreign Inward Remittance)
      value:
        requestedExecutionDate: '2025-10-22'
        paymentIdentifiers:
          endToEndId: INIMPSTESTRDA-XBRD
        transferType: CREDIT
        value:
          currency: INR
          amount: '100000.00'
        paymentType: RTP
        additionalParties:
          ultimateDebtor:
            partyId:
              individualIds:
              - individualId: ID123456789
            name: John Doe
            countriesOfNationality:
            - GB
            postalAddress:
              type: HOME
              addressLines:
              - 123 Main Street
              - '500000'
              city: London
              country: GB
        debtor:
          name: ABC Corp
          postalAddress:
            city: Mumbai
            country: IN
          account:
            accountNumber: '123456789'
            accountCurrency: INR
            accountType: DDA
        debtorAgent:
          financialInstitutionIds:
          - id: CHASINBX
            idType: BIC
        creditor:
          name: Jane Doe
          account:
            accountNumber: '9876543210'
            accountType: NREX
        creditorAgent:
          financialInstitutionIds:
          - id: HDFC0CPNSBL
            idType: CLEARING_SYSTEM_ID
          name: HDFC Bank
          postalAddress:
            city: Mumbai
            country: IN
        remittanceInformation:
          unstructuredInformation:
          - text: Family Maintenance
    RealTimeTHPromptPayProxy:
      summary: RTP - Payment Initiation - Thailand PromptPay (Pay-to-Proxy) - Mobile Number
      value:
        requestedExecutionDate: '2025-01-30'
        paymentIdentifiers:
          endToEndId: THPPTESTPF
        value:
          currency: THB
          amount: '12.34'
        transferType: CREDIT
        paymentType: RTP
        paymentTypeInformation:
          localInstrumentCode:
            proprietary: PPDCT
        debtor:
          name: John Doe
          account:
            accountNumber: '19881111'
            accountCurrency: THB
            accountType: DDA
        debtorAgent:
          financialInstitutionIds:
          - id: CHASTHBX
            idType: BIC
        creditor:
          account:
            alternateAccountIdentifiers:
            - identifier: '+66123456789'
              idType: PROPRIETARY
              proprietarySchemeName: MBNO
    AlternateKinexysDigitalPaymentsBDAtoBDA:
      summary: Alternate Payments - Kinexys Digital Payments - Same Branch USD Transfer (BDA to BDA)
      value:
        requestedExecutionDate: '2024-10-30'
        paymentIdentifiers:
          endToEndId: KINEXYSTEST2
        transferType: CREDIT
        value:
          currency: USD
          amount: '6500'
        paymentType: BLOCKCHAIN
        debtor:
          account:
            accountNumber: '987654321'
            accountType: BDA
        debtorAgent:
          financialInstitutionIds:
          - id: CHASUS33
            idType: BIC
        creditor:
          account:
            accountNumber: '123456789'
            accountType: BDA
        creditorAgent:
          financialInstitutionIds:
          - id: CHASESM3
            idType: BIC
        remittanceInformation:
          unstructuredInformation:
          - text: Payment for container shipment
    AchUSDebitTransfer:
      summary: ACH - US Debit Transfer
      value:
        requestedExecutionDate: '2025-07-10'
        paymentIdentifiers:
          endToEndId: USACHDBTEST
        value:
          currency: USD
          amount: '3.00'
        transferType: DEBIT
        paymentType: ACH
        paymentTypeInformation:
          serviceLevelCode: NURG
          localInstrumentCode:
            code: PPD
        creditor:
          account:
            accountNumber: 0616759257
            companyId: '1590925701'
          name: John Doe
          postalAddress:
            country: US
            buildingNumber: '000'
            streetName: Madison Lane
            city: Chicago
            postalCode: '60603'
            countrySubDivision: IL
        creditorAgent:
          name: JP Morgan Chase
          financialInstitutionIds:
          - id: '021000021'
            idType: USABA
          postalAddress:
            country: US
        debtor:
          name: Jane Doe
          account:
            accountNumber: '9876543210'
            accountCurrency: USD
          postalAddress:
            buildingNumber: '000'
            streetName: Voltage Street
            city: Toronto
            postalCode: M4C1B5
            countrySubDivision: '21'
            country: US
        debtorAgent:
          name: JP morgan Chase
          financialInstitutionIds:
          - id: '021000021'
            idType: USABA
          postalAddress:
            country: US
        remittanceInformation:
          unstructuredInformation:
          - text: Music services INV#09900
        paymentPurpose:
          categoryPurpose:
            proprietary: ACCTVERIFY
        taxInformation:
          type: TAX_PAYMENT
    AlternateP2CTP3:
      summary: Alternate Payments - Push To Card TP3(Third Party Processor)
      value:
        requestedExecutionDate: '2024-10-30'
        paymentIdentifiers:
          endToEndId: tp30t92e023g11354100
        transferType: CREDIT
        value:
          currency: USD
          amount: '750'
        paymentType: CARD
        debtor:
          name: Steven Pinker
          account:
            alternateAccountIdentifiers:
            - identifier: PRU01US
              idType: PROGRAM_ID
        debtorAgent:
          financialInstitutionIds:
          - id: CHASUS33
            idType: BIC
        creditor:
          name: Kyle Winters
          account:
            card:
              pan: 0123456789009999
              expiryDate: '2710'
        additionalParties:
          ultimateDebtor:
            partyId:
              individualIds:
              - individualId: '1098765432'
            name: Donny Osmond
            postalAddress:
              country: US
              streetName: 123 Main Street
              buildingNumber: '1'
              postalCode: '07030'
              city: Jersey City
              countrySubDivision: NJ
            dateAndPlaceOfBirth:
              birthDate: '1994-03-14'
        remittanceInformation:
          unstructuredInformation:
          - text: InsurancePmt
    AlternateKinexysDigitalPaymentsDDAtoBDAStatusWebhook-CE:
      summary: Kinexys Digital Payments (DDA to BDA) Completed Status Webhook
      value:
        specversion: '1.0'
        id: 3c44ab18-889b-452a-962c-76827099d0d1
        time: '2024-10-30T14:15:23Z'
        type: Payment.Completed
        source: /payment/v2/payments?endToEndId=202E092v021D35E4
        dataschema: urn:com.jpmorgan.payments/payment-event
        data:
          payments:
          - paymentId: 989a066e-2947-4fa9-9ec7-5d09b1917c11
            paymentStatus: COMPLETED
            paymentSubStatus: COMPLETED_BY_JPM
            statusUpdatedAt: '2024-10-30T14:15:22Z'
            requestedExecutionDate: '2024-10-30'
            paymentIdentifiers:
              endToEndId: 202E092v021D35E4
            transferType: CREDIT
            paymentType: BLOCKCHAIN
    ACHBatch-CE:
      summary: ACH Batch Payment Event
      value:
        specversion: '1.0'
        id: 9f8c4e4a-3b7d-4f2a-9c1e-2b5e4f3a6d7
        time: '2024-10-30T14:15:24Z'
        type: PaymentBatch.Completed
        source: /payments
        dataschema: urn:com.jpmorgan.payments/payments-event
        data:
          payments:
          - paymentId: 0d44d8ae-3bb5-43e4-ab6e-fe670571ab77
            paymentStatus: COMPLETED
            statusUpdatedAt: '2024-10-01T14:15:22Z'
            requestedExecutionDate: '2024-10-01'
            valueDate: '2024-10-02'
            paymentIdentifiers:
              endToEndId: AAU3000100
              paymentBatchId: QWDQGHW8
              achTraceNumber: '021000022125471'
            transferType: CREDIT
            paymentType: ACH
          - paymentId: ea72b291-d06d-47a1-83a4-8d6f25446549
            paymentStatus: COMPLETED
            statusUpdatedAt: '2024-10-01T14:15:25Z'
            requestedExecutionDate: '2024-10-02'
            paymentIdentifiers:
              endToEndId: ACAC3000108
              paymentBatchId: QWDQGHW8
              achTraceNumber: '021000022125470'
            transferType: CREDIT
            paymentType: ACH
          - paymentId: 04487804-5e33-46e2-8b62-0207cabc499e
            paymentStatus: COMPLETED
            statusUpdatedAt: '2024-10-01T14:15:30Z'
            requestedExecutionDate: '2024-10-03'
            paymentIdentifiers:
              endToEndId: AAU3000101
              paymentBatchId: QWDQGHW8
              achTraceNumber: '021000022125450'
            transferType: CREDIT
            paymentType: ACH
    RealTimeSEPAInstantPmtQueryResponseSummary:
      summary: SEPA Instant - Payment Query Response (SUMMARY)
      value:
        payments:
        - paymentId: 98275a2d-1e88-beed-6938-0521a7e0xatt
          paymentStatus: PROCESSING
          paymentSubStatus: PROCESSING_BY_JPM
          statusUpdatedAt: '2024-10-15T14:15:22Z'
          requestedExecutionDate: '2024-10-15'
          paymentIdentifiers:
            endToEndId: SEPAINSTANTTEST-XBRD
          transferType: CREDIT
          paymentType: RTP
    ErrorBusinessValidation:
      summary: Business Validation Failure
      value:
        title: Business Validation Failure
        httpStatus: 400
        traceId: 00-d45503a0a3fb4915bb5749e58cf01f1a-47ac5b7550a4064e-01
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - code: '11002'
          message: Creditor account is closed
          location: BODY
          field: $.creditor.account
          additionalContext:
          - code: AC03
            type: ISO20022
            message: Creditor account is closed
          - code: CLR119
            type: CLEARING_NACHA
            message: Error on Creditor Account Number
    ErrorInvalidData:
      summary: Invalid Data Error
      value:
        title: Invalid Data
        httpStatus: 400
        traceId: 00-d45503a0a3fb4915bb5749e58cf01f1a-47ac5b7550a4064e-01
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - code: '10001'
          message: Mandatory field is missing
          location: BODY
          field: $.creditor.account
          additionalContext:
          - code: AC03
            type: ISO20022
            message: Creditor account number is missing or invalid
    RealTimeUKFPSPmtStatus:
      summary: RTP - UK FPS - (SUMMARY)
      value:
        paymentId: 95364018-be32-4c71-9618-f1ceba78f28c
        paymentStatus: PROCESSING
        paymentSubStatus: PROCESSING_BY_JPM
        statusUpdatedAt: '2024-10-22T14:15:22Z'
        requestedExecutionDate: '2024-10-22'
        paymentIdentifiers:
          endToEndId: UKFPSTEST
        transferType: CREDIT
        paymentType: RTP
    RealTimeAUNPPCrossBorderTP4:
      summary: RTP - Payment Initiation - Australia NPP Cross Border - TP4
      value:
        requestedExecutionDate: '2025-10-27'
        paymentIdentifiers:
          endToEndId: 20251014ABCDEFKX010OCB13784501-XBRD
        value:
          currency: AUD
          amount: '59.32'
        transferType: CREDIT
        paymentType: RTP
        paymentTypeInformation:
          localInstrumentCode:
            proprietary: NPCCT
        debtor:
          name: John Doe
          postalAddress:
            city: Sydney
            country: AU
          account:
            accountNumber: '19881111'
            accountCurrency: AUD
            accountType: DDA
        debtorAgent:
          financialInstitutionIds:
          - id: CHASAU2X
            idType: BIC
        creditor:
          account:
            accountNumber: '12345678'
          name: Jane Doe
          countryOfResidence: AU
          postalAddress:
            type: ADDR
            streetName: Station Street
            buildingNumber: '40'
            postalCode: '3000'
            city: Melbourne
            countrySubDivision: VIC
            country: AU
        creditorAgent:
          financialInstitutionIds:
          - id: '12456'
            idType: CLEARING_SYSTEM_ID
          name: National Australia Bank
          postalAddress:
            city: Melbourne
            country: AU
        additionalParties:
          initiatingParty:
            name: Moneygram Ltd
            partyId:
              organizationIds:
              - organizationId: TX270009999
                issuer: US GOV TAX DEPT
                bic: ABCDUS33
            postalAddress:
              type: ADDR
              buildingNumber: '14'
              streetName: Frost Street
              postalCode: '10001'
              countrySubDivision: NY
              city: New York
              country: US
          ultimateDebtor:
            name: John Doe
            account:
              accountNumber: '1234567800'
            partyId:
              organizationIds:
              - organizationId: TX270009900
                issuer: AUS GOV TAX DEPT
                bic: MRMDUS33
            postalAddress:
              type: HOME
              buildingNumber: '14'
              streetName: Frost Street
              city: Beverley Hills
              country: US
    RealTimeUKFPSAgencyBanking:
      summary: RTP - Payment Initiation - UK FPS Agency Banking
      value:
        requestedExecutionDate: '2025-07-31'
        paymentIdentifiers:
          endToEndId: UK20250907T125
        value:
          currency: GBP
          amount: '1.01'
        transferType: CREDIT
        paymentType: RTP
        debtor:
          account:
            accountNumber: '12345678'
            accountType: DDA
            accountCurrency: GBP
          name: Ultimate Payer Name (JPM client's client)
          postalAddress:
            streetName: Payer streetName
            postalCode: R123456
            city: TownName
            country: GB
        debtorAgent:
          financialInstitutionIds:
          - id: 043486
            idType: SORT_CODE
          postalAddress:
            country: GB
        creditor:
          account:
            accountNumber: '987654321'
          name: Creditor Name
          postalAddress:
            streetName: Creditor streetName
            postalCode: R123456
            city: TownName
            country: GB
        creditorAgent:
          financialInstitutionIds:
          - id: 042920
            idType: CLEARING_SYSTEM_ID
        remittanceInformation:
          unstructuredInformation:
          - text: Remittance Information
    RealTimeHKFPS:
      summary: RTP - Payment Initiation - Hong Kong RTP
      value:
        requestedExecutionDate: '2024-10-15'
        paymentIdentifiers:
          endToEndId: HKFASTERPMT
        transferType: CREDIT
        value:
          currency: HKD
          amount: '75'
        paymentType: RTP
        debtor:
          account:
            accountNumber: '123456789'
            accountCurrency: HKD
        debtorAgent:
          financialInstitutionIds:
          - id: CHASHKHH
            idType: BIC
        creditor:
          name: Test Account
          account:
            accountNumber: '987654321'
            accountType: BBAN
          postalAddress:
            streetName: Main Road
            buildingNumber: 02, 2/F
            postalCode: '999088'
            city: Hong Kong
            country: HK
            countrySubDivision: WC
          dateAndPlaceOfBirth:
            birthDate: '1980-10-20'
            city: Hong Kong
            country: HK
        creditorAgent:
          financialInstitutionIds:
          - id: '004'
            idType: CLEARING_SYSTEM_ID
        paymentPurpose:
          categoryPurpose:
            proprietary: CXBSNS
        remittanceInformation:
          unstructuredInformation:
          - text: ' Invoice number for John Smith'
    IdempotencyFailure:
      summary: Unprocessable Entity - Idempotency Failure
      value:
        title: Idempotency Failure
        httpStatus: 422
        traceId: 00-d45503a0a3fb4915bb5749e58cf01f1a-47ac5b7550a4064e-01
        requestId: e59b912a-9c00-11ed-a8fc-0242ac120002
        context:
        - code: '10106'
          message: Idempotency Key must not be reused across different payloads of this operation
          location: HEADER
          field: Idempotency-Key
    RealTimeSEPAInstantPmtDetailsResponseFull:
      summary: SEPA Instant - Payment Details(FULL)
      value:
        paymentId: 98275a2d-1e88-beed-6938-0521a7e0xatt
        paymentStatus: PROCESSING
        paymentSubStatus: PROCESSING_BY_JPM
        statusUpdatedAt: '2024-10-15T14:15:22Z'
        requestedExecutionDate: '2024-10-15'
        paymentIdentifiers:
          endToEndId: SEPAINSTANTTEST-XBRD
        value:
          currency: EUR
          amount: '40.01'
        transferType: CREDIT
        paymentType: RTP
        debtor:
          account:
            accountNumber: DE12345678912345678963
          name: JPM Client Corp
          postalAddress:
            city: Frankfurt
            country: DE
        debtorAgent:
          financialInstitutionIds:
          - id: CHASDEFX
            idType: BIC
        creditor:
          account:
            accountNumber: DE4564567891234567899
          name: TEST ACCOUNT
          postalAddress:
            city: Berlin
            country: DE
        creditorAgent:
          financialInstitutionIds:
          - id: CHASDEFX
            idType: BIC
    ProgramIdMissing:
      summary: Unprocessable Entity - Program ID Missing
      value:
        title: Program ID Missing
        httpStatus: 422
        traceId: 00-d45503a0a3fb4915bb5749e58cf01f1a-47ac5b7550a4064e-01
        requestId: 323e4567-e89b-12d3-a456-426614174005
        context:
        - code: '10001'
          message: Field /payments/debtor/account/alternateAccountIdentifiers/identifier must be present
          location: BODY
          field: $.payments.debtor.account.alternateAccountIdentifiers.identifier
    InvalidProgramId:
      summary: Unprocessable Entity - Invalid Program ID
      value:
        title: Invalid Program ID
        httpStatus: 422
        traceId: 00-d45503a0a3fb4915bb5749e58cf01f1a-47ac5b7550a4064e-01
        requestId: 423e4567-e89b-12d3-a456-426614174007
        context:
        - code: '10104'
          message: Field /payments/debtor/account/alternateAccountIdentifiers/identifier must have the expected value
          location: BODY
          field: $.payments.debtor.account.alternateAccountIdentifiers.identifier
    JWSRequestJOSE:
      summary: JWS Request - JOSE
      value: REDACTED.JWT.TOKEN
    RealTimeTHPromptPay:
      summary: RTP - Payment Initiation - Thailand PromptPay (Pay-to-Account)
      value:
        requestedExecutionDate: '2025-01-30'
        paymentIdentifiers:
          endToEndId: THPPTESTVF
        value:
          currency: THB
          amount: '12.34'
        transferType: CREDIT
        paymentType: RTP
        paymentTypeInformation:
          localInstrumentCode:
            proprietary: PPDCT
        debtor:
          name: John Doe
          account:
            accountNumber: '19881111'
            accountCurrency: THB
            accountType: DDA
        debtorAgent:
          financialInstitutionIds:
          - id: CHASTHBX
            idType: BIC
        creditor:
          name: Jane Doe
          account:
            accountNumber: '12345678'
        creditorAgent:
          financialInstitutionIds:
          - id: '006'
            idType: CLEARING_SYSTEM_ID
    ErrorAccountAuthorization:
      summary: Account Authorization Failure
      value:
        title: Account Authorization Failure
        httpStatus: 403
        traceId: 00-d45503a0a3fb4915bb5749e58cf01f1a-47ac5b7550a4064e-01
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - code: '14000'
          message: Client not authorized accessing the requested account
    RealTimeINIMPS:
      summary: RTP - Payment Initiation - India IMPS
      value:
        requestedExecutionDate: '2025-01-02'
        paymentIdentifiers:
          endToEndId: INIMPSTEST
        transferType: CREDIT
        value:
          currency: INR
          amount: '62.72'
        paymentType: RTP
        debtor:
          name: John Doe
          account:
            accountNumber: '123456789'
            accountCurrency: INR
            accountType: DDA
        debtorAgent:
          financialInstitutionIds:
          - id: CHASINBX
            idType: BIC
        creditor:
          name: Jane Doe
          account:
            accountNumber: '9876543210'
            accountType: NREX
        creditorAgent:
          financialInstitutionIds:
          - id: HDFC0CPNSBL
            idType: CLEARING_SYSTEM_ID
        remittanceInformation:
          unstructuredInformation:
          - text: Payment of Goods
    AlternateP2CTP3PaymentStatusWebhook-CE:
      summary: Push To Card TP3 Status Webhook
      value:
        specversion: '1.0'
        id: 385d920a-e732-46e8-9f7b-3d033482e851
        time: '2024-10-30T14:15:24Z'
        type: Payment.Completed
        source: /payment/v2/payments?endToEndId=tp30t92e023g11354100
        dataschema: urn:com.jpmorgan.payments/payment-event
        data:
          payments:
          - paymentId: 9fc46afb-fd32-46f9-868b-271baae142b2
            paymentStatus: COMPLETED
            paymentSubStatus: COMPLETED_BY_JPM
            statusUpdatedAt: '2024-10-30T14:15:22Z'
            requestedExecutionDate: '2024-10-30'
            paymentIdentifiers:
              endToEndId: tp30t92e023g11354100
            transferType: CREDIT
            paymentType: CARD
    AlternateP2WPaypal:
      summary: Alternate Payments - Push To Wallet(PAYPAL-Email)
      value:
        requestedExecutionDate: '2024-10-01'
        paymentIdentifiers:
          endToEndId: P2PPLTEST
        transferType: CREDIT
        value:
          currency: USD
          amount: '10'
        paymentType: PAYPAL
        debtor:
          name: John Doe
          account:
            accountNumber: '1234567890'
            accountType: DDA
        debtorAgent:
          financialInstitutionIds:
          - id: CHASUS33
            idType: BIC
        creditor:
          name: Jane Doe
          account:
            alternateAccountIdentifiers:
            - identifier: Jane.Doe@example.com
              idType: PROPRIETARY
              proprietarySchemeName: EMAL
          postalAddress:
            postalCode: '33634'
            country: US
        paymentPurpose:
          purpose:
            proprietary: GOODS
        remittanceInformation:
          unstructuredInformation:
          - text: Payment for Building materials - INVC009100
    RealTimeBRPIXPmtStatus:
      summary: RTP -  Brazil PIX - (SUMMARY)
      value:
        paymentId: b1e4c092-b90d-4b33-bd19-1a3843370cda
        paymentStatus: PROCESSING
        paymentSubStatus: PROCESSING_BY_JPM
        statusUpdatedAt: '2024-10-07T14:15:22Z'
        requestedExecutionDate: '2024-10-07'
        paymentIdentifiers:
          endToEndId: BRPIXTEST
        transferType: CREDIT
        paymentType: RTP
    SuspiciousContent:
      summary: Unprocessable Entity - Suspicious Content Detected
      value:
        title: Suspicious Content
        httpStatus: 422
        traceId: 00-d45503a0a3fb4915bb5749e58cf01f1a-47ac5b7550a4064e-01
        requestId: 223e4567-e89b-12d3-a456-426614174003
        context:
        - code: '13100'
          message: During tokenization process some other aspect of request was flagged as containing a card number
    RealTimeSEPAMinimalUltimateCreditorHybridAddress:
      summary: CBPR RTP SEPA Ultimate Creditor Hybrid
      value:
        requestedExecutionDate: '2025-12-14'
        paymentIdentifiers:
          endToEndId: SEPA1234567890123-XBRD
        value:
          currency: EUR
          amount: '150.00'
        transferType: CREDIT
        paymentType: RTP
        debtor:
          name: SEPA Debtor GmbH
          postalAddress:
            city: Frankfurt
            country: DE
          account:
            accountNumber: DE85501108000041321497
            accountType: IBAN
            accountCurrency: EUR
        debtorAgent:
          financialInstitutionIds:
          - id: CHASDEFX
            idType: BIC
        creditor:
          account:
            accountNumber: FR1420041010050500013M02606
            accountType: IBAN
          name: Creditor Name SEPA
          dateAndPlaceOfBirth:
            city: Paris
            country: FR
            birthDate: '1985-05-20'
          countryOfResidence: FR
        creditorAgent:
          financialInstitutionIds:
          - id: BNPAFRPPXXX
            idType: BIC
        additionalParties:
          ultimateDebtor:
            name: Ultimate Debtor Name
            postalAddress:
              city: Berlin
              country: DE
            dateAndPlaceOfBirth:
              city: Berlin
              country: DE
              birthDate: '1980-03-15'
            countryOfResidence: DE
            partyId:
              individualIds:
              - individualId: DE89370400440532013000
                schemeName:
                  proprietary: ID
          ultimateCreditor:
            name: Ultimate Creditor SARL
            postalAddress:
              addressLines:
              - Saint Germaine
              city: Paris
              country: FR
            dateAndPlaceOfBirth:
              city: Paris
              country: FR
              birthDate: '1990-07-10'
            countryOfResidence: FR
            partyId:
              individualIds:
              - individualId: FR1420041010050500013M02606
        remittanceInformation:
          unstructuredInformation:
          - text: Payment for invoice SEPA-2025-001
    RealTimeSGFPSPmtDetailsResponseFull:
      summary: RTP - Singapore RTP - Payment Details(FULL)
      value:
        paymentId: 7a444901-3c8c-465c-859c-a75fe6ccef70
        paymentStatus: PROCESSING
        paymentSubStatus: PROCESSING_BY_JPM
        statusUpdatedAt: '2024-10-03T14:15:22Z'
        requestedExecutionDate: '2024-10-03'
        paymentIdentifiers:
          endToEndId: SGFASTERPMT
        transferType: CREDIT
        value:
          currency: SGD
          amount: '10.01'
        paymentType: RTP
        debtor:
          account:
            accountNumber: '123456789'
            accountCurrency: SGD
            accountType: DDA
        debtorAgent:
          financialInstitutionIds:
          - id: CHASSGSG
            idType: BIC
        creditor:
          name: Jane Doe
          account:
            accountNumber: '999000111'
          postalAddress:
            streetName: Jefferson Drive
            buildingNumber: '23'
            postalCode: '289963'
            city: Singapore
            country: SG
        creditorAgent:
          financialInstitutionIds:
          - id: OCBCSGSG
            idType: BIC
        paymentPurpose:
          purpose:
            code: GDDS
        remittanceInformation:
          unstructuredInformation:
          - text: 'Payment for Furniture. Invoice #1211'
    JWSResponseJOSE:
      summary: JWS Response - JOSE
      value: REDACTED.JWT.TOKEN
    AlternateP2CPaymentStatusWebhook-CE:
      summary: Push To Card(P2C) Status Webhook
      value:
        specversion: '1.0'
        id: 2cd52b51-82be-4b78-8bb8-2d972402752b
        time: '2024-10-30T14:15:23Z'
        type: Payment.Completed
        source: /payment/v2/payments?endToEndId=1lv0t92e023g11354100
        dataschema: urn:com.jpmorgan.payments/payment-event
        data:
          payments:
          - paymentId: 98275a2d-1e88-beed-6938-0521a7e0uptc
            paymentStatus: COMPLETED
            paymentSubStatus: COMPLETED_BY_JPM
            statusUpdatedAt: '2024-10-30T14:15:22Z'
            requestedExecutionDate: '2024-10-30'
            paymentIdentifiers:
              endToEndId: 1lv0t92e023g11354100
            transferType: CREDIT
            paymentType: CARD
    AchUSCreditTransfer:
      summary: ACH - US Credit Transfer
      value:
        requestedExecutionDate: '2025-01-10'
        paymentIdentifiers:
          endToEndId: USACHCRTEST
        value:
          currency: USD
          amount: '1.00'
        transferType: CREDIT
        paymentType: ACH
        paymentTypeInformation:
          serviceLevelCode: NURG
          localInstrumentCode:
            code: CCD
        debtor:
          account:
            accountNumber: '12345678910'
            companyId: '1115559990'
          name: John Doe
          postalAddress:
            country: US
            buildingNumber: '000'
            streetName: Smoking Lane
            city: Chicago
            postalCode: '60603'
            countrySubDivision: IL
        debtorAgent:
          name: JP Morgan Chase
          financialInstitutionIds:
          - id: '021000021'
            idType: USABA
          postalAddress:
            country: US
        creditor:
          name: Jane Doe
          account:
            accountNumber: '987654321'
            accountCurrency: USD
          postalAddress:
            buildingNumber: '000'
            streetName: Voltage Street
            city: Toronto
            postalCode: M4C1B5
            countrySubDivision: '21'
            country: US
          partyId:
            individualIds:
            - individualId: '4444444'
        creditorAgent:
          name: JP Morgan Chase
          financialInstitutionIds:
          - id: '021000021'
            idType: USABA
          postalAddress:
            country: US
        remittanceInformation:
          unstructuredInformation:
          - text: MISC services INV#09900
        paymentPurpose:
          categoryPurpose:
            proprietary: ACCTVERIFY
        taxInformation:
          type: TAX_PAYMENT
    RealTimeBRPIX:
      summary: RTP - Payment Initiation - Brazil PIX
      value:
        requestedExecutionDate: '2024-10-07'
        paymentIdentifiers:
          endToEndId: BRPIXTEST
        transferType: CREDIT
        value:
          currency: BRL
          amount: '950'
        paymentType: RTP
        debtor:
          account:
            accountNumber: '123456789'
        debtorAgent:
          financialInstitutionIds:
          - id: CHASBRSP
            idType: BIC
        creditor:
          name: Jane Doe
          account:
            accountNumber: '987654321'
            accountType: CACC
        creditorAgent:
          financialInstitutionIds:
          - id: '33172537'
            idType: CLEARING_SYSTEM_ID
            branchNumber: '1'
        taxInformation:
          creditorTaxInformation:
            taxId: '99887654321'
            taxpayerCategory: INDIVIDUAL
    AchChileLowValueCreditTransfer:
      summary: ACH - Chile Low Value Credit Transfer
      value:
        requestedExecutionDate: '2024-10-01'
        paymentIdentifiers:
          endToEndId: CL_ACH_TEST
        value:
          currency: CLP
          amount: '300'
        transferType: CREDIT
        paymentType: ACH
        paymentTypeInformation:
          serviceLevelCode: NURG
          localInstrumentCode:
            code: CCD
        debtor:
          name: John Doe
          account:
            accountNumber: '123456789'
            accountType: DDA
            accountCurrency: CLP
        debtorAgent:
          financialInstitutionIds:
          - id: CHASCLRM
            idType: BIC
        creditorAgent:
          financialInstitutionIds:
          - id: BCHICLRM
            idType: BIC
          - id: '114740179'
            idType: CLEARING_SYSTEM_ID
            branchNumber: '0001'
        creditor:
          name: Jane Doe
          postalAddress:
            country: CL
          account:
            accountNumber: '987654321'
            accountType: SVGS
        paymentPurpose:
          purpose:
            proprietary: '0010130000'
        taxInformation:
          creditorTaxInformation:
            taxId: 06703922-K
            taxpayerCategory: INDIVIDUAL
    ErrorSystemUnavailable:
      summary: Service Unavailable
      value:
        title: Service Unavailable
        httpStatus: 503
        traceId: 00-d45503a0a3fb4915bb5749e58cf01f1a-47ac5b7550a4064e-01
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - code: '12999'
          message: API is currently unavailable for usage. Please try again after some time
    RealTimeAUNPP:
      summary: RTP - Payment Initiation - Australia NPP
      value:
        requestedExecutionDate: '2024-10-02'
        paymentIdentifiers:
          endToEndId: AUNPPTEST
        value:
          currency: AUD
          amount: '1.25'
        transferType: CREDIT
        paymentType: RTP
        debtor:
          account:
            accountNumber: '123456789'
            accountCurrency: AUD
        debtorAgent:
          financialInstitutionIds:
          - id: CHASAU2X
            idType: BIC
        creditor:
          account:
            accountNumber: '987654321'
          name: AUS Test Account
        creditorAgent:
          financialInstitutionIds:
          - id: '014257'
            idType: CLEARING_SYSTEM_ID
        paymentPurpose:
          categoryPurpose:
            code: SALA
    ErrorSystemUnavailableWithRetryAfterHeader:
      summary: Service Unavailable With Retry After Header
      value:
        title: Service Unavailable
        httpStatus: 503
        traceId: 00-d45503a0a3fb4915bb5749e58cf01f1a-47ac5b7550a4064e-01
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - code: '12995'
          message: Service is temporarily unavailable. Please try again after sometime.
    RealTimeUSRTPWalletWithdrawals:
      summary: RTP - Wallet Withdrawals Initiation - US RTP
      value:
        requestedExecutionDate: '2025-02-07'
        paymentIdentifiers:
          endToEndId: USRTPWALLETTEST
        transferType: CREDIT
        value:
          currency: USD
          amount: '122.08'
        paymentType: RTP
        debtor:
          name: John Doe
          account:
            accountNumber: '123456789'
        debtorAgent:
          financialInstitutionIds:
          - id: '021000021'
            idType: USABA
        creditor:
          account:
            accountNumber: '98765432100'
          name: Jane Doe
        creditorAgent:
          financialInstitutionIds:
          - id: '063100277'
            idType: USABA
    AlternateP2WVenmo:
      summary: Alternate Payments - Push to Wallet(VENMO) - Mobile phone number
      value:
        requestedExecutionDate: '2024-10-01'
        paymentIdentifiers:
          endToEndId: P2VENMOTEST
        transferType: CREDIT
        value:
          currency: USD
          amount: '10'
        paymentType: VENMO
        debtor:
          name: John Doe
          account:
            accountNumber: '123456789'
            accountType: DDA
        debtorAgent:
          financialInstitutionIds:
          - id: CHASUS33
            idType: BIC
        creditor:
          name: Jane Doe
          account:
            alternateAccountIdentifiers:
            - identifier: 0987600022
              idType: PROPRIETARY
              proprietarySchemeName: TELI
          postalAddress:
            postalCode: '33606'
            country: US
        remittanceInformation:
          unstructuredInformation:
          - text: Payment for catering facilities
    RealTimeMXSPEI:
      summary: RTP - Payment Initiation - Mexico SPEI
      value:
        requestedExecutionDate: '2025-07-20'
        paymentIdentifiers:
          endToEndId: MXRTPTEST
        value:
          currency: MXN
          amount: '1.01'
        transferType: CREDIT
        paymentType: RTP
        debtor:
          account:
            accountNumber: '123456789'
            accountType: DDA
        debtorAgent:
          financialInstitutionIds:
          - id: CHASMXMX
            idType: BIC
        creditor:
          account:
            accountNumber: '987654321000000'
          name: Jane Doe
        creditorAgent:
          financialInstitutionIds:
          - id: '40014'
            idType: CLEARING_SYSTEM_ID
        remittanceInformation:
          unstructuredInformation:
          - text: Payment for Goods
    RealTimeINIMPSPmtStatus:
      summary: RTP - India IMPS - Payment Details(SUMMARY)
      value:
        paymentId: a17840d8-67a5-4bbc-8f3f-a1d55ac3f5fe
        paymentStatus: COMPLETED
        statusUpdatedAt: '2025-01-02T10:10:22Z'
        requestedExecutionDate: '2025-01-02'
        paymentIdentifiers:
          endToEndId: INIMPSTEST
        transferType: CREDIT
        paymentType: RTP
    AlternateKinexysDigitalPaymentsBDAtoDDA:
      summary: Alternate Payments- Kinexys Digital Payments - Branch USD Withdrawal (BDA to DDA)
      value:
        requestedExecutionDate: '2024-10-30'
        paymentIdentifiers:
          endToEndId: KINEXYSTEST1
        transferType: CREDIT
        value:
          currency: USD
          amount: '6500'
        paymentType: BLOCKCHAIN
        debtor:
          account:
            accountNumber: '123456789'
            accountType: BDA
        debtorAgent:
          financialInstitutionIds:
          - id: CHASUS33
            idType: BIC
        creditor:
          account:
            accountNumber: '9876543210'
            accountType: DDA
        creditorAgent:
          financialInstitutionIds:
          - id: CHASUS33
            idType: BIC
        remittanceInformation:
          unstructuredInformation:
          - text: Payment for container shipment
    AlternateP2C:
      summary: Alternate Payments - Push To Card(P2C)
      value:
        requestedExecutionDate: '2024-10-30'
        paymentIdentifiers:
          endToEndId: P2CTEST
        transferType: CREDIT
        value:
          currency: USD
          amount: '750'
        paymentType: CARD
        debtor:
          name: John Doe
          account:
            alternateAccountIdentifiers:
            - identifier: TESTPRGM
              idType: PROGRAM_ID
        debtorAgent:
          financialInstitutionIds:
          - id: CHASUS33
            idType: BIC
        creditor:
          name: Jane Doe
          account:
            card:
              pan: '4137999019999999'
              expiryDate: '2207'
        remittanceInformation:
          unstructuredInformation:
          - text: Invoice 012345
    RealTimeSEPAMinimalCreditorAddress:
      summary: CBPR RTP SEPA Creditor
      value:
        requestedExecutionDate: '2025-12-14'
        paymentIdentifiers:
          endToEndId: SEPA1234567890123-XBRD
        value:
          currency: EUR
          amount: '150.00'
        transferType: CREDIT
        paymentType: RTP
        debtor:
          name: SEPA Debtor GmbH
          postalAddress:
            city: Frankfurt
            country: DE
          account:
            accountNumber: DE85501108000041321497
            accountType: IBAN
            accountCurrency: EUR
        debtorAgent:
          financialInstitutionIds:
          - id: CHASDEFX
            idType: BIC
        creditor:
          account:
            accountNumber: FR1420041010050500013M02606
            accountType: IBAN
          name: Creditor Name SEPA
          postalAddress:
            city: Paris
            country: FR
          dateAndPlaceOfBirth:
            city: Paris
            country: FR
            birthDate: '1985-05-20'
          countryOfResidence: FR
        creditorAgent:
          financialInstitutionIds:
          - id: BNPAFRPPXXX
            idType: BIC
        additionalParties:
          ultimateDebtor:
            name: Ultimate Debtor Name
            postalAddress:
              city: Berlin
              country: DE
            dateAndPlaceOfBirth:
              city: Berlin
              country: DE
              birthDate: '1980-03-15'
            countryOfResidence: DE
            partyId:
              individualIds:
              - individualId: DE89370400440532013000
                schemeName:
                  proprietary: ID
          ultimateCreditor:
            name: Ultimate Creditor SARL
            dateAndPlaceOfBirth:
              city: Paris
              country: FR
              birthDate: '1990-07-10'
            countryOfResidence: FR
            partyId:
              individualIds:
              - individualId: FR1420041010050500013M02606
        remittanceInformation:
          unstructuredInformation:
          - text: Payment for invoice SEPA-2025-001
    AlternateP2CRejectedStatusWebhook-CE:
      summary: Push To Card TP3 Status Webhook - REJECTED
      value:
        specversion: '1.0'
        id: 9091c1ad-f88b-45f4-a26a-c83bd9bc2eb7
        time: '2024-10-30T14:15:23Z'
        type: Payment.Rejected
        source: /payment/v2/payments?endToEndId=EDZRLHRQ0WQXYYZ
        dataschema: urn:com.jpmorgan.payments/payment-event
        data:
          payments:
          - paymentId: 2205f1d6-2fbb-49cc-be7e-b99cd245zzyy
            paymentStatus: REJECTED
            paymentSubStatus: REJECTED
            statusUpdatedAt: '2023-10-19T20:01:23.900Z'
            requestedExecutionDate: '2024-10-30'
            paymentIdentifiers:
              endToEndId: EDZRLHRQ0WQXYYZ
            transferType: CREDIT
            paymentType: CARD
            exceptions:
            - code: '10001'
              message: Mandatory field missing or invalid in /creditor/account/alternateAccountIdentifier
              location: BODY
              field: $.creditor.account.alternateAccountIdentifier
              additionalContext:
              - type: ISO20022
                code: BE05
                message: Mandatory field missing
    MalformedPANError:
      summary: Unprocessable Entity - Malformed PAN Error
      value:
        title: Malformed PAN
        httpStatus: 422
        traceId: 00-d45503a0a3fb4915bb5749e58cf01f1a-47ac5b7550a4064e-01
        requestId: 123e4567-e89b-12d3-a456-426614174001
        context:
        - code: '10104'
          message: pan must have the expected value
          location: BODY
          field: $.payments.creditor.account.card.pan
    WiresCrossBorderPacs008MinimalDebtorAddress:
      summary: CBPR US Wires Debtor
      value:
        requestedExecutionDate: '2025-11-26'
        paymentIdentifiers:
          endToEndId: PACS008EG-01000011-XBRD
          otherPaymentReferences:
            uetr: 36594813-5324-4010-9134-937685327713
        transferType: CREDIT
        paymentTypeInformation:
          paymentContext: CUSTOMER
        paymentType: WIRE
        value:
          currency: USD
          amount: '101.22'
        debtor:
          name: Name of Aloha Client
          account:
            accountNumber: '123456789'
          postalAddress:
            city: NEW YORK CITY
            country: US
        debtorAgent:
          name: Test Company Name identity
          postalAddress:
            city: New York
            country: US
        creditorAgent:
          name: Agricultural Bank of Egypt
          financialInstitutionIds:
          - id: BDACEGCA
            idType: BIC
        creditor:
          account:
            accountNumber: EG380019000500000000263180002
            accountType: IBAN
          name: Rosemary Alvarez
          partyId:
            organizationIds:
            - organizationId: '239759837538'
              schemeName:
                code: BDID
            - organizationId: '54578349587349'
              schemeName:
                code: BOID
        additionalParties:
          intermediaryAgents:
          - financialInstitutionIds:
            - id: 026009593
              idType: USABA
            postalAddress:
              city: New York
              country: US
          instructedAgent:
            id: CHASUS33
            idType: BIC
        paymentPurpose:
          purpose:
            code: SPSP
        remittanceInformation:
          unstructuredInformation:
          - text: unstructured remittance information to be sent
          agentInstructions:
            nextAgentInstructions:
            - instruction: Instructions for next Agent
            creditorAgentInstructions:
            - instruction: Instructions for Creditor Agent
        settlementInformation:
          settlementAccount:
            accountNumber: 0000005688
    RealTimeIDFPS:
      summary: RTP - Payment Initiation - Indonesia
      value:
        requestedExecutionDate: '2024-10-11'
        paymentIdentifiers:
          endToEndId: IDFASTERPMTTEST
        transferType: CREDIT
        value:
          currency: IDR
          amount: '6500'
        paymentType: RTP
        debtor:
          name: John Doe
          account:
            accountNumber: '123456789'
        debtorAgent:
          financialInstitutionIds:
          - id: CHASIDJX
            idType: BIC
        creditor:
          name: Jane Doe
          account:
            accountNumber: '987654321'
        creditorAgent:
          financialInstitutionIds:
          - id: BDINIDJA
            idType: BIC
        paymentPurpose:
          categoryPurpose:
            proprietary: INVESTMENT
        remittanceInformation:
          unstructuredInformation:
          - text: Rental Payment for June 2023
    RealTimeSEPAMinimalUltimateDebtorAddress:
      summary: CBPR RTP SEPA Ultimate Debtor
      value:
        requestedExecutionDate: '2025-12-14'
        paymentIdentifiers:
          endToEndId: SEPA1234567890123-XBRD
        value:
          currency: EUR
          amount: '150.00'
        transferType: CREDIT
        paymentType: RTP
        debtor:
          name: SEPA Debtor GmbH
          postalAddress:
            city: Frankfurt
            country: DE
          account:
            accountNumber: DE85501108000041321497
            accountType: IBAN
            accountCurrency: EUR
        debtorAgent:
          financialInstitutionIds:
          - id: CHASDEFX
            idType: BIC
        creditor:
          account:
            accountNumber: FR1420041010050500013M02606
            accountType: IBAN
          name: Creditor Name SEPA
          dateAndPlaceOfBirth:
            city: Paris
            country: FR
            birthDate: '1985-05-20'
          countryOfResidence: FR
        creditorAgent:
          financialInstitutionIds:
          - id: BNPAFRPPXXX
            idType: BIC
        additionalParties:
          ultimateDebtor:
            name: Ultimate Debtor Name
            postalAddress:
              city: Berlin
              country: DE
            dateAndPlaceOfBirth:
              city: Berlin
              country: DE
              birthDate: '1980-03-15'
            countryOfResidence: DE
            partyId:
              individualIds:
              - individualId: DE89370400440532013000
                schemeName:
                  proprietary: ID
          ultimateCreditor:
            name: Ultimate Creditor SARL
            dateAndPlaceOfBirth:
              city: Paris
              country: FR
              birthDate: '1990-07-10'
            countryOfResidence: FR
            partyId:
              individualIds:
              - individualId: FR1420041010050500013M02606
        remittanceInformation:
          unstructuredInformation:
          - text: Payment for invoice SEPA-2025-001
    ErrorUnauthenticated:
      summary: Authentication Failure
      value:
        title: Authentication Failure
        httpStatus: 401
        traceId: 00-d45503a0a3fb4915bb5749e58cf01f1a-47ac5b7550a4064e-01
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - code: '14000'
          message: Client could not be authenticated
    WiresCrossBorderPacs008MinimalCreditorAddress:
      summary: CBPR US Wires Creditor
      value:
        requestedExecutionDate: '2025-11-26'
        paymentIdentifiers:
          endToEndId: PACS008EG-01000011-XBRD
          otherPaymentReferences:
            uetr: 36594813-5324-4010-9134-937685327713
        transferType: CREDIT
        paymentTypeInformation:
          paymentContext: CUSTOMER
        paymentType: WIRE
        value:
          currency: USD
          amount: '101.22'
        debtor:
          name: Name of Aloha Client
          account:
            accountNumber: '123456789'
          postalAddress:
            city: New York
            country: US
        debtorAgent:
          name: Test Company Name identity
          postalAddress:
            city: New York
            country: US
        creditorAgent:
          name: Agricultural Bank of Egypt
          financialInstitutionIds:
          - id: BDACEGCA
            idType: BIC
        creditor:
          account:
            accountNumber: EG380019000500000000263180002
            accountType: IBAN
          name: Rosemary Alvarez
          postalAddress:
            city: LONDON
            country: UK
          partyId:
            organizationIds:
            - organizationId: '239759837538'
              schemeName:
                code: BDID
            - organizationId: '54578349587349'
              schemeName:
                code: BOID
        additionalParties:
          intermediaryAgents:
          - financialInstitutionIds:
            - id: 026009593
              idType: USABA
            postalAddress:
              city: New York
              country: US
          instructedAgent:
            id: CHASUS33
            idType: BIC
        paymentPurpose:
          purpose:
            code: SPSP
        remittanceInformation:
          unstructuredInformation:
          - text: unstructured remittance information to be sent
          agentInstructions:
            nextAgentInstructions:
            - instruction: Instructions for next Agent
            creditorAgentInstructions:
            - instruction: Instructions for Creditor Agent
        settlementInformation:
          settlementAccount:
            accountNumber: 0000005688
    AlternateKinexysDigitalPaymentsDDAtoBDA:
      summary: Alternate Payments - Kinexys Digital Payments (DDA to BDA)
      value:
        requestedExecutionDate: '2024-10-30'
        paymentIdentifiers:
          endToEndId: KINEXYSTEST
        transferType: CREDIT
        value:
          currency: USD
          amount: '6500'
        paymentType: BLOCKCHAIN
        debtor:
          account:
            accountNumber: '123456789'
            accountType: DDA
        debtorAgent:
          financialInstitutionIds:
          - id: CHASUS33
            idType: BIC
        creditor:
          account:
            accountNumber: '987654321'
            accountType: BDA
        creditorAgent:
          financialInstitutionIds:
          - id: CHASUS33
            idType: BIC
        remittanceInformation:
          unstructuredInformation:
          - text: Payment for container shipment
    WiresCrossBorderPacs008HybridDebtorAddress:
      summary: CBPR US Wires Debtor - Hybrid
      value:
        requestedExecutionDate: '2025-11-26'
        paymentIdentifiers:
          endToEndId: PACS008EG-01000011-XBRD
          otherPaymentReferences:
            uetr: 36594813-5324-4010-9134-937685327713
        transferType: CREDIT
        paymentTypeInformation:
          paymentContext: CUSTOMER
        paymentType: WIRE
        value:
          currency: USD
          amount: '101.22'
        debtor:
          name: Rosemary Alvarez
          account:
            accountNumber: '123456789'
          postalAddress:
            addressLine:
            - 60 Kapolei Street
            city: LONDON
            country: UK
        debtorAgent:
          name: Test Company Name identity
          postalAddress:
            city: New York
            country: US
        creditorAgent:
          name: Agricultural Bank of Egypt
          financialInstitutionIds:
          - id: BDACEGCA
            idType: BIC
        creditor:
          name: Rosemary Alvarez
          account:
            accountNumber: EG380019000500000000263180002
            accountType: IBAN
          partyId:
            organizationIds:
            - organizationId: '239759837538'
              schemeName:
                code: BDID
            - organizationId: '54578349587349'
              schemeName:
                code: BOID
        additionalParties:
          intermediaryAgents:
          - financialInstitutionIds:
            - id: 026009593
              idType: USABA
            postalAddress:
              city: New York
              country: US
          instructedAgent:
            id: CHASUS33
            idType: BIC
        paymentPurpose:
          purpose:
            code: SPSP
        remittanceInformation:
          unstructuredInformation:
          - text: unstructured remittance information to be sent
          agentInstructions:
            nextAgentInstructions:
            - instruction: Instructions for next Agent
            creditorAgentInstructions:
            - instruction: Instructions for Creditor Agent
        settlementInformation:
          settlementAccount:
            accountNumber: 0000005688
    RealTimeUKFPS:
      summary: RTP - Payment Initiation - UK FPS
      value:
        requestedExecutionDate: '2024-10-22'
        paymentIdentifiers:
          endToEndId: UKFPSTEST
        value:
          currency: GBP
          amount: '1.01'
        transferType: CREDIT
        paymentType: RTP
        debtor:
          account:
            accountNumber: '1234567890'
        debtorAgent:
          financialInstitutionIds:
          - id: CHASGB2L
            idType: BIC
        creditor:
          account:
            accountNumber: '987654321'
          name: GB Test Acccount
        creditorAgent:
          financialInstitutionIds:
          - id: 042920
            idType: CLEARING_SYSTEM_ID
    RealTimeMYRPPCredit:
      summary: RTP - Payment Initiation - Malaysia FPS Credit
      value:
        requestedExecutionDate: '2024-10-06'
        paymentIdentifiers:
          endToEndId: MYSRPTEST
        transferType: CREDIT
        value:
          currency: MYR
          amount: '15'
        paymentType: RTP
        debtor:
          account:
            accountNumber: '1234567890'
          device:
            ipAddress: 123.45.67.890
        debtorAgent:
          financialInstitutionIds:
          - id: CHASMYKX
            idType: BIC
        creditor:
          name: Jane Doe
          account:
            accountNumber: '987654321'
            accountType: SVGS
          countryOfResidence: MY
          dateAndPlaceOfBirth:
            birthDate: '1980-10-20'
            city: Hong Kong
            country: HK
        creditorAgent:
          financialInstitutionIds:
          - id: CITIMYKL
            idType: BIC
        paymentPurpose:
          purpose:
            proprietary: '17080'
        remittanceInformation:
          structuredInformation:
          - creditReference:
              reference: 1252ACV-096
    Unauthorized:
      value:
        title: Unauthorized
        httpStatus: 401
        traceId: 0eca2e1a-74b7-44b7-9e66-4a6ec8336eb9
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - message: Unauthorized
    PaymentInitiationResponseUKRTP:
      value:
        id: 1b036f9c-8c84-4ce6-b1dd-5979472945a1
        status: NONE
        statusUpdatedAt: '2023-08-20T13:31:25Z'
        createdAt: '2023-08-20T13:31:25Z'
        paymentAmount:
          value: '100.00'
          currency: GBP
        paymentType: REAL_TIME_PAYMENTS
        market: GB
        redirectURL: https://sites.obtest.com/sites/cib
        paymentLinkURL: https://paybybank.jpmorgan.com/1.0/pay/direct?client_id=9cd2e1c9527e4e18ad4756393e09cb2c&redirect_uri=https://sites.obtest.com/sites/cib&market=DE&payment_request_id=1b036f9c-8c84-4ce6-b1dd-5979472945a1
        paymentQRCode: https://paybybank.jpmorgan.com/api-proxy/api/enablement/v2/payments/qr/aHR0cHM6Ly9wYXlieWJhbmsuanBtb3JnYW4uY29tLzEuMC9wYXkvZGlyZWN0P21hcmtldD1HQiZyZWRpcmVjdF91cmk9aHR0cHM6Ly9zaXRlcy5vYnRlc3QuY29tL3NpdGVzL2NpYiZwYXltZW50X3JlcXVlc3RfaWQ9NWM0MjVjMjctMDVhNy00ODE5LWJkYjAtZGI3ZDU4Y2ZjNjYwJmxvY2FsZT1lbl9VUyZjbGllbnRfaWQ9M2QwZGNhN2RhZGE1NGUxOWI1YWYwMjRlZjk3Nzc0Mzg=
        debtor:
          name: Bala Thandapani
        creditor:
          name: Newgen Media LLC
          account:
            accountId: '11223387654321'
            accountIdType: SORT_CODE
        reference: 'subscription - #78004300'
    PaymentResponseFranceRTP:
      value:
        id: 2a55c901-479c-463f-a011-0ad291dfc5df
        status: NONE
        statusUpdatedAt: '2023-08-20T13:31:25Z'
        createdAt: '2023-08-20T13:31:25Z'
        paymentAmount:
          value: '90.00'
          currency: EUR
        paymentType: REAL_TIME_PAYMENTS
        market: FR
        redirectURL: https://sites.obtest.com/sites/cib
        paymentLinkURL: https://paybybank.jpmorgan.com/1.0/pay/direct?client_id=9cd2e1c9527e4e18ad4756393e09cb2c&redirect_uri=https://sites.obtest.com/sites/cib&market=FR&payment_request_id=1b036f9c-8c84-4ce6-b1dd-5979472945a1
        paymentQRCode: https://paybybank.jpmorgan.com/api-proxy/api/enablement/v2/payments/qr/aHR0cHM6Ly9wYXlieWJhbmsuanBtb3JnYW4uY29tLzEuMC9wYXkvZGlyZWN0P21hcmtldD1HQiZyZWRpcmVjdF91cmk9aHR0cHM6Ly9zaXRlcy5vYnRlc3QuY29tL3NpdGVzL2NpYiZwYXltZW50X3JlcXVlc3RfaWQ9NWM0MjVjMjctMDVhNy00ODE5LWJkYjAtZGI3ZDU4Y2ZjNjYwJmxvY2FsZT1lbl9VUyZjbGllbnRfaWQ9M2QwZGNhN2RhZGE1NGUxOWI1YWYwMjRlZjk3Nzc0Mzg=
        debtor:
          name: Saheed Osupa
          account:
            accountId: FR1420041010050500013M02606
            accountIdType: IBAN
        creditor:
          name: Newgen Media LLC
          account:
            accountId: FR1420041010050500013M02987
            accountIdType: IBAN
        reference: 'subscription - #12504300'
    PaymentResponseNorwayRTP:
      value:
        id: 6bef35f3-808e-4265-86fe-ac5f2a03fa72
        status: NONE
        statusUpdatedAt: '2023-08-20T13:31:25Z'
        createdAt: '2023-08-20T13:31:25Z'
        paymentAmount:
          value: '105.00'
          currency: EUR
        paymentType: REAL_TIME_PAYMENTS
        market: 'NO'
        redirectURL: https://sites.obtest.com/sites/cib
        paymentLinkURL: https://paybybank.jpmorgan.com/1.0/pay/direct?client_id=9cd2e1c9527e4e18ad4756393e09cb2c&redirect_uri=https://sites.obtest.com/sites/cib&market=NO&payment_request_id=1b036f9c-8c84-4ce6-b1dd-5979472945a1
        paymentQRCode: https://paybybank.jpmorgan.com/api-proxy/api/enablement/v2/payments/qr/aHR0cHM6Ly9wYXlieWJhbmsuanBtb3JnYW4uY29tLzEuMC9wYXkvZGlyZWN0P21hcmtldD1HQiZyZWRpcmVjdF91cmk9aHR0cHM6Ly9zaXRlcy5vYnRlc3QuY29tL3NpdGVzL2NpYiZwYXltZW50X3JlcXVlc3RfaWQ9NWM0MjVjMjctMDVhNy00ODE5LWJkYjAtZGI3ZDU4Y2ZjNjYwJmxvY2FsZT1lbl9VUyZjbGllbnRfaWQ9M2QwZGNhN2RhZGE1NGUxOWI1YWYwMjRlZjk3Nzc0Mzg=
        debtor:
          name: Mary KOM
          account:
            accountId: NO9386011117947
            accountIdType: IBAN
        creditor:
          name: Newgen Media LLC
          account:
            accountId: NO9386011117987
            accountIdType: IBAN
        reference: 'subscription - #79694300'
    ServiceUnavailableError:
      value:
        title: System Error
        httpStatus: 503
        traceId: d3dd646b-1fd0-4389-b6b4-0c3ab486ccc4
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - code: '12000'
          message: Service Unavailable. Please try again.
    PaymentResponseUKRTPFailed:
      value:
        id: 030bd614-2cd2-4e58-acff-51a41f713577
        status: FAILED
        statusUpdatedAt: '2023-08-20T13:31:25Z'
        createdAt: '2023-08-20T13:31:25Z'
        paymentAmount:
          value: '100.00'
          currency: GBP
        paymentType: REAL_TIME_PAYMENTS
        market: GB
        redirectURL: https://sites.obtest.com/sites/cib
        paymentLinkURL: https://paybybank.jpmorgan.com/1.0/pay/direct?client_id=9cd2e1c9527e4e18ad4756393e09cb2c&redirect_uri=https://sites.obtest.com/sites/cib&market=DE&payment_request_id=1b036f9c-8c84-4ce6-b1dd-5979472945a1
        paymentQRCode: https://paybybank.jpmorgan.com/api-proxy/api/enablement/v2/payments/qr/aHR0cHM6Ly9wYXlieWJhbmsuanBtb3JnYW4uY29tLzEuMC9wYXkvZGlyZWN0P21hcmtldD1HQiZyZWRpcmVjdF91cmk9aHR0cHM6Ly9zaXRlcy5vYnRlc3QuY29tL3NpdGVzL2NpYiZwYXltZW50X3JlcXVlc3RfaWQ9NWM0MjVjMjctMDVhNy00ODE5LWJkYjAtZGI3ZDU4Y2ZjNjYwJmxvY2FsZT1lbl9VUyZjbGllbnRfaWQ9M2QwZGNhN2RhZGE1NGUxOWI1YWYwMjRlZjk3Nzc0Mzg=
        debtor:
          name: Bala Thandapani
          account:
            accountId: 06080912311871
            accountIdType: SORT_CODE
        creditor:
          name: Newgen Media LLC
          account:
            accountId: '11223387654321'
            accountIdType: SORT_CODE
        reference: 'subscription - #78004300'
    ConflictError:
      value:
        title: Idempotency Check Failure
        httpStatus: 409
        traceId: 0eca2e1a-74b7-44b7-9e66-4a6ec8336eb9
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - code: '10106'
          message: The request conflicts with the current state of the server. Please ensure your request is unique.
          location: BODY
    PaymentInitiationResponseSpainRTP:
      value:
        id: c1225715-1014-450f-bdd0-95767f0cfbc2
        status: NONE
        statusUpdatedAt: '2023-08-20T13:31:25Z'
        createdAt: '2023-08-20T13:31:25Z'
        paymentAmount:
          value: '85.00'
          currency: EUR
        paymentType: REAL_TIME_PAYMENTS
        market: ES
        redirectURL: https://sites.obtest.com/sites/cib
        paymentLinkURL: https://paybybank.jpmorgan.com/1.0/pay/direct?client_id=9cd2e1c9527e4e18ad4756393e09cb2c&redirect_uri=https://sites.obtest.com/sites/cib&market=ES&payment_request_id=1b036f9c-8c84-4ce6-b1dd-5979472945a1
        paymentQRCode: https://paybybank.jpmorgan.com/api-proxy/api/enablement/v2/payments/qr/aHR0cHM6Ly9wYXlieWJhbmsuanBtb3JnYW4uY29tLzEuMC9wYXkvZGlyZWN0P21hcmtldD1HQiZyZWRpcmVjdF91cmk9aHR0cHM6Ly9zaXRlcy5vYnRlc3QuY29tL3NpdGVzL2NpYiZwYXltZW50X3JlcXVlc3RfaWQ9NWM0MjVjMjctMDVhNy00ODE5LWJkYjAtZGI3ZDU4Y2ZjNjYwJmxvY2FsZT1lbl9VUyZjbGllbnRfaWQ9M2QwZGNhN2RhZGE1NGUxOWI1YWYwMjRlZjk3Nzc0Mzg=
        debtor:
          name: Abdul Rahman
        creditor:
          name: Newgen Media LLC
          account:
            accountId: ES9121000418450200051987
            accountIdType: IBAN
        reference: 'subscription - #79694300'
    PaymentResponseSpainRTP:
      value:
        id: c1225715-1014-450f-bdd0-95767f0cfbc2
        status: SENT
        statusUpdatedAt: '2023-08-20T13:31:25Z'
        createdAt: '2023-08-20T13:31:25Z'
        paymentAmount:
          value: '85.00'
          currency: EUR
        paymentType: REAL_TIME_PAYMENTS
        market: ES
        redirectURL: https://sites.obtest.com/sites/cib
        paymentLinkURL: https://paybybank.jpmorgan.com/1.0/pay/direct?client_id=9cd2e1c9527e4e18ad4756393e09cb2c&redirect_uri=https://sites.obtest.com/sites/cib&market=ES&payment_request_id=1b036f9c-8c84-4ce6-b1dd-5979472945a1
        paymentQRCode: https://paybybank.jpmorgan.com/api-proxy/api/enablement/v2/payments/qr/aHR0cHM6Ly9wYXlieWJhbmsuanBtb3JnYW4uY29tLzEuMC9wYXkvZGlyZWN0P21hcmtldD1HQiZyZWRpcmVjdF91cmk9aHR0cHM6Ly9zaXRlcy5vYnRlc3QuY29tL3NpdGVzL2NpYiZwYXltZW50X3JlcXVlc3RfaWQ9NWM0MjVjMjctMDVhNy00ODE5LWJkYjAtZGI3ZDU4Y2ZjNjYwJmxvY2FsZT1lbl9VUyZjbGllbnRfaWQ9M2QwZGNhN2RhZGE1NGUxOWI1YWYwMjRlZjk3Nzc0Mzg=
        debtor:
          name: Abdul Rahman
          account:
            accountId: ES9121000418450200051332
            accountIdType: IBAN
        creditor:
          name: Newgen Media LLC
          account:
            accountId: ES9121000418450200051987
            accountIdType: IBAN
        reference: 'subscription - #79694300'
        acknowledged: ACKNOWLEDGED
    PaymentInitiationResponseDERTP:
      value:
        id: a14a49b4-b21e-416e-ab8d-c0e57efbd2ea
        status: NONE
        statusUpdatedAt: '2023-08-20T13:31:25Z'
        createdAt: '2023-08-20T13:31:25Z'
        paymentAmount:
          value: '150.00'
          currency: EUR
        paymentType: REAL_TIME_PAYMENTS
        market: DE
        redirectURL: https://sites.obtest.com/sites/cib
        paymentLinkURL: https://paybybank.jpmorgan.com/1.0/pay/direct?client_id=9cd2e1c9527e4e18ad4756393e09cb2c&redirect_uri=https://sites.obtest.com/sites/cib&market=DE&payment_request_id=1b036f9c-8c84-4ce6-b1dd-5979472945a1
        paymentQRCode: https://paybybank.jpmorgan.com/api-proxy/api/enablement/v2/payments/qr/aHR0cHM6Ly9wYXlieWJhbmsuanBtb3JnYW4uY29tLzEuMC9wYXkvZGlyZWN0P21hcmtldD1HQiZyZWRpcmVjdF91cmk9aHR0cHM6Ly9zaXRlcy5vYnRlc3QuY29tL3NpdGVzL2NpYiZwYXltZW50X3JlcXVlc3RfaWQ9NWM0MjVjMjctMDVhNy00ODE5LWJkYjAtZGI3ZDU4Y2ZjNjYwJmxvY2FsZT1lbl9VUyZjbGllbnRfaWQ9M2QwZGNhN2RhZGE1NGUxOWI1YWYwMjRlZjk3Nzc0Mzg=
        debtor:
          name: Joshua Sundar
          account:
            accountId: DE89370400440532013000
            accountIdType: IBAN
        creditor:
          name: Newgen Media LLC
          account:
            accountId: DE89370400440532013987
            accountIdType: IBAN
        reference: 'subscription - #99604300'
    PaymentResponseUKRTP:
      value:
        id: 1b036f9c-8c84-4ce6-b1dd-5979472945a1
        status: SENT
        statusUpdatedAt: '2023-08-20T13:31:25Z'
        createdAt: '2023-08-20T13:31:25Z'
        paymentAmount:
          value: '100.00'
          currency: GBP
        paymentType: REAL_TIME_PAYMENTS
        market: GB
        redirectURL: https://sites.obtest.com/sites/cib
        paymentLinkURL: https://paybybank.jpmorgan.com/1.0/pay/direct?client_id=9cd2e1c9527e4e18ad4756393e09cb2c&redirect_uri=https://sites.obtest.com/sites/cib&market=DE&payment_request_id=1b036f9c-8c84-4ce6-b1dd-5979472945a1
        paymentQRCode: https://paybybank.jpmorgan.com/api-proxy/api/enablement/v2/payments/qr/aHR0cHM6Ly9wYXlieWJhbmsuanBtb3JnYW4uY29tLzEuMC9wYXkvZGlyZWN0P21hcmtldD1HQiZyZWRpcmVjdF91cmk9aHR0cHM6Ly9zaXRlcy5vYnRlc3QuY29tL3NpdGVzL2NpYiZwYXltZW50X3JlcXVlc3RfaWQ9NWM0MjVjMjctMDVhNy00ODE5LWJkYjAtZGI3ZDU4Y2ZjNjYwJmxvY2FsZT1lbl9VUyZjbGllbnRfaWQ9M2QwZGNhN2RhZGE1NGUxOWI1YWYwMjRlZjk3Nzc0Mzg=
        debtor:
          name: Bala Thandapani
          account:
            accountId: 06080912311871
            accountIdType: SORT_CODE
        creditor:
          name: Newgen Media LLC
          account:
            accountId: '11223387654321'
            accountIdType: SORT_CODE
        reference: 'subscription - #78004300'
        acknowledged: ACKNOWLEDGED
    PaymentResponseGermanyRTP:
      value:
        id: a14a49b4-b21e-416e-ab8d-c0e57efbd2ea
        status: SENT
        statusUpdatedAt: '2023-08-20T13:31:25Z'
        createdAt: '2023-08-20T13:31:25Z'
        paymentAmount:
          value: '150.00'
          currency: EUR
        paymentType: REAL_TIME_PAYMENTS
        market: DE
        redirectURL: https://sites.obtest.com/sites/cib
        paymentLinkURL: https://paybybank.jpmorgan.com/1.0/pay/direct?client_id=9cd2e1c9527e4e18ad4756393e09cb2c&redirect_uri=https://sites.obtest.com/sites/cib&market=DE&payment_request_id=1b036f9c-8c84-4ce6-b1dd-5979472945a1
        paymentQRCode: https://paybybank.jpmorgan.com/api-proxy/api/enablement/v2/payments/qr/aHR0cHM6Ly9wYXlieWJhbmsuanBtb3JnYW4uY29tLzEuMC9wYXkvZGlyZWN0P21hcmtldD1HQiZyZWRpcmVjdF91cmk9aHR0cHM6Ly9zaXRlcy5vYnRlc3QuY29tL3NpdGVzL2NpYiZwYXltZW50X3JlcXVlc3RfaWQ9NWM0MjVjMjctMDVhNy00ODE5LWJkYjAtZGI3ZDU4Y2ZjNjYwJmxvY2FsZT1lbl9VUyZjbGllbnRfaWQ9M2QwZGNhN2RhZGE1NGUxOWI1YWYwMjRlZjk3Nzc0Mzg=
        debtor:
          name: Joshua Sundar
          account:
            accountId: DE89370400440532013000
            accountIdType: IBAN
        creditor:
          name: Newgen Media LLC
          account:
            accountId: DE89370400440532013987
            accountIdType: IBAN
        reference: 'subscription - #99604300'
        acknowledged: ACKNOWLEDGED
    PaymentResponseItalyRTP:
      value:
        id: 52ede77e-02e8-4154-9af9-13f62fdc064d
        status: NONE
        statusUpdatedAt: '2023-08-20T13:31:25Z'
        createdAt: '2023-08-20T13:31:25Z'
        paymentAmount:
          value: '50.00'
          currency: EUR
        paymentType: REAL_TIME_PAYMENTS
        market: IT
        redirectURL: https://sites.obtest.com/sites/cib
        paymentLinkURL: https://paybybank.jpmorgan.com/1.0/pay/direct?client_id=9cd2e1c9527e4e18ad4756393e09cb2c&redirect_uri=https://sites.obtest.com/sites/cib&market=IT&payment_request_id=1b036f9c-8c84-4ce6-b1dd-5979472945a1
        paymentQRCode: https://paybybank.jpmorgan.com/api-proxy/api/enablement/v2/payments/qr/aHR0cHM6Ly9wYXlieWJhbmsuanBtb3JnYW4uY29tLzEuMC9wYXkvZGlyZWN0P21hcmtldD1HQiZyZWRpcmVjdF91cmk9aHR0cHM6Ly9zaXRlcy5vYnRlc3QuY29tL3NpdGVzL2NpYiZwYXltZW50X3JlcXVlc3RfaWQ9NWM0MjVjMjctMDVhNy00ODE5LWJkYjAtZGI3ZDU4Y2ZjNjYwJmxvY2FsZT1lbl9VUyZjbGllbnRfaWQ9M2QwZGNhN2RhZGE1NGUxOWI1YWYwMjRlZjk3Nzc0Mzg=
        debtor:
          name: Roberto Molli
          account:
            accountId: IT60X0542811101000000123456
            accountIdType: IBAN
        creditor:
          name: Newgen Media LLC
          account:
            accountId: IT60X0542811101000000123987
            accountIdType: IBAN
        reference: 'subscription - #78158300'
    PaymentResponseGermanyRTPCancelled:
      value:
        id: a14a49b4-b21e-416e-ab8d-c0e57efbd2ea
        status: CANCELLED
        statusUpdatedAt: '2023-08-20T13:31:25Z'
        createdAt: '2023-08-20T13:31:25Z'
        paymentAmount:
          value: '150.00'
          currency: EUR
        paymentType: REAL_TIME_PAYMENTS
        market: DE
        redirectURL: https://sites.obtest.com/sites/cib
        paymentLinkURL: https://paybybank.jpmorgan.com/1.0/pay/direct?client_id=9cd2e1c9527e4e18ad4756393e09cb2c&redirect_uri=https://sites.obtest.com/sites/cib&market=DE&payment_request_id=1b036f9c-8c84-4ce6-b1dd-5979472945a1
        paymentQRCode: https://paybybank.jpmorgan.com/api-proxy/api/enablement/v2/payments/qr/aHR0cHM6Ly9wYXlieWJhbmsuanBtb3JnYW4uY29tLzEuMC9wYXkvZGlyZWN0P21hcmtldD1HQiZyZWRpcmVjdF91cmk9aHR0cHM6Ly9zaXRlcy5vYnRlc3QuY29tL3NpdGVzL2NpYiZwYXltZW50X3JlcXVlc3RfaWQ9NWM0MjVjMjctMDVhNy00ODE5LWJkYjAtZGI3ZDU4Y2ZjNjYwJmxvY2FsZT1lbl9VUyZjbGllbnRfaWQ9M2QwZGNhN2RhZGE1NGUxOWI1YWYwMjRlZjk3Nzc0Mzg=
        debtor:
          name: Joshua Sundar
          account:
            accountId: DE89370400440532013000
            accountIdType: IBAN
        creditor:
          name: Newgen Media LLC
          account:
            accountId: DE89370400440532013987
            accountIdType: IBAN
        reference: 'subscription - #99604300'
    PaymentResponseUKRTPSettled:
      value:
        id: 1b036f9c-8c84-4ce6-b1dd-5979472945a1
        status: SETTLED
        statusUpdatedAt: '2023-08-20T13:31:25Z'
        createdAt: '2023-08-20T13:31:25Z'
        paymentAmount:
          value: '100.00'
          currency: GBP
        paymentType: REAL_TIME_PAYMENTS
        market: GB
        redirectURL: https://sites.obtest.com/sites/cib
        paymentLinkURL: https://paybybank.jpmorgan.com/1.0/pay/direct?client_id=9cd2e1c9527e4e18ad4756393e09cb2c&redirect_uri=https://sites.obtest.com/sites/cib&market=DE&payment_request_id=1b036f9c-8c84-4ce6-b1dd-5979472945a1
        paymentQRCode: https://paybybank.jpmorgan.com/api-proxy/api/enablement/v2/payments/qr/aHR0cHM6Ly9wYXlieWJhbmsuanBtb3JnYW4uY29tLzEuMC9wYXkvZGlyZWN0P21hcmtldD1HQiZyZWRpcmVjdF91cmk9aHR0cHM6Ly9zaXRlcy5vYnRlc3QuY29tL3NpdGVzL2NpYiZwYXltZW50X3JlcXVlc3RfaWQ9NWM0MjVjMjctMDVhNy00ODE5LWJkYjAtZGI3ZDU4Y2ZjNjYwJmxvY2FsZT1lbl9VUyZjbGllbnRfaWQ9M2QwZGNhN2RhZGE1NGUxOWI1YWYwMjRlZjk3Nzc0Mzg=
        debtor:
          name: Bala Thandapani
          account:
            accountId: 06080912311871
            accountIdType: SORT_CODE
        creditor:
          name: Newgen Media LLC
          account:
            accountId: '11223387654321'
            accountIdType: SORT_CODE
        reference: 'subscription - #78004300'
        acknowledged: ACKNOWLEDGED
    IdempotencyKeyMissingError:
      value:
        title: Invalid Data
        httpStatus: 400
        traceId: 0eca2e1a-74b7-44b7-9e66-4a6ec8336eb9
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - code: '10106'
          message: Idempotency-Key header is missing.
          location: HEADER
    PaymentResponseInvalidCurrency:
      value:
        title: Invalid Data
        httpStatus: 400
        traceId: 6b03ac09-0d9e-4c72-909d-fad6a627f0c2
        requestId: 7215813e-ac80-4ddc-9f67-9fbfc1ac934c
        context:
        - code: '10001'
          message: Destination country and currency combination is invalid.
          field: $.market
          location: BODY
    ResourceNotFound:
      value:
        title: Resource Not Found
        httpStatus: 404
        traceId: 0eca2e1a-74b7-44b7-9e66-4a6ec8336eb9
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - message: Invalid resource identifier provided.
          field: id
          location: PATH
    PaymentResponseAccountNotFound:
      value:
        title: Invalid Data
        httpStatus: 400
        traceId: b183d4cb-cc4b-437a-9342-09f7696d0c1c
        requestId: 71ed084e-4d25-492a-a942-4cbeea38e271
        context:
        - code: '10001'
          message: creditor accountId not found
          field: $.creditor.account.accountId
          location: BODY
    PaymentResponseBadFormat:
      value:
        title: Bad Format
        httpStatus: 400
        traceId: b41cb267-51db-4eb1-9bc6-fc93d85d78a7
        requestId: 442b4c6f-c52d-4e40-8a64-fd7fb9ca0089
        context:
        - code: '10103'
          message: The accountId provided is in a bad format.
          field: $.creditor.account.accountId
          location: BODY
    InvalidDataError:
      value:
        title: Invalid Data
        httpStatus: 400
        traceId: 0eca2e1a-74b7-44b7-9e66-4a6ec8336eb9
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - code: '10001'
          message: Property amount is mandatory.
          field: $.paymentAmount.amount
          location: BODY
    SecurityFailureError:
      value:
        title: Security Failure
        httpStatus: 403
        traceId: 5914f136-4544-4b1c-8004-6c2388ba76b4
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - code: '14000'
          message: Invalid client profile
    BadFormatError:
      value:
        title: Bad Format
        httpStatus: 400
        traceId: 0eca2e1a-74b7-44b7-9e66-4a6ec8336eb9
        requestId: d3dd646b-1fd0-4389-b6b4-0c3ab486bvg1
        context:
        - code: '10103'
          message: The identifier provided is not a valid format.
          field: id
          location: PATH
    PaymentResponseSwedenRTP:
      value:
        id: e5c9c1d2-65fb-4f0c-ba21-b71c8885a50b
        status: NONE
        statusUpdatedAt: '2023-08-20T13:31:25Z'
        createdAt: '2023-08-20T13:31:25Z'
        paymentAmount:
          value: '105.00'
          currency: EUR
        paymentType: REAL_TIME_PAYMENTS
        market: SE
        redirectURL: https://sites.obtest.com/sites/cib
        paymentLinkURL: https://paybybank.jpmorgan.com/1.0/pay/direct?client_id=9cd2e1c9527e4e18ad4756393e09cb2c&redirect_uri=https://sites.obtest.com/sites/cib&market=SE&payment_request_id=1b036f9c-8c84-4ce6-b1dd-5979472945a1
        paymentQRCode: https://paybybank.jpmorgan.com/api-proxy/api/enablement/v2/payments/qr/aHR0cHM6Ly9wYXlieWJhbmsuanBtb3JnYW4uY29tLzEuMC9wYXkvZGlyZWN0P21hcmtldD1HQiZyZWRpcmVjdF91cmk9aHR0cHM6Ly9zaXRlcy5vYnRlc3QuY29tL3NpdGVzL2NpYiZwYXltZW50X3JlcXVlc3RfaWQ9NWM0MjVjMjctMDVhNy00ODE5LWJkYjAtZGI3ZDU4Y2ZjNjYwJmxvY2FsZT1lbl9VUyZjbGllbnRfaWQ9M2QwZGNhN2RhZGE1NGUxOWI1YWYwMjRlZjk3Nzc0Mzg=
        debtor:
          name: Jenifer Laurence
          account:
            accountId: SE4550000000058398257466
            accountIdType: IBAN
        creditor:
          name: Newgen Media LLC
          account:
            accountId: SE4550000000058398257987
            accountIdType: IBAN
        reference: 'subscription - #79694300'
  responses:
    201-PaymentInitiationCreated:
      description: Created
      headers:
        Location:
          $ref: '#/components/headers/Location'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentInitiationResponse'
          examples:
            RealTimeBRPIXPaymentInitiationCreatedResponse:
              $ref: '#/components/examples/RealTimeBRPIXPmtStatus'
            RealTimeUKFPSPaymentInitiationCreatedResponse:
              $ref: '#/components/examples/RealTimeUKFPSPmtStatus'
        application/jose:
          schema:
            $ref: '#/components/schemas/SignedContent'
          examples:
            Signed Payment Response - JOSE:
              $ref: '#/components/examples/JWSResponseJOSE'
    403-Forbidden:
      description: "Forbidden \n| Error Code    | Description                                |\n|---------------|--------------------------------------------|\n|  14000        | Security failure                           |     "
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Forbidden:
              $ref: '#/components/examples/ErrorUnauthorized'
            AccountAuthorizationFailure:
              $ref: '#/components/examples/ErrorAccountAuthorization'
    200-PaymentInitiationDuplicate:
      description: Ok
      headers:
        Duplicate-Request:
          $ref: '#/components/headers/DuplicateRequest'
        Location:
          $ref: '#/components/headers/Location'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentInitiationDuplicateResponse'
          examples:
            DuplicatePaymentResponse:
              $ref: '#/components/examples/PaymentInitiationDuplicateResponse'
        application/jose:
          schema:
            $ref: '#/components/schemas/SignedContent'
    422-UnprocessableEntity:
      description: Unprocessable Entity
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            UnprocessableEntityMalformedPAN:
              $ref: '#/components/examples/MalformedPANError'
            UnprocessableEntitySuspiciousContent:
              $ref: '#/components/examples/SuspiciousContent'
            UnprocessableEntityMissingProgramId:
              $ref: '#/components/examples/ProgramIdMissing'
            UnprocessableEntityInvalidProgramId:
              $ref: '#/components/examples/InvalidProgramId'
            IdempotencyFailure:
              $ref: '#/components/examples/IdempotencyFailure'
    400-BadRequest:
      description: "Bad Request \n\n**List of Error codes and Usage explanations.**\n\n| Error Code      |           Usage                                |\n| --------------  |------------------------------------------------|\n| 10001           | Mandatory field missing                        |\n| 10002           | Minimum length violation                       |\n| 10003           | Maximum length violation                       |\n| 10100           | Minimum value violation                        |\n| 10101           | Maximum value violation                        |\n| 10102           | Range violation                                |\n| 10103           | Bad format                                     |\n| 10104           | Bad value                                      |\n| 10105           | Unexpected field                               |\n| 10106           | Idempotency failure                            |\n| 10107           | Concurrent request failure                     |\n| 10199           | Other                                          |\n| 11000 - 11499   | Account/Permission Problems                    |\n| 11500 - 11999   | General Business Errors                        |\n| 12000 - 12499   | Timeouts                                       |\n| 12500 - 12999   | Service Offline                                |\n| 13000           | Other Errors                                   |\n| 14000           | Security Failure                               |\n| 15000           | System Error                                   |"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            InvalidData:
              $ref: '#/components/examples/ErrorInvalidData'
            BusinessValidationError:
              $ref: '#/components/examples/ErrorBusinessValidation'
    200-PaymentDetailOK:
      description: Ok
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentDetail'
          examples:
            SEPAInstantPaymentDetailsFull:
              $ref: '#/components/examples/RealTimeSEPAInstantPmtDetailsResponseFull'
            SGFasterPaymentDetailsFull:
              $ref: '#/components/examples/RealTimeSGFPSPmtDetailsResponseFull'
            INIMPSPaymentDetailsSummary:
              $ref: '#/components/examples/RealTimeINIMPSPmtStatus'
        application/jose:
          schema:
            $ref: '#/components/schemas/SignedContent'
    401-UnAuthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            UnAuthenticated:
              $ref: '#/components/examples/ErrorUnauthenticated'
    404-NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            InvalidData:
              $ref: '#/components/examples/ErrorNotFound'
    503-ServiceUnavailable:
      description: 'Service Unavailable


        | Error Code    | Description                                |

        |---------------|----------------------------------------------------------------------------------------------|

        |  12995        | Service is temporarily unavailable. Please try again after sometime.( Accompanied by Retry-After Header)                      |

        |  12999        | Service is temporarily unavailable. Please try again after sometime.                                                           |'
      headers:
        Retry-After:
          description: The number of seconds to wait before retrying the request.
          schema:
            type: integer
            minimum: 1
            example: 600
            default: 600
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            SystemUnavailable:
              $ref: '#/components/examples/ErrorSystemUnavailable'
            SystemUnavailableWithRetryAfterHeader:
              $ref: '#/components/examples/ErrorSystemUnavailableWithRetryAfterHeader'
    200-PaymentQueryOK:
      description: Ok
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentDetails'
          examples:
            SEPAInstantPaymentQueryFull:
              $ref: '#/components/examples/RealTimeSEPAInstantPmtQueryResponseFull'
            SEPAInstantPaymentQuerySummary:
              $ref: '#/components/examples/RealTimeSEPAInstantPmtQueryResponseSummary'
        application/jose:
          schema:
            $ref: '#/components/schemas/SignedContent'
    503-ServiceUnavailable_2:
      description: "Service Unavailable.\n              \n*List of Error codes and Rule definitions.* \n| Error Code    | Description       |\n|---------------|-------------------|\n|   12000       | System error      |"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error_2'
          examples:
            ServiceUnavailableError:
              $ref: '#/components/examples/ServiceUnavailableError'
    409-Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error_2'
          examples:
            ConflictError:
              $ref: '#/components/examples/ConflictError'
    403-Forbidden_2:
      description: "Forbidden. \n| Error Code    | Description                                |\n|---------------|--------------------------------------------|\n|  14000        | Security failure                           |     "
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error_2'
          examples:
            SecurityFailureError:
              $ref: '#/components/examples/SecurityFailureError'
    200-Acknowledged:
      description: Successful
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentResponse'
          examples:
            PaymentResponseUKRTP:
              $ref: '#/components/examples/PaymentResponseUKRTP'
            PaymentResponseGermanyRTP:
              $ref: '#/components/examples/PaymentResponseGermanyRTP'
            PaymentResponseFranceRTP:
              $ref: '#/components/examples/PaymentResponseFranceRTP'
            PaymentResponseItalyRTP:
              $ref: '#/components/examples/PaymentResponseItalyRTP'
            PaymentResponseSpainRTP:
              $ref: '#/components/examples/PaymentResponseSpainRTP'
    404-NotFound_2:
      description: Resource Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error_2'
          examples:
            ResourceNotFoundError:
              $ref: '#/components/examples/ResourceNotFound'
    401-Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error_2'
          examples:
            UnauthorizedError:
              $ref: '#/components/examples/Unauthorized'
    202-Accepted:
      description: Accepted
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentResponse'
          examples:
            PaymentResponseUKRTP:
              $ref: '#/components/examples/PaymentInitiationResponseUKRTP'
            PaymentResponseGermanyRTP:
              $ref: '#/components/examples/PaymentInitiationResponseDERTP'
            PaymentResponseFranceRTP:
              $ref: '#/components/examples/PaymentResponseFranceRTP'
            PaymentResponseItalyRTP:
              $ref: '#/components/examples/PaymentResponseItalyRTP'
            PaymentResponseSpainRTP:
              $ref: '#/components/examples/PaymentInitiationResponseSpainRTP'
    400-BadRequest_2:
      description: "Bad Request. \n              \n**List of Error codes and Usage explanations.**\n              \n| Error Code      |           Usage                                |\n| --------------  |------------------------------------------------|\n| 10001           | Mandatory field missing                        |\n| 10002           | Minimum length violation                       |\n| 10003           | Maximum length violation                       |\n| 10100           | Minimum value violation                        |\n| 10101           | Maximum value violation                        |\n| 10102           | Range violation                                |\n| 10103           | Bad format                                     |\n| 10104           | Bad value                                      |\n| 10105           | Unexpected field                               |\n| 10106           | Idempotency Check Failure                      |\n| 10199           | Other                                          |\n| 13000           | Uncategorized error                            |"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error_2'
          examples:
            InvalidDataError:
              $ref: '#/components/examples/InvalidDataError'
            IdempotencyKeyMissingError:
              $ref: '#/components/examples/IdempotencyKeyMissingError'
            BadAccountIdFormat:
              $ref: '#/components/examples/PaymentResponseBadFormat'
            InvalidCurrencyMarket:
              $ref: '#/components/examples/PaymentResponseInvalidCurrency'
            InvalidAccountId:
              $ref: '#/components/examples/PaymentResponseAccountNotFound'
    200-Successful:
      description: Successful
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentResponse'
          examples:
            PaymentResponseUKRTP:
              $ref: '#/components/examples/PaymentResponseUKRTP'
            PaymentResponseUKRTPSettled:
              $ref: '#/components/examples/PaymentResponseUKRTPSettled'
            PaymentResponseUKFailed:
              $ref: '#/components/examples/PaymentResponseUKRTPFailed'
            PaymentResponseGermanyFailed:
              $ref: '#/components/examples/PaymentResponseGermanyRTPCancelled'
            PaymentResponseGermanyRTP:
              $ref: '#/components/examples/PaymentResponseGermanyRTP'
            PaymentResponseFranceRTP:
              $ref: '#/components/examples/PaymentResponseFranceRTP'
            PaymentResponseItalyRTP:
              $ref: '#/components/examples/PaymentResponseItalyRTP'
            PaymentResponseSpainRTP:
              $ref: '#/components/examples/PaymentResponseSpainRTP'
            PaymentResponseSwedenRTP:
              $ref: '#/components/examples/PaymentResponseSwedenRTP'
            PaymentResponseNorwayRTP:
              $ref: '#/components/examples/PaymentResponseNorwayRTP'
    400-BadRequest-Non-State-Change:
      description: "Bad Request. \n              \n**List of Error codes and Usage explanations.**\n| Error Code      |           Usage                                |\n| --------------  |------------------------------------------------|\n| 10103           | Bad format                                     |"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error_2'
          examples:
            BadFormatError:
              $ref: '#/components/examples/BadFormatError'
  parameters:
    RequestId:
      name: Request-Id
      in: header
      description: 'Client generated identifier for the current request invocation.

        If provided, this identifier will be included in error responses to assist in problem diagnosis.'
      required: false
      schema:
        $ref: '#/components/schemas/RequestId'
    View:
      name: view
      in: query
      description: Determines the level of detail in the response.
      schema:
        $ref: '#/components/schemas/View'
      required: false
    PaymentId:
      name: paymentId
      in: path
      description: JPMC generated payment identifier
      required: true
      schema:
        $ref: '#/components/schemas/PaymentId'
    PaymentType:
      name: paymentType
      in: query
      description: 'Payment type.

        **Providing paymentType is optional but when provided, it enhances both query efficiency and response times.**

        '
      required: false
      schema:
        $ref: '#/components/schemas/PaymentType'
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      description: 'Client generated unique idempotency key used in recognizing consecutive retries of the same request


        **Usage of V4 UUIDs is recommended.**'
      schema:
        $ref: '#/components/schemas/IdempotencyKey'
      required: false
    ViewOnlyRequestId:
      name: Request-Id
      in: header
      description: 'Client generated identifier for the current request invocation.

        If provided, this identifier will be included in error responses to assist in problem diagnosis.'
      required: false
      schema:
        $ref: '#/components/schemas/RequestId'
    PaymentIdQuery:
      name: paymentId
      in: query
      description: JPMC generated payment identifier
      schema:
        $ref: '#/components/schemas/PaymentId'
      required: false
    EndToEndId:
      name: endToEndId
      in: query
      description: 'Customer assigned Unique identifier to unambiguously identify the Payment transaction.

        This identification is passed on, unchanged, throughout the entire end-to-end chain.'
      required: false
      schema:
        $ref: '#/components/schemas/EndToEndId'
      examples:
        RTP - SEPA Instant Payments:
          summary: RTP - SEPA Instant Payments - endToEndId
          value: SEPAINSTANTTEST
        RTP - US Wallet Withdrawal:
          summary: US RTP  Wallet Withdrawals - endToEndId
          value: USRTPWALLETTEST
        RTP - Australia NPP Payments:
          summary: RTP - Australia NPP Payments - endToEndId
          value: AUNPPTEST
        RTP - Australia NPP Cross Border TP3 Payments:
          summary: RTP - Australia NPP Cross Border TP3 Payments - endToEndId
          value: 20251014ABCDEFKX010OCB13784502
        RTP - Australia NPP Cross Border TP4 Payments:
          summary: RTP - Australia NPP Cross Border TP4 Payments - endToEndId
          value: 20251014ABCDEFKX010OCB13784501
        RTP - Singapore FPS Payments:
          summary: RTP - Singapore FPS Payments - endToEndId
          value: SGFASTERPMT
        RTP - Hong Kong FPS Payments:
          summary: RTP- Hong Kong FPS Payments - endToEndId
          value: SGFASTERPMT
        RTP - UK FPS Payments:
          summary: RTP - UK FPS Payments - endToEndId
          value: UKFPSTEST
        RTP - UK FPS Payments (Agency Banking):
          summary: RTP - UK FPS Payments (Agency Banking) - endToEndId
          value: UK20250907T125
        RTP - Brazil PIX Payments:
          summary: RTP - Brazil PIX Payments - endToEndId
          value: BRPIXTEST
        RTP - Mexico SPEI Payments:
          summary: RTP - Mexico SPEI Payments - endToEndId
          value: MXRTPTEST
        RTP - Malaysia RPP Payments:
          summary: RTP - Malaysia RPP Payments - endToEndId
          value: MYSRPTEST
        RTP - Indonesia FPS Payments:
          summary: RTP - Indonesia FPS Payments - endToEndId
          value: IDFASTERPMTTEST
        RTP - India IMPS Payments:
          summary: RTP - India IMPS Payments - endToEndId
          value: INIMPSTEST
        RTP - India IMPS RDA (FIR) Payments:
          summary: RTP - India IMPS RDA (FIR) Payments - endToEndId
          value: INIMPSTESTRDA
        RTP - Thailand PromptPay Pay-to-Account Payments:
          summary: RTP - Thailand PromptPay Pay-to-Account Payments - endToEndId
          value: THPPTESTVF
        RTP - Thailand PromptPay Pay-to-Proxy (Mobile Number) Payments:
          summary: RTP - Thailand PromptPay Pay-to-Proxy (Mobile Number) Payments - endToEndId
          value: THPPTESTPF
        Alternate Payments - Canada Interac Payments:
          summary: Canada Interac Payments - endToEndId
          value: INTERACTEST
        Alternate Payments - Kinexys Digital Payments (DDA to BDA) Payments:
          summary: Kinexys Digital Payments (DDA to BDA) Payments - endToEndId
          value: KINEXYSTEST
        Alternate Payments - Kinexys Digital Payments (BDA to BDA) Payments:
          summary: Kinexys Digital Payments (BDA to BDA) Payments - endToEndId
          value: KINEXYSTEST2
        Alternate Payments - Kinexys Digital Payments (BDA to DDA) Payments:
          summary: Kinexys Digital Payments (BDA to DDA) Payments - endToEndId
          value: KINEXYSTEST1
        Alternate Payments - Push To Card Payments:
          summary: Push To Card Payments - endToEndId
          value: P2CTEST
        Alternate Payments - PAYPAL Payments:
          summary: PAYPAL Payments - endToEndId
          value: P2PPLTEST
        Alternate Payments - VENMO Payments:
          summary: VENMO Payments - endToEndId
          value: P2VENMOTEST
        Alternate Payments - Zelle Payments:
          summary: Zelle Payments - endToEndId
          value: ZELLETEST
        ACH - Chile LV Credit Payments:
          summary: ACH - Chile LV Credit Payments - endToEndId
          value: CL_ACH_TEST
        ACH - US Credit Payments:
          summary: ACH - US Credit Payments - endToEndId
          value: USACHCRTEST
        ACH - US Debit Payments:
          summary: ACH - US Debit Payments - endToEndId
          value: USACHDBTEST
  headers:
    Location:
      description: URI (Relative URI) of the referenced resource.
      schema:
        title: Location
        type: string
        format: uri-reference
        pattern: ^/[a-zA-Z0-9/_\-\.~:\?#\[\]@!\$&'\(\)\*\+,;=%]+$
      required: true
      examples:
        PaymentLocation:
          value: /payment/v2/payments/95364018-be32-4c71-9618-f1ceba78f28c
        ReturnLocation:
          value: /payment/v2/payments/returns/95364018-be32-4c71-9618-f1ceba78f28c
    DuplicateRequest:
      description: Indicates that the request is a duplicate of a previous request
      schema:
        title: Duplicate-Request
        type: boolean
      required: true
  requestBodies:
    InitiatePayment:
      description: Representation of a Payment Initiation Request
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Payment'
          examples:
            RTP - UK Faster Payments:
              $ref: '#/components/examples/RealTimeUKFPS'
            RTP - UK Faster Payments (Agency Banking):
              $ref: '#/components/examples/RealTimeUKFPSAgencyBanking'
            RTP - SEPA Instant Payments:
              $ref: '#/components/examples/RealTimeSEPAInstant'
            RTP - AU NPP Payments:
              $ref: '#/components/examples/RealTimeAUNPP'
            RTP - AU NPP Cross Border TP3 Payments:
              $ref: '#/components/examples/RealTimeAUNPPCrossBorderTP3'
            RTP - AU NPP Cross Border TP4 Payments:
              $ref: '#/components/examples/RealTimeAUNPPCrossBorderTP4'
            RTP - SG Faster Payments:
              $ref: '#/components/examples/RealTimeSGFPS'
            RTP - HK Faster Payments:
              $ref: '#/components/examples/RealTimeHKFPS'
            RTP - MY RPP Payments:
              $ref: '#/components/examples/RealTimeMYRPPCredit'
            RTP - ID Faster Payments:
              $ref: '#/components/examples/RealTimeIDFPS'
            RTP - BR PIX Payments:
              $ref: '#/components/examples/RealTimeBRPIX'
            RTP - US Payments (Wallet Withdrawals):
              $ref: '#/components/examples/RealTimeUSRTPWalletWithdrawals'
            RTP - MX SPEI Payments:
              $ref: '#/components/examples/RealTimeMXSPEI'
            RTP - IN IMPS Payments:
              $ref: '#/components/examples/RealTimeINIMPS'
            RTP - IN IMPS RDA (FIR) Payments:
              $ref: '#/components/examples/RealTimeINIMPSRDA'
            RTP - Thailand PromptPay (Pay-to-Account):
              $ref: '#/components/examples/RealTimeTHPromptPay'
            RTP - Thailand PromptPay (Pay-to-Proxy - Mobile Number):
              $ref: '#/components/examples/RealTimeTHPromptPayProxy'
            Kinexys Digital Payments - SG (DDA to BDA):
              $ref: '#/components/examples/AlternateKinexysDigitalPaymentsDDAtoBDA'
            Kinexys Digital Payments - BDA (BDA to BDA):
              $ref: '#/components/examples/AlternateKinexysDigitalPaymentsBDAtoBDA'
            Kinexys Digital Payments - BDA (BDA to DDA):
              $ref: '#/components/examples/AlternateKinexysDigitalPaymentsBDAtoDDA'
            Push To Card - US:
              $ref: '#/components/examples/AlternateP2C'
            Push To Card - US (TP3):
              $ref: '#/components/examples/AlternateP2CTP3'
            Push To Wallet - US (PayPal-Email):
              $ref: '#/components/examples/AlternateP2WPaypal'
            Push To Wallet - US (Venmo):
              $ref: '#/components/examples/AlternateP2WVenmo'
            Zelle - US:
              $ref: '#/components/examples/AlternateP2WZelle'
            ACH - US Credit Transfer:
              $ref: '#/components/examples/AchUSCreditTransfer'
            ACH - US Direct Debit:
              $ref: '#/components/examples/AchUSDebitTransfer'
            ACH - CL Credit Transfer:
              $ref: '#/components/examples/AchChileLowValueCreditTransfer'
            CBPR RTP SEPA Creditor:
              $ref: '#/components/examples/RealTimeSEPAMinimalCreditorAddress'
            CBPR RTP SEPA Ultimate Debtor:
              $ref: '#/components/examples/RealTimeSEPAMinimalUltimateDebtorAddress'
            CBPR RTP SEPA Ultimate Creditor Hybrid:
              $ref: '#/components/examples/RealTimeSEPAMinimalUltimateCreditorHybridAddress'
            CBPR US Wires Debtor:
              $ref: '#/components/examples/WiresCrossBorderPacs008MinimalDebtorAddress'
            CBPR US Wires Creditor:
              $ref: '#/components/examples/WiresCrossBorderPacs008MinimalCreditorAddress'
            CBPR US Wires Debtor - Hybrid:
              $ref: '#/components/examples/WiresCrossBorderPacs008HybridDebtorAddress'
        application/jose:
          schema:
            $ref: '#/components/schemas/SignedContent'
          examples:
            Signed Payment Request - JOSE:
              $ref: '#/components/examples/JWSRequestJOSE'
    PaymentsCallback:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PaymentResponse'
          examples:
            Sample Callback Request UK RTP:
              $ref: '#/components/examples/PaymentResponseUKRTP'
            Sample Callback Request Germany RTP:
              $ref: '#/components/examples/PaymentResponseGermanyRTP'
            Sample Callback Request Sweden RTP:
              $ref: '#/components/examples/PaymentResponseSwedenRTP'
            Sample Callback Request France RTP:
              $ref: '#/components/examples/PaymentResponseFranceRTP'
            Sample Callback Request Italy RTP:
              $ref: '#/components/examples/PaymentResponseItalyRTP'
            Sample Callback Request Spain RTP:
              $ref: '#/components/examples/PaymentResponseSpainRTP'
            Sample Callback Request Norway RTP:
              $ref: '#/components/examples/PaymentResponseNorwayRTP'
      required: true
      description: 'Representation of Payments Callback '
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- jp-morgan-chase-global-payments-openapi.yml
- jp-morgan-chase-payment-initiation-service-openapi.yml
x-jpmc-securityDefinitions:
  JPMC-OAuth2:
    jpmc-claims:
      jpmc-roles: []
x-jpmc-security:
- JPMC-OAuth2:
    jpmc-claims:
      jpmc-roles: []