openapi: 3.2.0 info: title: Form3 Public Payment Writes API version: '1' servers: - url: https://api.form3.tech/v1 security: - OAuth2: [] tags: - name: PaymentWrites paths: /transaction/payments: post: operationId: CreatePayment responses: 201: description: Payment creation response content: application/vnd.api+json: schema: $ref: '#/components/schemas/PaymentCreationResponse' application/json: schema: $ref: '#/components/schemas/PaymentCreationResponse' 400: description: Payment creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' summary: Create payment tags: - PaymentWrites x-access: - Public - FPS - Bacs - SEPA requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/PaymentCreation' application/json: schema: $ref: '#/components/schemas/PaymentCreation' /transaction/payments/{id}/admissions/{admissionId}/tasks/{taskId}: parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid - description: Admission Id in: path name: admissionId required: true schema: type: string format: uuid - description: Payment Admission Task Id in: path name: taskId required: true schema: type: string format: uuid patch: operationId: PatchPaymentAdmissionTask responses: 200: description: Payment Admission Task update response content: application/vnd.api+json: schema: $ref: '#/components/schemas/PaymentAdmissionTaskDetailsResponse' application/json: schema: $ref: '#/components/schemas/PaymentAdmissionTaskDetailsResponse' 400: description: Error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 409: description: Conflict content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiErrorWithActualResource' application/json: schema: $ref: '#/components/schemas/ApiErrorWithActualResource' summary: Patch Payment Admission Task tags: - PaymentWrites x-access: - Public requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentAdmissionTaskAmendment' /transaction/payments/{id}/advices: post: operationId: CreatePaymentAdvice parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid responses: 201: description: Advice creation response content: application/vnd.api+json: schema: $ref: '#/components/schemas/AdviceCreationResponse' application/json: schema: $ref: '#/components/schemas/AdviceCreationResponse' 400: description: Advice creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' summary: Create advice tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/AdviceCreation' application/json: schema: $ref: '#/components/schemas/AdviceCreation' /transaction/payments/{id}/advices/{adviceId}/submissions: post: operationId: CreatePaymentAdviceSubmission parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid - description: Advice Id in: path name: adviceId required: true schema: type: string format: uuid responses: 201: description: Advice submission creation response content: application/vnd.api+json: schema: $ref: '#/components/schemas/AdviceSubmissionCreationResponse' application/json: schema: $ref: '#/components/schemas/AdviceSubmissionCreationResponse' 400: description: Advice submission creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' summary: create advice submission tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/AdviceSubmissionCreation' application/json: schema: $ref: '#/components/schemas/AdviceSubmissionCreation' /transaction/payments/{id}/recalls: post: operationId: CreatePaymentRecall parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid responses: 201: description: Recall creation response content: application/vnd.api+json: schema: $ref: '#/components/schemas/RecallCreationResponse' application/json: schema: $ref: '#/components/schemas/RecallCreationResponse' 400: description: Recall creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' summary: Create recall tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/RecallCreation' application/json: schema: $ref: '#/components/schemas/RecallCreation' /transaction/payments/{id}/recalls/{recallId}/decisions: post: operationId: CreatePaymentRecallDecision parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid - description: Recall Id in: path name: recallId required: true schema: type: string format: uuid responses: 201: description: Recall decision creation response content: application/vnd.api+json: schema: $ref: '#/components/schemas/RecallDecisionCreationResponse' application/json: schema: $ref: '#/components/schemas/RecallDecisionCreationResponse' 400: description: Recall decision creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' summary: Create recall decision tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/RecallDecisionCreation' application/json: schema: $ref: '#/components/schemas/RecallDecisionCreation' /transaction/payments/{id}/recalls/{recallId}/decisions/{decisionId}/submissions: post: operationId: CreatePaymentRecallDecisionSubmission parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid - description: Recall Id in: path name: recallId required: true schema: type: string format: uuid - description: Decision Id in: path name: decisionId required: true schema: type: string format: uuid responses: 201: description: Recall decision submission creation response content: application/vnd.api+json: schema: $ref: '#/components/schemas/RecallDecisionSubmissionCreationResponse' application/json: schema: $ref: '#/components/schemas/RecallDecisionSubmissionCreationResponse' 400: description: Recall decision submission creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' summary: Create recall decision submission tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/RecallDecisionSubmissionCreation' application/json: schema: $ref: '#/components/schemas/RecallDecisionSubmissionCreation' /transaction/payments/{id}/recalls/{recallId}/submissions: post: operationId: CreatePaymentRecallSubmission parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid - description: Recall Id in: path name: recallId required: true schema: type: string format: uuid responses: 201: description: Recall submission creation response content: application/vnd.api+json: schema: $ref: '#/components/schemas/RecallSubmissionCreationResponse' application/json: schema: $ref: '#/components/schemas/RecallSubmissionCreationResponse' 400: description: Recall submission creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' summary: Create recall submission tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/RecallSubmissionCreation' application/json: schema: $ref: '#/components/schemas/RecallSubmissionCreation' /transaction/payments/{id}/returns: post: operationId: CreatePaymentReturn parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid responses: 201: description: Return creation response content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReturnCreationResponse' application/json: schema: $ref: '#/components/schemas/ReturnCreationResponse' 400: description: Return creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 401: description: Return creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 403: description: Return creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 404: description: Return creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 409: description: Return creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 500: description: Return creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' summary: Create return tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReturnCreation' application/json: schema: $ref: '#/components/schemas/ReturnCreation' /transaction/payments/{id}/returns/{returnId}/reversals: post: operationId: CreatePaymentReturnReversal parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid - description: Return Id in: path name: returnId required: true schema: type: string format: uuid responses: 201: description: Reversal creation response content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReturnReversalCreationResponse' application/json: schema: $ref: '#/components/schemas/ReturnReversalCreationResponse' 400: description: Reversal creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 401: description: Reversal creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 403: description: Reversal creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 404: description: Reversal creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 409: description: Reversal creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 500: description: Reversal creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' summary: Create return reversal tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReturnReversalCreation' application/json: schema: $ref: '#/components/schemas/ReturnReversalCreation' /transaction/payments/{id}/returns/{returnId}/submissions: post: operationId: CreatePaymentReturnSubmission parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid - description: Return Id in: path name: returnId required: true schema: type: string format: uuid responses: 201: description: Return submission creation response content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReturnSubmissionCreationResponse' application/json: schema: $ref: '#/components/schemas/ReturnSubmissionCreationResponse' 400: description: Return submission creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 401: description: Return submission creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 403: description: Return submission creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 404: description: Return submission creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 409: description: Return submission creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 500: description: Return submission creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' summary: create return submission tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReturnSubmissionCreation' application/json: schema: $ref: '#/components/schemas/ReturnSubmissionCreation' /transaction/payments/{id}/reversals: post: operationId: CreatePaymentReversal parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid responses: 201: description: Reversal creation response content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReversalCreationResponse' application/json: schema: $ref: '#/components/schemas/ReversalCreationResponse' 400: description: Reversal creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' summary: Create reversal tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReversalCreation' application/json: schema: $ref: '#/components/schemas/ReversalCreation' /transaction/payments/{id}/reversals/{reversalId}/admissions/{admissionId}/tasks/{taskId}: parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid - description: Reversal Id in: path name: reversalId required: true schema: type: string format: uuid - description: Admission Id in: path name: admissionId required: true schema: type: string format: uuid - description: Reversal Admission Task Id in: path name: taskId required: true schema: type: string format: uuid patch: operationId: PatchReversalAdmissionTask responses: 200: description: Reversal Admission Task update response content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReversalAdmissionTaskDetailsResponse' application/json: schema: $ref: '#/components/schemas/ReversalAdmissionTaskDetailsResponse' 400: description: Error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 409: description: Conflict content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' summary: Patch Reversal Admission Task tags: - PaymentWrites x-access: - Public requestBody: content: application/json: schema: $ref: '#/components/schemas/ReversalAdmissionTaskAmendment' /transaction/payments/{id}/reversals/{reversalId}/submissions: post: operationId: CreatePaymentReversalSubmission parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid - description: Reversal Id in: path name: reversalId required: true schema: type: string format: uuid responses: 201: description: Reversal submission creation response content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReversalSubmissionCreationResponse' application/json: schema: $ref: '#/components/schemas/ReversalSubmissionCreationResponse' 400: description: Reversal submission creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' summary: Create reversal submission tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReversalSubmissionCreation' application/json: schema: $ref: '#/components/schemas/ReversalSubmissionCreation' /transaction/payments/{id}/submissions: post: operationId: CreatePaymentSubmission parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid responses: 201: description: Submission creation response content: application/vnd.api+json: schema: $ref: '#/components/schemas/PaymentSubmissionCreationResponse' application/json: schema: $ref: '#/components/schemas/PaymentSubmissionCreationResponse' 400: description: Submission creation error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' summary: create submission tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/PaymentSubmissionCreation' application/json: schema: $ref: '#/components/schemas/PaymentSubmissionCreation' /transaction/payments/{id}/submissions/{submissionId}/tasks/{taskId}: parameters: - description: Payment Id in: path name: id required: true schema: type: string format: uuid - description: Submission Id in: path name: submissionId required: true schema: type: string format: uuid - description: Payment Submission Task Id in: path name: taskId required: true schema: type: string format: uuid patch: operationId: PatchPaymentSubmissionTask responses: 200: description: Payment Submission Task update response content: application/vnd.api+json: schema: $ref: '#/components/schemas/PaymentSubmissionTaskDetailsResponse' application/json: schema: $ref: '#/components/schemas/PaymentSubmissionTaskDetailsResponse' 400: description: Error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 409: description: Conflict content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiErrorWithActualResource' application/json: schema: $ref: '#/components/schemas/ApiErrorWithActualResource' summary: Patch Payment Submission Task tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/PaymentSubmissionTaskAmendment' application/json: schema: $ref: '#/components/schemas/PaymentSubmissionTaskAmendment' /transaction/payments/{paymentId}/returns/{returnId}/admissions/{returnAdmissionId}/tasks/{taskId}: parameters: - description: Payment ID in: path name: paymentId required: true schema: type: string format: uuid - description: Return ID in: path name: returnId required: true schema: type: string format: uuid - description: Return Admission ID in: path name: returnAdmissionId required: true schema: type: string format: uuid - description: Return Admission Task Id in: path name: taskId required: true schema: type: string format: uuid patch: operationId: PatchReturnAdmissionTask responses: 200: description: Return Admission Task update response content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReturnAdmissionTaskDetailsResponse' application/json: schema: $ref: '#/components/schemas/ReturnAdmissionTaskDetailsResponse' 400: description: Error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 409: description: Conflict content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiErrorWithActualResource' application/json: schema: $ref: '#/components/schemas/ApiErrorWithActualResource' summary: Patch Return Admission Task tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReturnAdmissionTaskAmendment' application/json: schema: $ref: '#/components/schemas/ReturnAdmissionTaskAmendment' /transaction/payments/{paymentId}/returns/{returnId}/submissions/{returnSubmissionId}/tasks/{taskId}: parameters: - description: Payment ID in: path name: paymentId required: true schema: type: string format: uuid - description: Return ID in: path name: returnId required: true schema: type: string format: uuid - description: Return Submission ID in: path name: returnSubmissionId required: true schema: type: string format: uuid - description: Return Submission Task Id in: path name: taskId required: true schema: type: string format: uuid patch: operationId: PatchReturnSubmissionTask responses: 200: description: Return Submission Task update response content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReturnSubmissionTaskDetailsResponse' application/json: schema: $ref: '#/components/schemas/ReturnSubmissionTaskDetailsResponse' 400: description: Error content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiError' application/json: schema: $ref: '#/components/schemas/ApiError' 409: description: Conflict content: application/vnd.api+json: schema: $ref: '#/components/schemas/ApiErrorWithActualResource' application/json: schema: $ref: '#/components/schemas/ApiErrorWithActualResource' summary: Patch Return Submission Task tags: - PaymentWrites x-access: - Public requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/ReturnSubmissionTaskAmendment' application/json: schema: $ref: '#/components/schemas/ReturnSubmissionTaskAmendment' components: schemas: Agent: properties: account_number: description: Account number of the financial institution. Can be BBAN or IBAN. example: BBAN type: string account_number_code: $ref: '#/components/schemas/AccountNumberCode' address: example: - 1 Clarence Mew, Horsforth, Leeds UK 4EP items: type: string maxItems: 4 type: array x-omitempty: true identification: properties: bank_id: description: Identification code of the financial institution. example: LOYDGB2L maxLength: 30 type: string bank_id_code: description: Type of identification provided in bank_id field. Required when bank_id is provided, not used otherwise. example: SWBIC maxLength: 5 type: string bank_ids: description: Array for additional ID(s) for agent items: $ref: '#/components/schemas/AccountWithBankId' type: array x-omitempty: true type: object name: description: Name by which the financial institution is known example: Lloyds Bank type: string role: $ref: '#/components/schemas/AgentRole' type: object x-access: - Public AdviceCreation: properties: data: $ref: '#/components/schemas/PaymentAdvice' type: object x-access: - Public RelationshipPaymentAdmissionTask: properties: data: items: $ref: '#/components/schemas/PaymentAdmissionTask' type: array type: object x-access: - Public ReturnAdmissionTaskRelationships: properties: payment: $ref: '#/components/schemas/RelationshipPayments' payment_return: $ref: '#/components/schemas/RelationshipReturns' return_admission: $ref: '#/components/schemas/RelationshipReturnAdmissions' type: object x-access: - Public PaymentCreationResponse: properties: data: $ref: '#/components/schemas/Payment' links: $ref: '#/components/schemas/Links' type: object x-access: - Public RelationshipReversals: properties: data: items: $ref: '#/components/schemas/ReversalPayment' type: array type: object x-access: - Public RecallRelationships: properties: payment: $ref: '#/components/schemas/RelationshipLinks' description: ID of the payment resource related to the recall recall_admission: $ref: '#/components/schemas/RelationshipLinks' description: ID of the recall admission resource related to the recall recall_decisions: $ref: '#/components/schemas/RelationshipLinks' description: ID of the recall decision resource related to the recall recall_reversal: $ref: '#/components/schemas/RelationshipLinks' description: ID of the recall reversal resource related to the recall recall_submission: $ref: '#/components/schemas/RelationshipLinks' description: ID of the recall submission resource related to the recall type: object x-access: - Public NewRecall: properties: attributes: properties: agents: description: Block to represent a Financial Institution/agent in the payment chain items: $ref: '#/components/schemas/Agent' type: array x-omitempty: true parties: description: Block to represent parties involved in the payment chain items: $ref: '#/components/schemas/Party' type: array x-omitempty: true reason: description: Further explanation of the reason given in reason_code. Only evaluated for certain reason codes. example: Payment was a duplicate type: string x-omitempty: true reason_code: description: The reason for the recall. Has to be a valid [recall reason code](http://api-docs.form3.tech/api.html#enumerations-recall-reason-codes). example: DUPL type: string references: description: Block to represent a list of references items: $ref: '#/components/schemas/Reference' type: array x-omitempty: true unique_scheme_id: description: Scheme-specific unique ID example: L5W48NDWYW7JV9MRO71020180301826040011 type: string x-length: 42 x-omitempty: true type: object id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/RecallRelationships' type: description: Name of the resource type example: recalls pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public RelationshipPaymentSubmissions: properties: data: items: $ref: '#/components/schemas/PaymentSubmission' type: array type: object x-access: - Public AdviceSubmissionStatus: enum: - accepted - released_to_gateway - queued_for_delivery - delivery_confirmed - delivery_failed - submitted - validation_pending - validation_passed type: string x-access: - Public ReversalSubmissionCreation: properties: data: $ref: '#/components/schemas/NewReversalSubmission' type: object x-access: - Public PaymentSubmissionTaskDetailsResponse: properties: data: $ref: '#/components/schemas/PaymentSubmissionTask' links: $ref: '#/components/schemas/Links' type: object x-access: - Public RecallDecisionSubmissionAttributes: properties: auto: default: false description: Indicates if the submission was created automatically by the system (`true`) or manually (`false`). type: boolean reference_id: description: Additional payment reference assigned by the scheme type: string status: $ref: '#/components/schemas/RecallDecisionSubmissionStatus' status_reason: description: Reason for submission failure if status is `delivery_failed` example: recall does not exist type: string submission_datetime: description: Date and time of the submission example: '2018-03-12T14:11:48.055Z' format: date-time readOnly: true type: - string - 'null' type: object x-access: - Public PaymentAdmissionTaskRelationships: properties: payment: $ref: '#/components/schemas/RelationshipPayments' payment_admission: $ref: '#/components/schemas/RelationshipPaymentAdmissions' payment_admission_task: $ref: '#/components/schemas/RelationshipPaymentAdmissionTask' type: object x-access: - Public Payment: properties: attributes: $ref: '#/components/schemas/PaymentAttributes' created_on: format: date-time type: - string - 'null' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/PaymentRelationships' signatures: items: $ref: '#/components/schemas/ResourceSignature' maxItems: 1 type: array x-access: - Public x-omitempty: true type: description: Name of the resource type example: payments pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id - attributes type: object x-access: - Public RelationshipLinks: properties: data: items: $ref: '#/components/schemas/RelationshipData' type: array type: object x-access: - Public AgentInstruction: properties: instructions: items: $ref: '#/components/schemas/Instruction' type: array role: $ref: '#/components/schemas/AgentInstructionRole' type: object x-access: - Public PaymentAdmissionStatus: description: '[Status of the admission](https://api-docs.form3.tech/api.html#enumerations-payment-status-codes-admission-status)' enum: - confirmed - failed - pending example: confirmed type: string x-access: - Public RelationshipReturnSubmissions: properties: data: items: $ref: '#/components/schemas/ReturnSubmission' type: array type: object x-access: - Public AgentInstructionRole: enum: - BeneficiaryAgent type: string x-access: - Public Links: properties: first: description: Link to the first resource in the list example: https://api.test.form3.tech/v1/api_name/resource_type type: - string - 'null' last: description: Link to the last resource in the list example: https://api.test.form3.tech/v1/api_name/resource_type type: - string - 'null' next: description: Link to the next resource in the list example: https://api.test.form3.tech/v1/api_name/resource_type type: - string - 'null' prev: description: Link to the previous resource in the list example: https://api.test.form3.tech/v1/api_name/resource_type type: - string - 'null' self: description: Link to this resource type example: https://api.test.form3.tech/v1/api_name/resource_type type: string required: - self type: object x-access: - Public NewReturnSubmission: properties: id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/ReturnSubmissionRelationships' type: description: Name of the resource type example: return_submissions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public ReversalAdmissionTaskAmendment: properties: data: $ref: '#/components/schemas/ReversalAdmissionTaskUpdate' type: object x-access: - Public ReversalAdmissionTaskUpdate: properties: attributes: properties: output: additionalProperties: true description: Key Value map that contains the Task result. example: outcome: passed type: object status: $ref: '#/components/schemas/ReversalAdmissionTaskStatus' type: object id: format: uuid type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string type: enum: - reversal_admission_tasks type: string version: description: Version number example: 0 minimum: 0 type: integer type: object x-access: - Public Recall: properties: attributes: properties: agents: description: Block to represent a Financial Institution/agent in the payment chain items: $ref: '#/components/schemas/Agent' type: array x-omitempty: true parties: description: Block to represent parties involved in the payment chain items: $ref: '#/components/schemas/Party' type: array x-omitempty: true reason: description: Further explanation of the reason given in reason_code. Only evaluated for certain reason codes. example: Payment was a duplicate type: string x-omitempty: true reason_code: description: The reason for the recall. Has to be a valid [recall reason code](http://api-docs.form3.tech/api.html#enumerations-recall-reason-codes). example: DUPL type: string references: description: Block to represent a list of references items: $ref: '#/components/schemas/Reference' type: array x-omitempty: true status: $ref: '#/components/schemas/RecallStatus' unique_scheme_id: description: Scheme-specific unique ID example: L5W48NDWYW7JV9MRO71020180301826040011 type: string x-length: 42 x-omitempty: true type: object created_on: format: date-time type: - string - 'null' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/RecallRelationships' type: description: Name of the resource type example: recalls pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public PaymentSubmissionTaskStatus: description: status of the submission task enum: - completed - failed - pending - on_hold example: completed type: string x-access: - Public Settlement: description: Specifies the details on how the settlement of the transaction between the instructing agent and the instructed agent is completed properties: account_number: example: '12345678' type: - string - 'null' account_number_code: $ref: '#/components/schemas/AccountNumberCode' enum: - IBAN - BBAN type: - string - 'null' x-length: 4 bank_id: type: - string - 'null' bank_id_code: $ref: '#/components/schemas/BankIdCode' enum: - GBDSC type: - string - 'null' method: description: 'Method used to settle the payment instruction. Acceptable Values for SEPA: CLRG. Acceptable Values for SWIFT: INDA (settled by Instructed Agent), INGA (Settled by Instructing Agent), COVE (Cover Payment)' enum: - CLRG - COVE - INGA - INDA example: CLRG type: - string - 'null' type: object x-access: - Public ReceiversCorrespondentAccountHoldingEntity: properties: bank_address: description: Receiver's correspondent's address example: - Liverpool Customer Service Centre - Stevenson Way - Wavertree - L13 1NW items: type: string type: array x-length: 140 x-omitempty: true bank_id: description: SWIFT BIC for receiver's correspondent example: '333333' type: string x-length: 11 bank_id_code: description: The type of identification provided at `bank_id` attribute. Must be ISO code as listed in the [External Code Sets spreadsheet](https://www.iso20022.org/external_code_list.page) type: string x-length: 5 bank_name: description: Receiver's correspondent's name example: XYZ BANK PLC type: string x-length: 35 bank_party_id: description: Receiver's correspondent party identifier example: //AT12345 type: string x-length: 37 type: object x-access: - Public PrivateIdentification: properties: identification: description: Private Identification of an debtor/beneficiary or ultimate debtor/beneficiary example: AB12345 type: string x-availability: get: sepa: sometimes post: sepa: optional x-length: 35 identification_issuer: description: Issuer of the `identification` example: HM Passport Office type: string x-availability: get: sepa: sometimes post: sepa: optional x-length: 35 identification_scheme: description: Scheme of the `identification` example: BANK type: string x-availability: get: sepa: sometimes post: sepa: optional x-length: 35 identification_scheme_code: description: The code that specifies the type of `identification` example: CCPT type: string x-availability: get: sepa: sometimes post: sepa: conditional x-description: sepa: If `identification` is specified, must be either `ARNU`, `CCPT`, `CUST`, `DRLC`, `EMPL`, `NIDN`, `SOSE`, `TXID` or `Other` type: object x-access: - Public RecallSubmissionCreation: properties: data: $ref: '#/components/schemas/NewRecallSubmission' type: object x-access: - Public ReturnSubmission: properties: attributes: properties: auto: default: false description: Indicates if the submission was created automatically by the system (true) or manually (false) type: - boolean - 'null' file_identifier: description: Identification code of the file sent to scheme. example: '123456' pattern: ^[0-9a-zA-Z]+$ type: - string - 'null' file_number: description: Number of the file sent to scheme. example: '001' pattern: ^[0-9]+$ type: - string - 'null' limit_breach_end_datetime: description: Time a payment was released from being held due to a limit breach example: '2018-03-12T14:11:55.055Z' format: date-time readOnly: true type: - string - 'null' limit_breach_start_datetime: description: Start time a payment was held due to a limit breach example: '2018-03-12T14:11:50.055Z' format: date-time readOnly: true type: - string - 'null' posting_status: $ref: '#/components/schemas/PostingStatus' redirected_account_number: description: Details of the account to which funds are redirected (if applicable) example: '12345678' type: string redirected_bank_id: description: Details of the bank to which funds are redirected (if applicable) example: '400300' type: string reference_id: description: Additional payment reference assigned by the scheme type: string route: description: Route taken for a return enum: - on_us - xp type: string scheme_status_code: description: Scheme-specific status (if submission has been submitted to a scheme) example: '0000' type: string scheme_status_code_description: description: '[Description](http://api-docs.form3.tech/api.html#enumerations-scheme-status-codes-for-bacs) of `scheme_status_code`' example: Field 1 (destination sorting code) was invalid type: string settlement_cycle: description: Cycle in which the payment will be settled example: 1 minimum: 0 type: integer settlement_date: description: Date that the payment will be settled example: '2017-07-23' format: date type: - string - 'null' status: $ref: '#/components/schemas/ReturnSubmissionStatus' status_reason: description: Description of the submission status example: Accepted without qualification type: string submission_datetime: description: Time of the submission example: '2018-03-12T14:11:48.055Z' format: date-time readOnly: true type: - string - 'null' transaction_start_datetime: description: Time the request was received by Form3. Used to compute the total transaction time of a payment. example: '2018-03-12T14:11:49.055Z' format: date-time readOnly: true type: - string - 'null' type: object created_on: format: date-time type: - string - 'null' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/ReturnSubmissionRelationships' type: description: Name of the resource type example: return_submissions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public PaymentSubmissionCreationResponse: properties: data: $ref: '#/components/schemas/PaymentSubmissionFetch' links: $ref: '#/components/schemas/Links' type: object x-access: - Public ReturnAdmission: properties: attributes: properties: admission_datetime: description: Date and time the payment admission was created example: '2017-09-28T14:21:46.123+01:00' format: date-time readOnly: true type: - string - 'null' posting_status: $ref: '#/components/schemas/PostingStatus' reference_id: description: Additional payment reference assigned by the scheme type: string route: description: Route taken for a return enum: - on_us - xp type: string scheme_status_code: description: Refer to individual scheme where applicable example: '1001' type: string scheme_status_code_description: description: '[Description](http://api-docs.form3.tech/api.html#enumerations-scheme-status-codes-for-bacs) of `scheme_status_code`' example: Field 1 (destination sorting code) was invalid type: string settlement_cycle: description: Cycle in which the payment will be settled example: 1 minimum: 0 type: integer settlement_date: description: Date on which the payment will be settled example: '2017-01-14' format: date type: - string - 'null' status: $ref: '#/components/schemas/ReturnAdmissionStatus' status_reason: description: Further explanation of the status. [See here](http://api-docs.form3.tech/api.html#enumerations-payment-admission-status-reasons) for possible values. example: Account data invalid type: string unique_scheme_id: description: Scheme-specific unique ID (42 character string) example: '' type: string type: object created_on: format: date-time type: - string - 'null' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/ReturnAdmissionRelationships' type: description: Name of the resource type example: return_admissions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public PaymentAdmissionTaskGroup: description: Identifies the task group the task belongs to example: accounting type: string x-access: - Public AdviceSubmissionRelationships: properties: advice: $ref: '#/components/schemas/RelationshipAdvices' payment: $ref: '#/components/schemas/RelationshipPayments' type: object x-access: - Public PaymentAdmissionStatusReason: description: '[Payment admission status reason](https://api-docs.form3.tech/api.html#enumerations-payment-status-codes-payment-admission-status-reasons)' enum: - accepted - account_closed - account_closed_beneficiary_deceased - account_closed_beneficiary_sensitivities - account_closed_business_reasons - account_closed_currency - account_closed_stopped - account_closed_terms_and_conditions - account_closed_transferred - agent_clearing_process_error - agent_clearing_process_timeout - agent_reason_unknown - agent_suspended - agent_unavailable - amount_exceeds_settlement_limit - amount_invalid_or_missing - amount_not_allowed - bankid_not_provisioned - beneficiary_agent_clearing_process_error - beneficiary_agent_clearing_process_timeout - beneficiary_agent_suspended - beneficiary_agent_unavailable - blocked_account - business_reasons - customer_check_failed - customer_reason_unknown - duplicate_payment - end_to_end_id_missing_or_invalid - incorrect_reference_reference_mask - incorrect_reference_secondary_identification - incorrect_reference_validation_type - invalid_bank_ID - invalid_bank_operation_code - invalid_beneficiary_address - invalid_beneficiary_agent_BIC - invalid_beneficiary_details - invalid_debtor_agent_BIC - invalid_debtor_details - original_payment_not_received - regulatory_reason - scheme_timeout - transaction_forbidden - transaction_type_not_supported - unknown_accountnumber - rejected_by_customer - beneficiary_name_not_present - invalid_beneficiary_account_type example: accepted type: string x-access: - Public PaymentSubmissionTaskAmendment: properties: data: $ref: '#/components/schemas/PaymentSubmissionTaskUpdate' type: object x-access: - Public ReversalSubmissionRelationships: properties: payment: $ref: '#/components/schemas/RelationshipPayments' reversal: $ref: '#/components/schemas/RelationshipReversals' validations: $ref: '#/components/schemas/RelationshipLinks' type: object x-access: - Public PaymentSubmissionTaskAssignee: description: Helps to identify the owner of the task enum: - customer - form3 example: form3 type: string x-access: - Public ReversalAdmissionTaskAssignee: description: Helps to identify the owner of the task enum: - customer - form3 example: form3 type: string x-access: - Public ReversalAdmissionTask: properties: attributes: $ref: '#/components/schemas/ReversalAdmissionTaskAttributes' created_on: example: '2017-09-26T15:26:57.494Z' format: date-time type: string id: format: uuid type: string modified_on: example: '2017-09-26T15:26:57.494Z' format: date-time type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/ReversalAdmissionTaskRelationships' type: description: Name of the resource type example: reversal_admission_tasks pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer type: object x-access: - Public RelationshipPaymentAdmissions: properties: data: items: $ref: '#/components/schemas/PaymentAdmission' type: array type: object x-access: - Public PartyRole: description: Role of the party. Enum of pre-defined values, new values can be added when needed enum: - InitiatingParty - CaseCreator - Originator - Invoicer - Invoicee example: InitiatingParty type: string x-access: - Public AccountHoldingEntity: description: Information about the financial institution servicing the account. properties: bank_address: description: Financial institution address example: - Liverpool Customer Service Centre - Stevenson Way - Wavertree - L13 1NW items: type: string type: array x-omitempty: true bank_id: pattern: ^[A-Z0-9]{0,16}$ type: string bank_id_code: $ref: '#/components/schemas/BankIdCode' enum: - GBDSC example: GBDSC type: string x-length: 5 bank_ids: description: Array for additional ID(s) for agent items: $ref: '#/components/schemas/AccountWithBankId' type: array x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: Array for additional ID(s) for agent x-omitempty: true bank_name: description: Financial institution name example: NATIONAL WESTMINSTER BANK PLC type: string bank_party_id: description: Identifier of the financial institution which services the account example: //AT12345 type: string required: - bank_id - bank_id_code type: object x-access: - Public ReturnSubmissionTaskStatus: description: status of the return submission task enum: - completed - failed - pending - on_hold example: completed type: string x-access: - Public RecallStatus: description: The status of the recall, can either be `pending`, `confirmed`, or `failed`. enum: - pending - confirmed - failed example: confirmed type: string x-access: - Public x-parent: data.attributes RelationshipData: properties: id: description: ID of the referenced resource format: uuid type: string type: description: Name of the referenced resource type type: string type: object x-access: - Public RecallDecisionAttributes: properties: agents: description: Block to represent a Financial Institution/agent in the payment chain items: $ref: '#/components/schemas/Agent' type: array x-omitempty: true answer: $ref: '#/components/schemas/RecallDecisionAnswer' charges_amount: $ref: '#/components/schemas/CurrencyAndAmount' x-omitempty: true reason: description: Optional free text reason in addition to `reason_code` example: Closed account number type: string x-omitempty: true reason_code: description: Reason for a rejected decision. Required when answer is rejected, ignored otherwise. Has to be a valid [rejected recall decision reason code](http://api-docs.form3.tech/api.html#enumerations-rejected-recall-decision-reason-codes) example: AC04 type: string x-omitempty: true recall_amount: $ref: '#/components/schemas/CurrencyAndAmount' x-omitempty: true references: description: Block to represent a list of references items: $ref: '#/components/schemas/Reference' type: array x-omitempty: true resolution_related_information: $ref: '#/components/schemas/ResolutionRelatedInformation' x-omitempty: true scheme_transaction_id: 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. example: '123456789012345678' type: string x-length: 35 x-omitempty: true unique_scheme_id: description: Scheme-specific unique ID example: L5W48NDWYW7JV9MRO71020180301826040011 type: string x-length: 42 x-omitempty: true type: object x-access: - Public PaymentAdmission: properties: attributes: properties: account_validation_outcome: $ref: '#/components/schemas/AccountValidationOutcome' admission_datetime: description: Date and time the payment admission was created example: '2017-09-26T15:26:57.494Z' format: date-time readOnly: true type: - string - 'null' clearing_system: description: Clearing infrastructure through which the payment instruction was processed example: TIPS pattern: ^[0-9A-Za-z_]*$ type: string posting_status: $ref: '#/components/schemas/PostingStatus' reference_id: description: Additional payment reference assigned by the scheme type: string route: description: Route taken for an inbound payment enum: - on_us - xp type: string scheme_received_datetime: description: Date and time the inbound payment was received. Supports RFC3339 Nano example: '2017-09-26T15:26:57.123456789Z' format: date-time pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{1,9}Z$ type: - string - 'null' scheme_status_code: description: Refers to individual scheme where applicable example: '10001' type: string scheme_status_code_description: description: '[Description](http://api-docs.form3.tech/api.html#enumerations-scheme-status-codes-for-bacs) of `scheme_status_code`' example: Field 1 (destination sorting code) was invalid type: string settlement_cycle: description: Cycle in which the payment will be settled example: 1 minimum: 0 type: integer settlement_date: description: Date on which the payment will be settled example: '2017-09-28' format: date type: - string - 'null' status: $ref: '#/components/schemas/PaymentAdmissionStatus' status_reason: $ref: '#/components/schemas/PaymentAdmissionStatusReason' validation_completed_datetime: description: Date and time the inbound payment was successfully validated by Form3. Supports RFC3339 Nano example: '2017-09-26T15:26:57.123456789Z' format: date-time pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{1,9}Z$ type: - string - 'null' type: object created_on: format: date-time type: - string - 'null' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: properties: beneficiary_account: $ref: '#/components/schemas/RelationshipPaymentAdmissionBeneficiaryAccount' beneficiary_branch: $ref: '#/components/schemas/RelationshipPaymentAdmissionBeneficiaryBranch' payment: $ref: '#/components/schemas/RelationshipPayments' payment_admission_task: $ref: '#/components/schemas/RelationshipPaymentAdmissionTasks' type: object type: description: Name of the resource type example: payment_admissions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public PaymentSubmissionFetchRelationships: properties: payment: $ref: '#/components/schemas/RelationshipLinks' payment_submission_task: $ref: '#/components/schemas/RelationshipPaymentSubmissionTasks' validations: $ref: '#/components/schemas/RelationshipLinks' type: object x-access: - Public ReturnPayment: properties: attributes: $ref: '#/components/schemas/ReturnPaymentAttributes' created_on: format: date-time type: - string - 'null' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/ReturnPaymentRelationships' type: description: Name of the resource type example: returns pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public NewReversalSubmission: properties: id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string type: description: Name of the resource type example: reversal_submissions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public RecallCreation: properties: data: $ref: '#/components/schemas/NewRecall' type: object x-access: - Public RecallDecision: properties: attributes: $ref: '#/components/schemas/RecallDecisionAttributes' created_on: format: date-time type: - string - 'null' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/RecallDecisionRelationships' type: description: Name of the resource type example: recall_decisions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public ReversalSubmissionStatus: description: '[Status of the reversal submission](http://draft-api-docs.form3.tech/api.html#enumerations-reversal-submission-status)' enum: - accepted - validation_passed - released_to_gateway - queued_for_delivery - delivery_confirmed - delivery_failed - submitted - validation_pending example: accepted type: string x-access: - Public AgentRole: description: Role of the agent in the payment chain. Enum of pre-defined values, new values can be added when needed enum: - IntermediaryAgent1 - IntermediaryAgent2 - IntermediaryAgent3 - InstructingAgent - InstructedAgent - AdditionalBeneficiaryPartyAgentInformation - CaseCreator example: IntermediaryAgent1 type: string x-access: - Public PaymentSubmission: properties: attributes: properties: clearing_system: description: Clearing infrastructure through which the payment instruction was processed example: TIPS pattern: ^[0-9A-Za-z_]*$ type: string file_identifier: description: Identification code of the file sent to scheme. example: '123456' pattern: ^[0-9a-zA-Z]+$ type: - string - 'null' file_number: description: Number of the file sent to scheme. example: '001' pattern: ^[0-9]+$ type: - string - 'null' limit_breach_end_datetime: description: Time a payment was released from being held due to a limit breach example: '2018-03-12T14:11:55.055Z' format: date-time type: - string - 'null' limit_breach_start_datetime: description: Start time a payment was held due to a limit breach example: '2018-03-12T14:11:50.055Z' format: date-time type: - string - 'null' posting_status: $ref: '#/components/schemas/PostingStatus' redirected_account_number: description: Details of the account to which funds are redirected (if applicable) example: '12345678' type: string redirected_bank_id: description: Details of the bank to which funds are redirected (if applicable) example: '400300' type: string reference_id: description: Additional payment reference assigned by the scheme type: string route: description: Route taken for an outbound payment enum: - on_us - xp type: string scheme_response_received_datetime: description: Date and time the final response to the outbound payment was received. Supports RFC3339 Nano example: '2017-09-26T15:26:57.123456789Z' format: date-time pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{1,9}Z$ type: - string - 'null' scheme_sent_datetime: description: Date and time the outbound payment was sent, or queued for internal throttling. Supports RFC3339 Nano example: '2017-09-26T15:26:57.123456789Z' format: date-time pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{1,9}Z$ type: - string - 'null' scheme_status_code: description: Scheme-specific status (if submission has been submitted to a scheme) example: '0000' type: string scheme_status_code_description: description: '[Description](http://api-docs.form3.tech/api.html#enumerations-scheme-status-codes-for-bacs) of `scheme_status_code`' example: Field 1 (destination sorting code) was invalid type: string settlement_cycle: description: Cycle in which the payment will be settled example: 1 minimum: 0 type: integer settlement_date: description: Date that the payment will be settled example: '2017-07-23' format: date type: - string - 'null' status: $ref: '#/components/schemas/PaymentSubmissionStatus' status_reason: description: Description of the submission status example: Accepted without qualification type: string submission_datetime: description: Date of the submission example: '2018-03-12T14:11:48.055Z' format: date-time readOnly: true type: string transaction_start_datetime: description: Time the request was received by Form3. Used to compute the total transaction time of a payment. example: '2018-03-12T14:11:49.055Z' format: date-time readOnly: true type: string type: object created_on: format: date-time type: - string - 'null' id: format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/PaymentSubmissionRelationships' type: description: Name of the resource type example: payment_submissions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public PaymentSubmissionCreation: properties: data: $ref: '#/components/schemas/NewPaymentSubmission' required: - data type: object x-access: - Public ReturnCreationResponse: properties: data: $ref: '#/components/schemas/ReturnPayment' links: $ref: '#/components/schemas/Links' type: object x-access: - Public PaymentSubmissionTaskRelationships: properties: payment: $ref: '#/components/schemas/RelationshipPayments' payment_submission: $ref: '#/components/schemas/RelationshipPaymentSubmissions' type: object x-access: - Public PostingStatus: description: Displays additional information about the latest response to a transaction, where multiple responses are allowed enum: - rejected - passed_without_posting - posted - blocked - pending - accepted_settlement_complete - received - accepted_funds_checked - accepted_settlement_complete_creditor_account - accepted_settlement_in_process type: string x-access: - Public RecallSubmission: properties: attributes: $ref: '#/components/schemas/RecallSubmissionAttributes' created_on: format: date-time type: - string - 'null' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/RecallSubmissionRelationships' type: description: Name of the resource type example: recall_submissions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public ReturnCreation: properties: data: $ref: '#/components/schemas/ReturnPayment' type: object x-access: - Public AdviceCreationResponse: properties: data: $ref: '#/components/schemas/PaymentAdvice' links: $ref: '#/components/schemas/Links' type: object x-access: - Public RecallSubmissionStatus: description: '[Status](http://draft-api-docs.form3.tech/api.html#enumerations-payment-status-codes-payment-submission-status) of the submission' enum: - accepted - validation_pending - validation_passed - released_to_gateway - delivery_confirmed - delivery_failed - queued_for_delivery - submitted example: accepted type: string x-access: - Public ReversalSubmissionAttributes: properties: file_identifier: description: Identification code of the file sent to scheme. example: '123456' pattern: ^[0-9a-zA-Z]+$ type: - string - 'null' file_number: description: Number of the file sent to scheme. example: '001' pattern: ^[0-9]+$ type: - string - 'null' scheme_status_code: description: Scheme-specific status code, refer to scheme documentation example: E type: string scheme_status_code_description: description: Description of `scheme_status_code` example: Field 1 (destination sorting code) was invalid type: string status: $ref: '#/components/schemas/ReversalSubmissionStatus' status_reason: description: Description of the reversal submission status example: Accepted without qualification type: string submission_datetime: description: Date of the reversal submission example: '2018-05-09T10:49:13.470Z' format: date-time readOnly: true type: string transaction_start_datetime: description: Time the request was received by Form3. Used to compute the total transaction time of a payment. example: '2018-05-09T10:49:13.447Z' format: date-time readOnly: true type: string type: object x-access: - Public PaymentAdmissionBeneficiaryBranch: properties: attributes: properties: user_defined_data: description: All purpose list of key-value pairs specific data stored on the associated beneficiary branch. items: $ref: '#/components/schemas/UserDefinedData' maxItems: 5 type: array type: object id: format: uuid type: string type: description: Name of the resource type example: branches pattern: ^[A-Za-z_]*$ type: string type: object x-access: - Public BeneficiaryDebtorAccountProxy: properties: proxy: description: Name of the identification scheme, in a free text form. When used proxy_id_code must not be present example: ID123456 maxLength: 35 type: - string - 'null' x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: Name of the identification scheme, in a free text form. When used proxy_id_code must not be present x-omitempty: true proxy_id: description: Identification used to indicate the account identification under another specified name example: 07495845323 maxLength: 2048 type: string x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: Identification used to indicate the account identification under another specified name proxy_id_code: description: Name of the identification scheme, in a coded form as published in an external list. When used proxy field must not be present example: MBNO maxLength: 4 type: - string - 'null' x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: Name of the identification scheme, in a coded form as published in an external list. When used proxy field must not be present x-omitempty: true type: object x-access: - Public ReturnSubmissionRelationships: properties: payment: $ref: '#/components/schemas/RelationshipPayments' payment_return: $ref: '#/components/schemas/RelationshipReturns' return_submission_task: $ref: '#/components/schemas/RelationshipReturnSubmissionTasks' validations: $ref: '#/components/schemas/RelationshipLinks' type: object x-access: - Public ReturnAdmissionTaskName: description: Identifies the return admission task to be executed example: return_validation type: string x-access: - Public PaymentAdmissionTaskName: description: Identifies the payment admission task to be executed example: account_check type: string x-access: - Public PaymentSubmissionTaskUpdate: properties: attributes: properties: name: $ref: '#/components/schemas/PaymentSubmissionTaskName' output: additionalProperties: type: object description: Key Value map that contains the Task result. example: outcome: passed type: object status: $ref: '#/components/schemas/PaymentSubmissionTaskStatus' type: object id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string type: enum: - payment_submission_tasks type: string version: description: Version number example: 0 minimum: 0 type: integer type: object x-access: - Public RecallDecisionSubmissionCreation: properties: data: $ref: '#/components/schemas/NewRecallDecisionSubmission' type: object x-access: - Public PaymentAttributes: properties: agent_instructions: description: Block to represent further information related to the processing of payment instructions from one agent to another. items: $ref: '#/components/schemas/AgentInstruction' type: array x-omitempty: true agents: description: Block to represent a Financial Institution/agent in the payment chain items: $ref: '#/components/schemas/Agent' type: array x-omitempty: true amount: description: Amount of money moved between the instructing agent and instructed agent example: '10.00' pattern: ^[0-9]{0,20}(?:\.[0-9]{1,10})?$ type: string batch_booking_indicator: type: string batch_id: type: string batch_type: type: string beneficiary_party: properties: account_name: description: Name of beneficiary as given with account example: James Bond type: string account_number: description: Beneficiary account number example: '71268996' type: string x-length: 34 account_number_code: $ref: '#/components/schemas/AccountNumberCode' account_proxy: $ref: '#/components/schemas/BeneficiaryDebtorAccountProxy' account_type: description: The type of the account given with `beneficiary_party.account_number`. Single digit number. Only required if requested by the beneficiary party. Defaults to 0. example: 0 type: - integer - 'null' x-omitempty: true account_type_code: description: ISO20022 four character account type code, or a proprietary equivalent example: SVGS type: string account_with: $ref: '#/components/schemas/BeneficiaryDebtorAccountHoldingEntity' additional_address_line: description: Additional address line of the beneficiary address type: string x-length: 70 address: description: Beneficiary address example: - 1 Clarence Mew - Horsforth - Leeds Ls18 4EP items: type: string type: array x-omitempty: true birth_city: description: Beneficiary birth city example: PARIS type: string x-length: 35 birth_country: description: Beneficiary birth country, ISO 3166 format country code example: FR type: string x-length: 2 birth_date: description: 'Beneficiary birth date. Formatted according to ISO 8601 format: YYYY-MM-DD' example: '1977-02-28' format: date type: - string - 'null' birth_province: description: Beneficiary birth province example: NORTHSIDE type: string x-length: 35 building_number: description: Building number of the beneficiary address type: string x-length: 16 city: description: City/Town of the Beneficiary address example: BRUSSELS type: string x-length: 30 country: description: Country of the beneficiary address, ISO 3166 format country code example: DE type: string x-length: 2 country_of_residence: description: Country of residence of the beneficiary party, ISO 3166 format country code example: PL type: string x-length: 2 name: description: Beneficiary name example: James Bond type: string x-length: 70 organisation_identification: description: Organisation identification of a beneficiary, used in the case that the beneficiary is an organisation and not a private person example: ID1234656 type: string x-length: 35 organisation_identification_code: description: The code that specifies the type of `organisation_identification` example: BIC type: string x-length: 5 organisation_identification_issuer: description: Issuer of the `organisation_identification` example: NATIONAL WESTMINSTER BANK PLC type: string x-length: 35 organisation_identification_scheme: description: The code that specifies the scheme of `organisation_identification` example: CustomerId type: string x-length: 35 organisation_identifications: description: Array for additional ID(s) of beneficiary organisation items: $ref: '#/components/schemas/BeneficiaryDebtorOrganisationIdentification' type: array x-omitempty: true post_code: description: Post code of the beneficiary address type: string x-length: 16 postal_address: $ref: '#/components/schemas/PostalAddress' description: Beneficiary postal address x-omitempty: true private_identification: $ref: '#/components/schemas/PrivateIdentification' province: description: Province of the beneficiary address type: string x-length: 35 street_name: description: Street name of the beneficiary address example: Park Avenue type: string x-length: 70 telephone_number: description: Beneficiary phone number example: '+447921123987' type: string x-length: 16 type: object category_purpose: description: Category purpose in proprietary form. Specifies the high level purpose of the instruction. Cannot be used at the same time as `category_purpose_coded`. type: string x-length: 35 category_purpose_coded: description: Category purpose in a coded form. Specifies the high level purpose of the instruction. Cannot be used at the same time as `category_purpose`. type: string x-length: 4 charges_information: $ref: '#/components/schemas/ChargesInformation' x-omitempty: true clearing_id: description: Unique identifier for organisations collecting payments type: string x-length: 6 currency: description: Currency of the transaction amount. Currency code as defined in [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm) example: EUR type: string x-length: 3 debtor_party: properties: account_name: description: Name of debtor as given with account example: Jane Bond type: string account_number: description: Debtor account number. Allows upper case and numeric characters. example: '12345678' type: string x-length: 34 account_number_code: $ref: '#/components/schemas/AccountNumberCode' account_proxy: $ref: '#/components/schemas/BeneficiaryDebtorAccountProxy' account_with: $ref: '#/components/schemas/BeneficiaryDebtorAccountHoldingEntity' additional_address_line: description: Additional address line of the Debtor address type: string x-length: 70 address: description: Debtor address example: - 63 St Mary Axe - London - EC3A 8AA items: type: string type: array x-omitempty: true birth_city: description: Debtor birth city example: PARIS type: string x-length: 35 birth_country: description: Debtor birth country. ISO 3166 format country code example: FR type: string x-length: 2 birth_date: description: 'Debtor birth date. Formatted according to ISO 8601 format: YYYY-MM-DD' example: '1973-01-31' format: date type: - string - 'null' birth_province: description: Debtor birth province example: SOUTH SIDE type: string x-length: 35 building_number: description: Building number of the Debtor address type: string x-length: 16 city: description: City/Town of the Debtor address example: BRUSSELS type: string x-length: 30 country: description: Country of debtor address. ISO 3166 format country code" example: GB type: string x-length: 2 country_of_residence: description: Country of residence of the debtor party, ISO 3166 format country code example: IT type: string x-length: 2 customer_id: description: SWIFT BIC for ordering customer, either BIC8 or BIC11 example: BARCGB22 type: string x-length: 11 customer_id_code: description: Code for `customer_id` example: SWBIC type: string x-length: 5 name: description: Debtor name example: Norman Smith type: string x-length: 70 organisation_identification: description: Organisation identification of a debtor, in the case that the debtor is an organisation and not a private person example: ID1234656 type: string x-length: 35 organisation_identification_code: description: The code that specifies the type of `organisation_identification` example: BIC type: string x-length: 5 organisation_identification_issuer: description: Issuer of the `organisation_identification` example: NATIONAL WESTMINSTER BANK PLC type: string x-length: 35 organisation_identification_scheme: description: The code that specifies the scheme of `organisation_identification` example: CustomerId type: string x-length: 35 organisation_identifications: description: Array for additional ID(s) of debtor organisation items: $ref: '#/components/schemas/BeneficiaryDebtorOrganisationIdentification' type: array x-omitempty: true post_code: description: Post code of the Debtor address type: string x-length: 16 postal_address: $ref: '#/components/schemas/PostalAddress' description: Debtor postal address x-omitempty: true private_identification: $ref: '#/components/schemas/PrivateIdentification' province: description: Province of the Debtor address type: string x-length: 35 street_name: description: Street name of the Debtor address example: Park Avenue type: string x-length: 70 type: object end_to_end_reference: description: Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. example: 'PAYMENT REF: 20094' type: string x-length: 35 file_number: type: string fx: properties: contract_reference: description: Reference to the foreign exchange contract associated with the transaction example: FXCONTRACT/REF/123567 type: string x-length: 35 exchange_rate: description: 'Factor used to convert an amount from the instructed currency into the transaction currency: i.e. to convert the `fx.original_amount`, expressed in the `fx.original_currency`, to `amount` specified in `currency`. Decimal value, represented as a string, maximum length 12. Must be > 0.' example: '0.13343' type: string original_amount: description: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as instructed by the initiating party. Decimal value. Must be > 0. example: '100.00' type: string original_currency: description: Currency of `original_amount`. Currency code as defined in ISO 4217. example: EUR type: string x-length: 3 type: object instruction_id: description: Unique identification, as assigned by the initiating party to unambiguously identify the transaction. This identification is an point-to-point reference and is passed on, unchanged, throughout the entire chain. Cannot include leading, trailing or internal spaces. example: ID1245799 type: string x-length: 35 intermediary_bank: $ref: '#/components/schemas/IntermediaryBankAccountHoldingEntity' numeric_reference: description: Numeric reference field, see scheme specific descriptions for usage type: string x-length: 4 parties: description: Block to represent parties involved in the payment instruction items: $ref: '#/components/schemas/Party' type: array x-omitempty: true payment_acceptance_datetime: description: 'Timestamp of when the payment instruction meets the set processing conditions. Format: YYYY-MM-DDThh:mm:ss:mmm+hh:mm' example: '2017-09-30T12:36:02.123Z' format: date-time type: - string - 'null' payment_purpose: description: Purpose of the payment in a proprietary form example: X type: string x-length: 35 payment_purpose_coded: description: Purpose of the payment in a coded form type: string x-length: 4 payment_scheme: description: Clearing infrastructure through which the payment instruction is to be processed. Default for given organisation ID is used if left empty. Has to be a valid [scheme identifier](http://draft-api-docs.form3.tech/api.html#enumerations-schemes). example: FPS pattern: ^[A-Za-z_]*$ type: string payment_type: type: string processing_date: description: 'Date on which the payment is to be debited from the debtor account. Formatted according to ISO 8601 format: YYYY-MM-DD.' example: '2015-02-12' format: date type: - string - 'null' receivers_correspondent: $ref: '#/components/schemas/ReceiversCorrespondentAccountHoldingEntity' reference: description: Payment reference for beneficiary use example: rent for oct type: string x-length: 18 references: description: Block to represent a list of references items: $ref: '#/components/schemas/Reference' type: array x-omitempty: true regulatory_reporting: description: Regulatory reporting information example: May be required for some foreign originated payments type: string x-length: 105 reimbursement: $ref: '#/components/schemas/ReimbursementAccountHoldingEntity' related_remittance_information: description: Information relating to the handling of the remittance information by any of the agents in the transaction processing chain. items: properties: remittance_id: type: string x-length: 35 remittance_location_details: description: Information on the location and/or delivery of the remittance information. items: properties: electronic_address: description: Electronic address to which an agent is to send the remittance information. If location_coded is EMAL, this contains an email address. If location_coded is URID, this contains a URI. example: first.name@example.com type: string x-length: 2048 location_coded: description: Method used to deliver the remittance advice information. enum: - EMAL - EDIC - FAXI - POST - SMSM - URID type: string required: - location_coded type: object type: array type: object type: array x-omitempty: true remittance_information: description: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts receivable system provided by the debtor for the beneficiary. example: Additional remittance information over and above reference information type: string x-length: 140 scheme_payment_sub_type: description: The scheme specific payment [sub type](http://api-docs.form3.tech/api.html#enumerations-scheme-specific-payment-sub-types) example: TelephoneBanking type: string scheme_payment_type: description: The [scheme-specific payment type](#enumerations-scheme-payment-types) example: ImmediatePayment type: string scheme_processing_date: description: Date on which the payment is processed by the scheme. Only used if different from `processing_date`. example: '2015-02-12' format: date type: - string - 'null' scheme_transaction_id: 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. example: '123456789012345678' type: string x-length: 35 senders_correspondent: $ref: '#/components/schemas/SendersCorrespondentAccountHoldingEntity' settlement: $ref: '#/components/schemas/Settlement' structured_reference: properties: issuer: description: Issuer of remittance reference type: string x-length: 35 reference: description: Unique reference to unambiguously refer to the payment originated by the creditor, this reference enables reconciliation by the creditor upon receipt of the amount of money. type: string x-length: 35 type: object structured_remittance_information: description: Information supplied to enable the matching / reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivables system, in a structured form. items: properties: parties: items: properties: organisation_identifications: description: Additional information such as the Biller / Merchant Identification in certain Bill Pay use cases. items: properties: identification: description: Unique and unambigious identification of a party. type: string x-length: 35 identification_code: description: Name of the identification scheme, in a coded form as published in an external list. type: string x-length: 5 identification_issuer: description: Entity that assigns the identification. type: string x-length: 35 identification_scheme: description: Name of the identification scheme, in a free text form. type: string x-length: 35 type: object type: array role: $ref: '#/components/schemas/PartyRole' description: The type of party. type: object type: array referred_document_amounts: items: properties: amount: description: Amount of money. example: '200.00' pattern: ^[0-9]{0,20}(?:\.[0-9]{1,10})?$ type: string amount_type: description: The code relating to any discount that can be applied to an invoice. type: string x-length: 35 amount_type_coded: type: string x-length: 35 currency: description: ISO currency code for transaction amount example: GBP type: string type: enum: - DiscountAppliedAmount - DuePayableAmount - CreditNoteAmount - TaxAmount - AdjustmentAmount - RemittanceAmount type: string required: - type type: object type: array referred_document_information: description: The identification and the content of the referred document. Multiple occurrences are used when a credit transfer is used to return funds associated with a previously completed credit transfer. items: properties: document_date: description: Date associated with the referred document, e.g. the date of the original Credit Transfer (pacs.008) message that is being returned. This is required when the type is RTRN. example: '1982-07-01' format: date type: - string - 'null' document_id: description: Unique and unambiguous identification of the referred document. type: string x-length: 35 document_type: description: Proprietary identification of the type of the remittance document. Used to carry the additional information related to the payment. type: string x-length: 35 document_type_coded: description: 'Document type in a coded form. Used to carry the additional information related to the payment. Only one of document_type_coded or document_type can be provided. ' enum: - CINV - AROI - BOLD - CMCN - CREN - CNFA - DEBN - DNFA - DISP - HIRI - MSIN - PUOR - SBIN - SOAC - TSUT - VCHR type: string type: object type: array type: object type: array x-omitempty: true swift: properties: bank_operation_code: description: SWIFT service level example: CRED type: string x-length: 4 header: properties: destination: description: Destination SWIFT logical terminal address. Complete 12-character SWIFT destination, including BIC (x8), logical terminal code (x1) and branch code (x). example: MIDLGB22XABC type: string x-length: 12 message_type: description: The message type of the SWIFT payment, has to match `[A-Z]{2}[0-9]{3}`. Currently `MT103` is the only supported value example: MT103 type: string x-length: 5 priority: description: SWIFT priority. Either `Normal` or `Priority`. example: Priority type: string x-length: 8 recipient: description: The destination SWIFT BIC for SWIFT MT messages being sent by Form3 client to SWIFT. Formatted as BIC8 or BIC11. type: string x-length: 8 source: description: The source SWIFT BIC for SWIFT MT messages being received by Form3 client from SWIFT. Formatted as BIC8 or BIC11. type: string x-length: 8 user_reference: description: Message User Reference (MUR) value, which can be up to 16 characters, and will be returned in the ACK type: string x-length: 16 type: object instruction_code: description: A SWIFT instruction code example: INTC type: string x-length: 35 sender_receiver_information: description: This field specifies additional information for the Receiver or other party specified. example: /INS/ABNANL2A type: string x-length: 210 time_indication: description: This repetitive field specifies one or several time indication(s) related to the processing of the payment instruction. example: /CLSTIME/0915+0200 type: string type: object ultimate_beneficiary: $ref: '#/components/schemas/UltimateEntity' ultimate_debtor: $ref: '#/components/schemas/UltimateEntity' unique_scheme_id: description: The scheme-specific unique transaction ID. Populated by the scheme. example: L5W48NDWYW7JV9MRO71020180301826040011 type: string x-length: 42 user_defined_data: description: All purpose list of key-value pairs specific data stored on the payment. items: $ref: '#/components/schemas/UserDefinedData' maxItems: 10 type: array x-omitempty: true type: object x-access: - Public RelationshipReversalAdmissions: properties: data: items: $ref: '#/components/schemas/ReversalAdmission' type: array type: object x-access: - Public RelationshipRecallDecisions: properties: data: items: $ref: '#/components/schemas/RecallDecision' type: array type: object x-access: - Public CurrencyAndAmount: properties: amount: example: '10.00' pattern: ^[0-9]{0,20}(?:\.[0-9]{1,10})?$ type: string currency: description: ISO currency code for `amount` type: string type: object x-access: - Public AdviceSubmissionAttributes: properties: status: $ref: '#/components/schemas/AdviceSubmissionStatus' status_reason: type: string submission_datetime: format: date-time readOnly: true type: string transaction_start_datetime: format: date-time readOnly: true type: string type: object x-access: - Public NewAdviceSubmission: properties: id: format: uuid type: string organisation_id: format: uuid type: string type: pattern: ^[A-Za-z_]*$ type: string version: minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public PaymentAdmissionTaskUpdate: properties: attributes: properties: output: additionalProperties: true description: Key Value map that contains the Task result. example: outcome: passed type: object status: $ref: '#/components/schemas/PaymentAdmissionTaskStatus' type: object id: format: uuid type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string type: enum: - payment_admission_tasks type: string version: description: Version number example: 0 minimum: 0 type: integer type: object x-access: - Public AdviceSubmissionCreationResponse: properties: data: $ref: '#/components/schemas/AdviceSubmission' links: $ref: '#/components/schemas/Links' type: object x-access: - Public AccountValidationOutcome: description: Outcome of the validation of the beneficiary's account number, which is sometimes performed on a customer's behalf enum: - passed - failed - failed_auto_reject_disabled - failed_auto_reject_enabled type: string x-access: - Public RelationshipPaymentAdmissionTasks: properties: data: items: $ref: '#/components/schemas/PaymentAdmissionTask' type: array type: object x-access: - Public ClearingChannel: description: Answer to the recall request. Can either be `MPNS`, `RTGS` or `RTNS`. enum: - MPNS - RTGS - RTNS example: MPNS type: string x-access: - Public PaymentSubmissionStatus: description: '[Status of the submission](https://api-docs.form3.tech/api.html#enumerations-payment-status-codes-submission-status)' enum: - accepted - limit_check_pending - limit_check_failed - limit_check_passed - released_to_gateway - queued_for_delivery - delivery_confirmed - delivery_failed - submitted - validation_pending - rejected_by_customer example: delivery_confirmed type: string x-access: - Public ReturnAdmissionBeneficiaryBranch: properties: attributes: properties: user_defined_data: description: All purpose list of key-value pairs specific data stored on the associated beneficiary branch items: $ref: '#/components/schemas/UserDefinedData' maxItems: 5 type: array type: object id: format: uuid type: string type: description: Name of the resource type example: branches pattern: ^[A-Za-z_]*$ type: string type: object x-access: - Public ReturnSubmissionTaskAssignee: description: Helps to identify the owner of the task enum: - customer - form3 example: form3 type: string x-access: - Public ReturnPaymentRelationships: properties: forwarding_payment: properties: data: description: Array of Outbound Payments created to forward the payment. items: $ref: '#/components/schemas/RelationshipData' type: array type: object payment: $ref: '#/components/schemas/RelationshipPayments' description: ID of the payment resource related to the return return_admission: properties: data: description: Array of Return Admission resources related to the return items: $ref: '#/components/schemas/ReturnAdmission' type: array type: object return_reversal: $ref: '#/components/schemas/RelationshipLinks' description: ID of the return reversal resource related to the return return_submission: properties: data: description: Array of Return Submission resources related to the return items: $ref: '#/components/schemas/ReturnSubmission' type: array type: object type: object x-access: - Public PaymentCreation: properties: data: $ref: '#/components/schemas/NewPayment' required: - data type: object x-access: - Public RelationshipReturnAdmissions: properties: data: items: $ref: '#/components/schemas/ReturnAdmission' type: array type: object x-access: - Public RecallCreationResponse: properties: data: $ref: '#/components/schemas/Recall' links: $ref: '#/components/schemas/Links' type: object x-access: - Public PostalAddress: properties: address: description: Beneficiary address example: - 1 Clarence Mew - Horsforth - Leeds Ls18 4EP items: type: string type: array x-omitempty: true building_name: description: Building name of the postal address type: string x-length: 35 building_number: description: Building number of the postal address type: string x-length: 16 country: description: Country of the postal address, ISO 3166 format country code example: SK type: string x-length: 2 country_sub_division: description: Country sub division of the postal address type: string x-length: 35 department: description: Department of the postal address type: string x-length: 70 district_name: description: District name of the postal address type: string x-length: 35 floor: description: Floor of the postal address type: string x-length: 70 post_box: description: Postbox of the postal address type: string x-length: 16 post_code: description: Post code of the postal address type: string x-length: 16 room: description: Room of the postal address type: string x-length: 70 street_name: description: Street name of the postal address example: Park Avenue type: string x-length: 70 sub_department: description: Sub department of the postal address type: string x-length: 70 town_location_name: description: Town location name of the postal address type: string x-length: 35 town_name: description: Town name of the postal address example: BRUSSELS type: string x-length: 30 type: object x-access: - Public AccountNumberCode: description: The type of identification given at `account_number` attribute enum: - BBAN - IBAN example: IBAN maxLength: 4 type: string x-access: - Public RecallDecisionRelationships: properties: decision_admission: $ref: '#/components/schemas/RelationshipLinks' description: ID of the recall decision admission resource related to the recall decision decision_submission: $ref: '#/components/schemas/RelationshipLinks' description: ID of the recall decision submission resource related to the recall decision payment: $ref: '#/components/schemas/RelationshipLinks' description: ID of the payment resource related to the recall decision recall: $ref: '#/components/schemas/RelationshipLinks' description: ID of the recall resource related to the recall decision type: object x-access: - Public PaymentRelationships: properties: beneficiary: properties: data: description: Array of beneficiary resources related to the payment items: $ref: '#/components/schemas/RelationshipData' type: array type: object beneficiary_account: properties: data: description: Array of beneficiary account resources related to the payment items: $ref: '#/components/schemas/RelationshipData' type: array type: object debtor: properties: data: description: Array of debtor resources related to the payment items: $ref: '#/components/schemas/RelationshipData' type: array type: object debtor_account: properties: data: description: Array of debtor account resources related to the payment items: $ref: '#/components/schemas/RelationshipData' type: array type: object forwarded_payment: properties: data: description: ' Array of Inbound Payments that triggered the creation of this Forwarding Payment.' items: $ref: '#/components/schemas/RelationshipData' type: array type: object forwarded_return: properties: data: description: Array of Payment Return resources related to the payment items: $ref: '#/components/schemas/RelationshipData' type: array type: object forwarding_payment: properties: data: description: Array of Outbound Payments created to forward the payment. items: $ref: '#/components/schemas/RelationshipData' type: array type: object fx_deal: properties: data: description: Array of FXDeal resources related to the payment items: $ref: '#/components/schemas/RelationshipData' type: array type: object payment_admission: properties: data: description: Array of Payment Admission resources related to the payment items: $ref: '#/components/schemas/PaymentAdmission' type: array type: object payment_advice: properties: data: description: Array of Payment Advice resources related to the payment items: $ref: '#/components/schemas/PaymentAdvice' type: array type: object payment_recall: properties: data: description: Array of Payment Recall resources related to the payment items: $ref: '#/components/schemas/Recall' type: array type: object payment_return: properties: data: description: Array of Payment Return resources related to the payment items: $ref: '#/components/schemas/ReturnPayment' type: array type: object payment_reversal: properties: data: description: Array of Payment Reversal resources related to the payment items: $ref: '#/components/schemas/ReversalPayment' type: array type: object payment_submission: properties: data: description: Array of Payment Submission resources related to the payment items: $ref: '#/components/schemas/PaymentSubmission' type: array type: object type: object x-access: - Public ReturnAdmissionRelationships: properties: beneficiary_account: $ref: '#/components/schemas/RelationshipReturnAdmissionBeneficiaryAccount' beneficiary_branch: $ref: '#/components/schemas/RelationshipReturnAdmissionBeneficiaryBranch' payment: $ref: '#/components/schemas/RelationshipPayments' payment_return: $ref: '#/components/schemas/RelationshipReturns' return_admission_task: $ref: '#/components/schemas/RelationshipReturnAdmissionTasks' validations: $ref: '#/components/schemas/RelationshipLinks' type: object x-access: - Public ReturnSubmissionCreationResponse: properties: data: $ref: '#/components/schemas/ReturnSubmission' links: $ref: '#/components/schemas/Links' type: object x-access: - Public ReturnReversalCreationResponse: properties: data: $ref: '#/components/schemas/ReturnReversal' links: $ref: '#/components/schemas/Links' type: object x-access: - Public BeneficiaryDebtorOrganisationIdentification: properties: identification: description: Another ID of the organisation example: H7FNTJ4851HG0EXQ1Z70 type: string x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: Another ID of the organisation x-length: 35 x-omitempty: true identification_code: description: Code for the type of other ID of organisation example: LEI type: string x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: Code for the type of other ID of organisation x-length: 5 x-omitempty: true identification_issuer: description: Issuer of the other ID of organisation example: London Stock Exchange type: string x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: Issuer of the other ID of organisation x-length: 35 x-omitempty: true identification_scheme: description: Custom internal code for the type of other ID of organisation example: Custom code type: string x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: Custom internal code for the type of other ID of organisation x-length: 35 x-omitempty: true type: object x-access: - Public RelationshipPayments: properties: data: items: $ref: '#/components/schemas/Payment' type: array type: object x-access: - Public PaymentAdmissionTaskStatus: description: status of the task enum: - completed - failed - pending - on_hold example: completed type: string x-access: - Public RecallDecisionSubmissionRelationships: properties: payment: $ref: '#/components/schemas/RelationshipPayments' recall: $ref: '#/components/schemas/RelationshipRecalls' recall_decision: $ref: '#/components/schemas/RelationshipRecallDecisions' type: object x-access: - Public ReversalAdmissionTaskStatus: description: status of the task enum: - completed - failed - pending - on_hold example: completed type: string x-access: - Public Instruction: properties: code: example: PHOB maxLength: 4 type: string information: example: Phone Beneficiary maxLength: 140 type: string type: object x-access: - Public Reference: description: Payment reference. Defined by a pair of reference type and reference value properties: type: description: Name of the reference type example: UETR maxLength: 45 minLength: 1 type: string value: description: Value of the provided reference type maxLength: 45 minLength: 1 type: string required: - type - value type: object x-access: - Public PaymentSubmissionTaskGroup: description: Identifies the task group the task belongs to example: accounting type: string x-access: - Public RelationshipReturns: properties: data: items: $ref: '#/components/schemas/ReturnPayment' type: array type: object x-access: - Public ReturnPaymentAttributes: properties: agents: description: Block to represent a Financial Institution/agent in the payment chain items: $ref: '#/components/schemas/Agent' type: array x-omitempty: true amount: description: The amount to return which should correspond to the amount of the original payment example: '200.00' pattern: ^[0-9]{0,20}(?:\.[0-9]{1,10})?$ type: string x-description-bacs: This is a Bacs description x-description-fps: This is an FPS description x-description-sepa: This is a SEPA Instant description x-description-swift: This is a SWIFT description x-length: 20 clearing_id: description: Unique identifier for organisations collecting payments type: string x-length: 6 currency: description: ISO currency code for transaction amount example: GBP type: string end_to_end_reference: description: Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. example: 'PAYMENT REF: 20094' type: string x-length: 35 instruction_id: description: Unique identification, as assigned by the initiating party to unambiguously identify the transaction. This identification is an point-to-point reference and is passed on, unchanged, throughout the entire chain. Cannot include leading, trailing or internal spaces. example: ID1245799 type: string x-length: 35 limit_breach_end_datetime: description: Time a payment was released from being held due to a limit breach example: '2018-03-12T14:11:55.055Z' format: date-time readOnly: true type: - string - 'null' limit_breach_start_datetime: description: Start time a payment was held due to a limit breach example: '2018-03-12T14:11:50.055Z' format: date-time readOnly: true type: - string - 'null' reason: type: - string - 'null' return_code: description: The return [reason code](http://draft-api-docs.form3.tech/api.html#enumerations-payment-return-codes) example: '00000002' type: string scheme_transaction_id: description: A unique reference to the return payment instruction. If not supplied, the value is generated by Form3. example: e368ab2d type: string settlement: $ref: '#/components/schemas/Settlement' unique_scheme_id: description: The scheme-specific unique transaction ID. Populated by the scheme. example: L5W48NDWYW7JV9MRO71020180301826040011 type: string x-length: 42 x-omitempty: true user_defined_data: description: All purpose list of key-value pairs specific data stored on the return. items: $ref: '#/components/schemas/UserDefinedData' maxItems: 10 type: array x-omitempty: true type: object x-access: - Public NewRecallSubmission: properties: attributes: type: object id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/RecallSubmissionRelationships' type: description: Name of the resource type example: recall_submissions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public RelationshipReturnAdmissionTasks: properties: data: items: $ref: '#/components/schemas/ReturnAdmissionTask' type: array type: object x-access: - Public ReturnAdmissionTaskAssignee: description: Helps to identify the owner of the task enum: - customer - form3 example: form3 type: string x-access: - Public ReversalCreation: properties: data: $ref: '#/components/schemas/ReversalPayment' type: object x-access: - Public NewPaymentSubmission: properties: id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: properties: validations: $ref: '#/components/schemas/RelationshipLinks' type: object type: description: Name of the resource type example: payment_submissions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public AccountWithBankId: properties: bank_id: description: Other ID of agent example: H7FNTJ4851HG0EXQ1Z70 maxLength: 30 type: string x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: Other ID of agent x-length: 11 x-omitempty: true bank_id_code: description: Code for the type of other ID for agent example: LEI maxLength: 5 type: string x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: Code for the type of other ID for agent x-length: 5 x-omitempty: true type: object x-access: - Public PaymentAdmissionTask: properties: attributes: properties: assignee: $ref: '#/components/schemas/PaymentAdmissionTaskAssignee' group: $ref: '#/components/schemas/PaymentAdmissionTaskGroup' input: additionalProperties: type: object description: Key Value map that contains additional data for executing the task. example: status_reason: blocked type: object name: $ref: '#/components/schemas/PaymentAdmissionTaskName' output: additionalProperties: type: object description: Key Value map that contains the Task result. example: outcome: passed type: object status: $ref: '#/components/schemas/PaymentAdmissionTaskStatus' workflow: description: Identifies the workflow for which the task was created example: c9ae9332-22c3-485d-a9bb-bf0b63bef53a format: uuid type: string type: object created_on: example: '2017-09-26T15:26:57.494Z' format: date-time type: string id: format: uuid type: string modified_on: example: '2017-09-26T15:26:57.494Z' format: date-time type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/PaymentAdmissionTaskRelationships' type: description: Name of the resource type example: payment_admission_tasks pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer type: object x-access: - Public AdviceSubmission: properties: attributes: $ref: '#/components/schemas/AdviceSubmissionAttributes' created_on: format: date-time type: - string - 'null' id: format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: format: uuid type: string relationships: $ref: '#/components/schemas/AdviceSubmissionRelationships' type: pattern: ^[A-Za-z_]*$ type: string version: minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public ReversalAdmissionStatus: description: '[Status](http://draft-api-docs.form3.tech/api.html#enumerations-payment-admission-status) of the reversal admission' enum: - pending - confirmed example: confirmed type: string x-access: - Public RecallDecisionSubmissionCreationResponse: properties: data: $ref: '#/components/schemas/RecallDecisionSubmission' links: $ref: '#/components/schemas/Links' type: object x-access: - Public ReturnAdmissionTaskStatus: description: status of the return admission task enum: - completed - failed - pending - on_hold example: completed type: string x-access: - Public RelationshipPaymentAdmissionBeneficiaryBranch: properties: data: items: $ref: '#/components/schemas/PaymentAdmissionBeneficiaryBranch' type: array type: object x-access: - Public RecallDecisionSubmissionStatus: description: '[Status](http://draft-api-docs.form3.tech/api.html#enumerations-payment-status-codes-payment-submission-status) of the submission' enum: - accepted - limit_check_pending - limit_check_failed - limit_check_passed - released_to_gateway - queued_for_delivery - delivery_confirmed - delivery_failed - validation_pending - validation_passed example: accepted type: string x-access: - Public RecallSubmissionRelationships: properties: payment: $ref: '#/components/schemas/RelationshipPayments' recall: $ref: '#/components/schemas/RelationshipRecalls' type: object x-access: - Public RelationshipRecalls: properties: data: items: $ref: '#/components/schemas/Recall' type: array type: object x-access: - Public ApiErrorWithActualResource: properties: actual_resource: type: object error_code: format: uuid type: string error_message: type: string type: object x-access: - Public ReturnAdmissionStatus: description: '[Status](http://draft-api-docs.form3.tech/api.html#enumerations-payment-admission-status) of the return admission' enum: - confirmed - failed - pending example: confirmed type: string x-access: - Public ReturnAdmissionTaskAmendment: properties: data: $ref: '#/components/schemas/ReturnAdmissionTaskUpdate' type: object x-access: - Public PaymentAdmissionBeneficiaryAccount: properties: attributes: properties: user_defined_data: description: All purpose list of key-value pairs specific data stored on the associated beneficiary account. items: $ref: '#/components/schemas/UserDefinedData' maxItems: 5 type: array type: object id: format: uuid type: string type: description: Name of the resource type example: accounts pattern: ^[A-Za-z_]*$ type: string type: object x-access: - Public RelationshipAdvices: properties: data: items: $ref: '#/components/schemas/PaymentAdvice' type: array type: object x-access: - Public ReimbursementAccountHoldingEntity: properties: bank_address: description: Third party reimbursement institution address example: - Liverpool Customer Service Centre - Stevenson Way - Wavertree - L13 1NW items: type: string type: array x-omitempty: true bank_id: description: Identification of third party reimbursement institution example: '333333' type: string x-length: 11 bank_id_code: description: The type of identification provided at `bank_id` attribute. Must be ISO code as listed in the [External Code Sets spreadsheet](https://www.iso20022.org/external_code_list.page) type: string x-length: 5 bank_name: description: Third party reimbursement institution name example: NATIONAL WESTMINSTER BANK PLC type: string x-length: 35 bank_party_id: description: Third party reimbursement institution identifier example: //AT12345 type: string x-length: 37 type: object x-access: - Public ResolutionRelatedInformation: properties: clearing_channel: $ref: '#/components/schemas/ClearingChannel' x-omitempty: true references: description: Block to represent a list of references items: $ref: '#/components/schemas/Reference' maxItems: 5 type: array x-omitempty: true settlement_date: description: Date that the payment will be settled example: '2017-07-23' format: date type: - string - 'null' type: object x-access: - Public RecallDecisionCreationResponse: properties: data: $ref: '#/components/schemas/RecallDecision' type: object x-access: - Public PaymentAdvice: properties: attributes: properties: beneficiary_party: properties: new_bank_details: properties: account_number: type: string account_number_code: $ref: '#/components/schemas/AccountNumberCode' account_with: $ref: '#/components/schemas/AccountHoldingEntity' roll_number: type: string type: object type: object reason_code: type: string type: object created_on: format: date-time type: - string - 'null' id: format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: format: uuid type: string relationships: properties: advice_submission: $ref: '#/components/schemas/RelationshipLinks' payment: $ref: '#/components/schemas/RelationshipLinks' type: object type: pattern: ^[A-Za-z_]*$ type: string version: minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public ReturnReversal: properties: attributes: type: object created_on: format: date-time type: - string - 'null' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: properties: payment: $ref: '#/components/schemas/RelationshipLinks' description: ID of the payment resource related to the return reversal payment_return: $ref: '#/components/schemas/RelationshipLinks' description: ID of the payment return resource related to the return reversal return_reversal_admission: $ref: '#/components/schemas/RelationshipLinks' description: ID of the return reversal admission resource related to the return reversal type: object type: description: Name of the resource type example: return_reversals pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public ReturnAdmissionTaskGroup: description: Identifies the task group the task belongs to example: accounting type: string x-access: - Public PaymentSubmissionTaskName: description: Identifies the payment submission task to be executed example: account_validation type: string x-access: - Public ReversalAdmission: properties: attributes: properties: scheme_status_code: description: Scheme-specific status code. Refer to scheme documentation where available. example: '0' type: string scheme_status_code_description: description: Description of `scheme_status_code` example: Field 1 (destination sorting code) was invalid type: string source_gateway: type: string status: $ref: '#/components/schemas/ReversalAdmissionStatus' type: object created_on: format: date-time type: - string - 'null' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: properties: payment: $ref: '#/components/schemas/RelationshipPayments' reversal: $ref: '#/components/schemas/RelationshipReversals' reversal_admission_task: $ref: '#/components/schemas/RelationshipReversalAdmissionTasks' type: object type: description: Name of the resource type example: reversal_admissions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public ReturnSubmissionCreation: properties: data: $ref: '#/components/schemas/NewReturnSubmission' type: object x-access: - Public ReversalSubmission: properties: attributes: $ref: '#/components/schemas/ReversalSubmissionAttributes' created_on: format: date-time type: - string - 'null' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/ReversalSubmissionRelationships' type: description: Name of the resource type example: reversal_submissions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public PaymentAdmissionTaskAssignee: description: Helps to identify the owner of the task enum: - customer - form3 example: form3 type: string x-access: - Public RelationshipReturnAdmissionBeneficiaryBranch: properties: data: items: $ref: '#/components/schemas/ReturnAdmissionBeneficiaryBranch' type: array type: object x-access: - Public SendersCorrespondentAccountHoldingEntity: properties: bank_address: description: Sender's correspondent's address example: - Liverpool Customer Service Centre - Stevenson Way - Wavertree - L13 1NW items: type: string type: array x-omitempty: true bank_id: description: SWIFT BIC for sender's correspondent example: '333333' type: string x-length: 11 bank_id_code: description: The type of identification provided at `bank_id` attribute. Must be ISO code as listed in the [External Code Sets spreadsheet](https://www.iso20022.org/external_code_list.page) type: string x-length: 5 bank_name: description: Sender's correspondent's name example: XYZ BANK PLC type: string x-length: 35 bank_party_id: description: Identifier of the financial institution which services the account example: //AT12345 type: string x-length: 37 type: object x-access: - Public ReturnSubmissionTaskRelationships: properties: payment: $ref: '#/components/schemas/RelationshipPayments' payment_return: $ref: '#/components/schemas/RelationshipReturns' return_submission: $ref: '#/components/schemas/RelationshipReturnSubmissions' type: object x-access: - Public PaymentAdmissionTaskAmendment: properties: data: $ref: '#/components/schemas/PaymentAdmissionTaskUpdate' type: object x-access: - Public ReturnSubmissionTaskDetailsResponse: properties: data: $ref: '#/components/schemas/ReturnSubmissionTask' links: $ref: '#/components/schemas/Links' type: object x-access: - Public RecallDecisionAnswer: description: Answer to the recall request. enum: - accepted - rejected - pending - partially_accepted - payment_cancelled example: accepted type: string x-access: - Public ReturnSubmissionTaskUpdate: properties: attributes: properties: name: $ref: '#/components/schemas/ReturnSubmissionTaskName' output: additionalProperties: type: object description: Key Value map that contains the Task result. example: outcome: passed type: object status: $ref: '#/components/schemas/ReturnSubmissionTaskStatus' type: object id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string type: enum: - return_submission_tasks type: string version: description: Version number example: 0 minimum: 0 type: integer type: object x-access: - Public RelationshipReversalAdmissionTasks: properties: data: items: $ref: '#/components/schemas/ReversalAdmissionTask' type: array type: object x-access: - Public ApiError: properties: error_code: format: uuid type: string error_message: type: string type: object x-access: - Public PaymentSubmissionTask: properties: attributes: properties: assignee: $ref: '#/components/schemas/PaymentSubmissionTaskAssignee' group: $ref: '#/components/schemas/PaymentSubmissionTaskGroup' input: additionalProperties: type: object description: Key Value map that contains additional data for executing the task. example: status_reason: blocked type: object name: $ref: '#/components/schemas/PaymentSubmissionTaskName' output: additionalProperties: type: object description: Key Value map that contains the Task result. example: outcome: passed type: object status: $ref: '#/components/schemas/PaymentSubmissionTaskStatus' type: object created_on: example: '2017-09-26T15:26:57.494Z' format: date-time type: string id: format: uuid type: string modified_on: example: '2017-09-26T15:26:57.494Z' format: date-time type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/PaymentSubmissionTaskRelationships' type: enum: - payment_submission_tasks type: string version: description: Version number example: 0 minimum: 0 type: integer type: object x-access: - Public ReturnReversalCreation: properties: data: $ref: '#/components/schemas/ReturnReversal' type: object x-access: - Public RecallSubmissionAttributes: properties: reference_id: description: Additional payment reference assigned by the scheme type: string scheme_status_code: description: Scheme-specific status code. Refer to scheme documentation where available. example: RR04 type: string status: $ref: '#/components/schemas/RecallSubmissionStatus' status_reason: description: Reason for submission failure if submission status is `delivery_failed` example: Gateway failure type: string submission_datetime: description: Date and time of the submission example: '2018-03-12T14:11:48.055Z' format: date-time readOnly: true type: - string - 'null' type: object x-access: - Public ReturnAdmissionTask: properties: attributes: properties: assignee: $ref: '#/components/schemas/ReturnAdmissionTaskAssignee' group: $ref: '#/components/schemas/ReturnAdmissionTaskGroup' input: additionalProperties: type: object description: Key Value map that contains additional data for executing the task. example: status_reason: blocked type: object name: $ref: '#/components/schemas/ReturnAdmissionTaskName' output: additionalProperties: type: object description: Key Value map that contains the Task result. example: outcome: passed type: object status: $ref: '#/components/schemas/ReturnAdmissionTaskStatus' type: object created_on: example: '2017-09-26T15:26:57.494Z' format: date-time type: string id: format: uuid type: string modified_on: example: '2017-09-26T15:26:57.494Z' format: date-time type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/ReturnAdmissionTaskRelationships' type: enum: - return_admission_tasks type: string version: description: Version number example: 0 minimum: 0 type: integer type: object x-access: - Public NewRecallDecisionSubmission: properties: attributes: $ref: '#/components/schemas/RecallDecisionSubmissionAttributes' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string type: description: Name of the resource type example: recall_decision_submissions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public UltimateEntity: properties: additional_address_line: description: Additional address line of the debtor/beneficiary address type: string x-length: 70 address: description: Ultimate debtor/beneficiary address example: - Liverpool Customer Service Centre - Stevenson Way, Wavertree, L13 1NW items: type: string type: array x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: Max 2 lines of 70 text. x-omitempty: true birth_city: description: Ultimate debtor/beneficiary birth city example: PARIS type: string x-availability: get: sepa: sometimes post: sepa: conditional x-description: sepa: If a Ultimate Beneficiary/Debtor Identification is used then only one of `organisation_identification`, `private_identification` or date and place of birth can be present. x-length: 35 birth_country: description: Ultimate debtor/beneficiary birth country. ISO 3166 format country code example: FR type: string x-availability: get: sepa: sometimes post: sepa: conditional x-description: sepa: If a Ultimate Beneficiary/Debtor Identification is used then only one of `organisation_identification`, `private_identification` or date and place of birth can be present. x-length: 2 birth_date: description: Ultimate debtor/beneficiary birth date. Formatted ISO 8601 format YYYY-MM-DD example: '1973-01-31' format: date type: - string - 'null' x-availability: get: sepa: sometimes post: sepa: conditional x-description: sepa: If a Ultimate Beneficiary/Debtor Identification is used then only one of `organisation_identification`, `private_identification` or date and place of birth can be present. birth_province: description: Ultimate debtor/beneficiary birth province example: SOUTH SIDE type: string x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: If a Ultimate Beneficiary/Debtor Identification is used then only one of `organisation_identification`, `private_identification` or date and place of birth can be present. x-length: 35 building_number: description: Building number of the debtor/beneficiary address type: string x-length: 16 city: description: City/Town of the Beneficiary address example: BRUSSELS type: string x-length: 30 country: description: Country of ultimate debtor/beneficiary address. ISO 3166 format country code example: GB type: string x-availability: get: sepa: sometimes post: sepa: optional x-length: 2 country_of_residence: description: Country of residence of the ultimate beneficiary, ISO 3166 format country code example: UA type: string x-length: 2 name: example: Jane Bond type: string x-availability: get: sepa: sometimes post: sepa: optional x-length: 70 organisation_identification: description: Organisation identification of an ultimate debtor/beneficiary, in the case that the ultimate debtor/beneficiary is an organisation and not a private person. example: ID1234656 type: string x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: The Identification can either be a BIC, BEI or Other Identification x-length: 35 organisation_identification_code: description: The code that specifies the type of `organisation_identification` example: BIC type: string x-availability: get: sepa: sometimes post: sepa: conditional x-description: sepa: If `organisation_identification` is specified, must be one of `BIC`, `BEI`, `BANK`, `CBID`, `CHID`, `CINC`, `COID`, `CUST`, `DUNS`, `EMPL`, `GS1G`, `SREN`, `SRET`, `TXID` or `Other` x-length: 5 organisation_identification_issuer: description: Issuer of the `organisation_identification` example: NATIONAL WESTMINSTER BANK PLC type: string x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: May only be present if `organisation_identification_code` is `Other` x-length: 35 organisation_identification_scheme: description: The code that specifies the scheme of `organisation_identification` example: CustomerId type: string x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: May only be present if `organisation_identification_code` is `Other` x-length: 35 organisation_identifications: description: Array for additional ID(s) of ultimate organisation items: $ref: '#/components/schemas/BeneficiaryDebtorOrganisationIdentification' type: array x-availability: get: sepa: sometimes post: sepa: optional x-description: sepa: Array for additional ID(s) for ultimate organisation x-omitempty: true post_code: description: Post code of the debtor/beneficiary address type: string x-length: 16 postal_address: $ref: '#/components/schemas/PostalAddress' description: Postal address of the ultimate debtor/beneficiary x-omitempty: true private_identification: $ref: '#/components/schemas/PrivateIdentification' province: description: Province of the debtor/beneficiary address type: string x-length: 35 street_name: description: Street name of the debtor/beneficiary address example: Park Avenue type: string x-length: 70 type: object x-access: - Public RelationshipReturnAdmissionBeneficiaryAccount: properties: data: items: $ref: '#/components/schemas/ReturnAdmissionBeneficiaryAccount' type: array type: object x-access: - Public ReturnSubmissionTaskAmendment: properties: data: $ref: '#/components/schemas/ReturnSubmissionTaskUpdate' type: object x-access: - Public RelationshipPaymentAdmissionBeneficiaryAccount: properties: data: items: $ref: '#/components/schemas/PaymentAdmissionBeneficiaryAccount' type: array type: object x-access: - Public ReturnSubmissionStatus: description: '[Status](http://draft-api-docs.form3.tech/api.html#enumerations-payment-submission-status) of the submission' enum: - accepted - limit_check_pending - limit_check_failed - limit_check_passed - released_to_gateway - delivery_confirmed - delivery_failed - submitted - validation_pending - queued_for_delivery example: accepted type: string x-access: - Public AdviceSubmissionCreation: properties: data: $ref: '#/components/schemas/NewAdviceSubmission' type: object x-access: - Public ResourceSignature: description: Structure containing information about cryptographic signature of the payment. properties: key_id: description: The key identifier used for signature verification. maxLength: 64 minLength: 1 type: string references: description: Reference information associated with the signature. items: maxLength: 50 type: string maxItems: 10 type: array role: description: Indicates who is signing the payment. enum: - customer type: string signature: description: The cryptographic signature of the payment. maxLength: 500 type: string type: object x-access: - Public ReturnAdmissionBeneficiaryAccount: properties: attributes: properties: user_defined_data: description: All purpose list of key-value pairs specific data stored on the associated beneficiary account items: $ref: '#/components/schemas/UserDefinedData' maxItems: 5 type: array type: object id: format: uuid type: string type: description: Name of the resource type example: accounts pattern: ^[A-Za-z_]*$ type: string type: object x-access: - Public RecallDecisionCreation: properties: data: $ref: '#/components/schemas/RecallDecision' type: object x-access: - Public PaymentSubmissionRelationships: properties: payment: $ref: '#/components/schemas/RelationshipPayments' payment_submission_task: $ref: '#/components/schemas/RelationshipPaymentSubmissionTasks' validations: $ref: '#/components/schemas/RelationshipLinks' type: object x-access: - Public ReturnAdmissionTaskDetailsResponse: properties: data: $ref: '#/components/schemas/ReturnAdmissionTask' links: $ref: '#/components/schemas/Links' type: object x-access: - Public Party: properties: additional_address_line: description: Additional address lines of the party address items: maxLength: 35 type: string maxItems: 3 type: array x-omitempty: true building_number: maxLength: 16 type: string city: maxLength: 35 type: string country: description: Country of the party, ISO 3166 format country code example: US maxLength: 2 type: string name: description: Name by which the party is known maxLength: 140 type: string organisation_identifications: items: $ref: '#/components/schemas/BeneficiaryDebtorOrganisationIdentification' type: array post_code: maxLength: 16 type: string postal_address: $ref: '#/components/schemas/PostalAddress' description: Postal address of the party x-omitempty: true province: maxLength: 35 type: string role: $ref: '#/components/schemas/PartyRole' street_name: maxLength: 70 type: string type: object x-access: - Public ReversalAdmissionTaskDetailsResponse: properties: data: $ref: '#/components/schemas/ReversalAdmissionTask' links: $ref: '#/components/schemas/Links' type: object x-access: - Public BankIdCode: enum: - SWBIC - GBDSC - BE - FR - DEBLZ - GRBIC - ITNCC - PLKNR - PTNCC - ESNCC - CHBCC type: string x-access: - Public RelationshipPaymentSubmissionTasks: properties: data: items: $ref: '#/components/schemas/PaymentSubmissionTask' type: array type: object x-access: - Public ReturnSubmissionTaskName: description: Identifies the return submission task to be executed example: return_validation type: string x-access: - Public PaymentSubmissionFetch: properties: attributes: properties: clearing_system: description: Clearing infrastructure through which the payment instruction was processed example: TIPS pattern: ^[0-9A-Za-z_]*$ type: string file_identifier: description: Identification code of the file sent to scheme. example: '123456' pattern: ^[0-9a-zA-Z]+$ type: - string - 'null' file_number: description: Number of the file sent to scheme. example: '001' pattern: ^[0-9]+$ type: - string - 'null' limit_breach_end_datetime: description: Time a payment was released from being held due to a limit breach example: '2018-03-12T14:11:55.055Z' format: date-time readOnly: true type: - string - 'null' limit_breach_start_datetime: description: Start time a payment was held due to a limit breach example: '2018-03-12T14:11:50.055Z' format: date-time readOnly: true type: - string - 'null' posting_status: $ref: '#/components/schemas/PostingStatus' redirected_account_number: description: Details of the account to which funds are redirected (if applicable) example: '12345678' type: string redirected_bank_id: description: Details of the bank to which funds are redirected (if applicable) example: '400300' type: string reference_id: description: Additional payment reference assigned by the scheme type: string route: description: Route taken for an outbound payment enum: - on_us - xp type: string scheme_response_received_datetime: description: Date and time the final response to the outbound payment was received. Supports RFC3339 Nano example: '2017-09-26T15:26:57.123456789Z' format: date-time pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{1,9}Z$ type: - string - 'null' scheme_sent_datetime: description: Date and time the outbound payment was sent, or queued for internal throttling. Supports RFC3339 Nano example: '2017-09-26T15:26:57.123456789Z' format: date-time pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{1,9}Z$ type: - string - 'null' scheme_status_code: description: Scheme-specific status (if submission has been submitted to a scheme) example: '0000' type: string scheme_status_code_description: description: '[Description](http://api-docs.form3.tech/api.html#enumerations-scheme-status-codes-for-bacs) of `scheme_status_code`' example: Field 1 (destination sorting code) was invalid type: string settlement_cycle: description: Cycle in which the payment will be settled example: 1 minimum: 0 type: integer settlement_date: description: Date that the payment will be settled example: '2017-07-23' format: date type: - string - 'null' status: $ref: '#/components/schemas/PaymentSubmissionStatus' status_reason: description: Description of the submission status example: Accepted without qualification type: string submission_datetime: description: Date of the submission example: '2018-03-12T14:11:48.055Z' format: date-time readOnly: true type: string transaction_start_datetime: description: Time the request was received by Form3. Used to compute the total transaction time of a payment. example: '2018-03-12T14:11:49.055Z' format: date-time readOnly: true type: string type: object created_on: format: date-time type: - string - 'null' id: format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/PaymentSubmissionFetchRelationships' type: description: Name of the resource type example: payment_submissions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public NewPayment: properties: attributes: $ref: '#/components/schemas/PaymentAttributes' created_on: format: date-time type: - string - 'null' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/NewPaymentRelationships' signatures: items: $ref: '#/components/schemas/ResourceSignature' maxItems: 1 type: array x-access: - Public x-omitempty: true type: description: Name of the resource type example: payments pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id - attributes type: object x-access: - Public ReversalPayment: properties: attributes: properties: user_defined_data: description: All purpose list of key-value pairs. items: $ref: '#/components/schemas/UserDefinedData' maxItems: 5 type: array x-omitempty: true type: object created_on: format: date-time type: - string - 'null' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: properties: payment: $ref: '#/components/schemas/RelationshipLinks' description: ID of the payment resource related to the reversal reversal_admission: properties: data: description: Array of Reversal Admission resources related to the reversal items: $ref: '#/components/schemas/ReversalAdmission' type: array type: object reversal_submission: properties: data: description: Array of Reversal Submission resources related to the reversal items: $ref: '#/components/schemas/ReversalSubmission' type: array type: object type: object type: description: Name of the resource type example: reversals pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public ReturnAdmissionTaskUpdate: properties: attributes: properties: name: $ref: '#/components/schemas/ReturnAdmissionTaskName' output: additionalProperties: type: object description: Key Value map that contains the Task result. example: outcome: passed type: object status: $ref: '#/components/schemas/ReturnAdmissionTaskStatus' type: object id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string type: enum: - return_admission_tasks type: string version: description: Version number example: 0 minimum: 0 type: integer type: object x-access: - Public ChargesInformation: properties: bearer_code: description: 'Specifies which party/parties will bear the charges associated with the processing of the payment transaction. Can be one of the following: `DEBT`, `CRED`, `SHAR` or `SLEV`' example: SLEV type: string x-length: 4 charges_bearer: items: description: List of agents applying charges properties: agent: properties: bank_additional_address_line: items: maxLength: 35 type: string maxItems: 3 type: array x-omitempty: true bank_building_number: maxLength: 16 type: string bank_city: maxLength: 35 type: string bank_country: description: ISO 3166 format country code example: US maxLength: 2 type: string bank_ids: description: Array for additional ID(s) for agent items: $ref: '#/components/schemas/AccountWithBankId' type: array x-omitempty: true bank_name: maxLength: 140 type: string bank_post_code: maxLength: 16 type: string bank_postal_address: $ref: '#/components/schemas/PostalAddress' description: Agent postal address x-omitempty: true bank_province: maxLength: 35 type: string bank_street_name: maxLength: 70 type: string type: object amount: description: Transaction charges applied by agent. Requires 1 to 2 decimal places. Must be > 0. example: '1.20' pattern: ^[0-9]{0,20}(?:\.[0-9]{1,10})?$ type: string currency: description: Currency of charges_bearer amount. Currency code as defined in [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm). example: USD maxLength: 3 type: string type: object type: array x-omitempty: true receiver_charges_amount: description: Transaction charges due to the receiver of the transaction. Requires 1 to 2 decimal places. Must be > 0. example: '1.20' type: string receiver_charges_currency: description: Currency of `receiver_charges_amount`. Currency code as defined in [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm). example: EUR type: string x-length: 3 sender_charges: items: description: List of transaction charges due to the sender of the transaction properties: amount: description: Amount of each transaction charge due to the sender of the transaction. Requires 1 to 2 decimal places. Must be > 0. example: '2.00' type: string currency: description: Currency of `amount`. Currency code as defined in [ISO 4217](http://www.iso.org/iso/home/standards/currency_codes.htm). example: EUR type: string type: object type: array x-omitempty: true type: object x-access: - Public BeneficiaryDebtorAccountHoldingEntity: properties: bank_additional_address_line: description: Additional address lines of the debtor/benificiary bank address items: maxLength: 35 type: string maxItems: 3 type: array x-omitempty: true bank_address: description: Financial institution address example: - Liverpool Customer Service Centre - Stevenson Way - Wavertree - L13 1NW items: type: string type: array x-omitempty: true bank_building_number: description: Building number of the debtor/benificiary bank address maxLength: 16 type: string bank_city: description: City/Town of the debtor/benificiary bank address maxLength: 35 type: string bank_country: description: Country of the debtor/benificiary bank address, ISO 3166 format country code example: US maxLength: 2 type: string bank_id: description: Financial institution identification example: '333333' type: string x-length: 11 bank_id_code: description: The type of identification provided at `bank_id` attribute. Must be ISO code as listed in the [External Code Sets spreadsheet](https://www.iso20022.org/external_code_list.page) type: string x-length: 5 bank_ids: description: Array for additional ID(s) for agent items: $ref: '#/components/schemas/AccountWithBankId' type: array x-omitempty: true bank_name: description: Financial institution name example: NATIONAL WESTMINSTER BANK PLC type: string x-length: 35 bank_party_id: description: Identifier of the financial institution which services the account example: //AT12345 type: string x-length: 35 bank_post_code: description: Post code of the debtor/benificiary bank address maxLength: 16 type: string bank_postal_address: $ref: '#/components/schemas/PostalAddress' description: Postal address of the debtor/benificiary bank x-omitempty: true bank_province: description: Province of the debtor/benificiary bank address maxLength: 35 type: string bank_street_name: description: Street name of the debtor/benificiary bank address maxLength: 70 type: string type: object x-access: - Public ReturnSubmissionTask: properties: attributes: $ref: '#/components/schemas/ReturnSubmissionTaskAttributes' created_on: example: '2017-09-26T15:26:57.494Z' format: date-time type: string id: format: uuid type: string modified_on: example: '2017-09-26T15:26:57.494Z' format: date-time type: string organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/ReturnSubmissionTaskRelationships' type: enum: - return_submission_tasks type: string version: description: Version number example: 0 minimum: 0 type: integer type: object x-access: - Public UserDefinedData: properties: key: description: Key of the pair maxLength: 45 minLength: 1 type: string value: description: Value of the pair maxLength: 45 minLength: 1 type: string required: - key - value type: object x-access: - Public RelationshipReturnSubmissionTasks: properties: data: items: $ref: '#/components/schemas/ReturnSubmissionTask' type: array type: object x-access: - Public ReversalAdmissionTaskRelationships: properties: payment: $ref: '#/components/schemas/RelationshipPayments' reversal: $ref: '#/components/schemas/RelationshipReversals' reversal_admission: $ref: '#/components/schemas/RelationshipReversalAdmissions' type: object x-access: - Public ReversalSubmissionCreationResponse: properties: data: $ref: '#/components/schemas/ReversalSubmission' links: $ref: '#/components/schemas/Links' type: object x-access: - Public PaymentAdmissionTaskDetailsResponse: properties: data: $ref: '#/components/schemas/PaymentAdmissionTask' links: $ref: '#/components/schemas/Links' type: object x-access: - Public ReturnSubmissionTaskAttributes: properties: assignee: $ref: '#/components/schemas/ReturnSubmissionTaskAssignee' group: description: Identifies the task group the task belongs to example: accounting type: string input: additionalProperties: type: object description: Key Value map that contains additional data for executing the task. example: status_reason: blocked type: object name: description: Identifies the return submission task to be executed example: return_validation type: string output: additionalProperties: type: object description: Key Value map that contains the Task result. example: outcome: passed type: object status: $ref: '#/components/schemas/ReturnSubmissionTaskStatus' type: object x-access: - Public ReversalAdmissionTaskAttributes: properties: assignee: $ref: '#/components/schemas/ReversalAdmissionTaskAssignee' group: description: Identifies the task group the task belongs to example: accounting type: string name: description: Identifies the reversal admission task to be executed example: account_check type: string output: additionalProperties: type: object description: Key Value map that contains the Task result. example: outcome: passed type: object status: $ref: '#/components/schemas/ReversalAdmissionTaskStatus' type: object x-access: - Public RecallSubmissionCreationResponse: properties: data: $ref: '#/components/schemas/RecallSubmission' links: $ref: '#/components/schemas/Links' type: object x-access: - Public IntermediaryBankAccountHoldingEntity: properties: bank_address: description: Financial institution address example: - Liverpool Customer Service Centre - Stevenson Way - Wavertree - L13 1NW items: type: string type: array x-omitempty: true bank_id: description: Financial institution identification example: '333333' type: string x-length: 11 bank_id_code: description: The type of identification provided at `bank_id` attribute. Must be ISO code as listed in the [External Code Sets spreadsheet](https://www.iso20022.org/external_code_list.page) type: string x-length: 5 bank_name: description: Financial institution name example: XYZ BANK PLC type: string x-length: 35 bank_party_id: description: Identifier of the financial institution which services the account example: //AT12345 type: string x-length: 37 type: object x-access: - Public NewPaymentRelationships: properties: beneficiary: properties: data: description: Array of beneficiary resources related to the payment items: $ref: '#/components/schemas/RelationshipData' type: array type: object beneficiary_account: properties: data: description: Array of beneficiary account resources related to the payment items: $ref: '#/components/schemas/RelationshipData' type: array type: object debtor: properties: data: description: Array of debtor resources related to the payment items: $ref: '#/components/schemas/RelationshipData' type: array type: object debtor_account: properties: data: description: Array of debtor account resources related to the payment items: $ref: '#/components/schemas/RelationshipData' type: array type: object forwarded_payment: properties: data: description: ' Array of Inbound Payments that triggered the creation of this Forwarding Payment.' items: $ref: '#/components/schemas/RelationshipData' type: array type: object forwarded_return: properties: data: description: Array of Payment Return resources related to the payment items: $ref: '#/components/schemas/RelationshipData' type: array type: object fx_deal: properties: data: description: Array of FXDeal resources related to the payment items: $ref: '#/components/schemas/RelationshipData' type: array type: object payment_admission: properties: data: description: Array of Payment Admission resources related to the payment items: $ref: '#/components/schemas/PaymentAdmission' type: array type: object payment_advice: properties: data: description: Array of Payment Advice resources related to the payment items: $ref: '#/components/schemas/PaymentAdvice' type: array type: object payment_recall: properties: data: description: Array of Payment Recall resources related to the payment items: $ref: '#/components/schemas/Recall' type: array type: object payment_return: properties: data: description: Array of Payment Return resources related to the payment items: $ref: '#/components/schemas/ReturnPayment' type: array type: object payment_reversal: properties: data: description: Array of Payment Reversal resources related to the payment items: $ref: '#/components/schemas/ReversalPayment' type: array type: object payment_submission: properties: data: description: Array of Payment Submission resources related to the payment items: $ref: '#/components/schemas/PaymentSubmission' type: array type: object type: object x-access: - Public RecallDecisionSubmission: properties: attributes: $ref: '#/components/schemas/RecallDecisionSubmissionAttributes' created_on: format: date-time type: - string - 'null' id: description: Unique resource ID example: 7826c3cb-d6fd-41d0-b187-dc23ba928772 format: uuid type: string modified_on: format: date-time type: - string - 'null' organisation_id: description: Unique ID of the organisation this resource is created by example: ee2fb143-6dfe-4787-b183-ca8ddd4164d2 format: uuid type: string relationships: $ref: '#/components/schemas/RecallDecisionSubmissionRelationships' type: description: Name of the resource type example: recall_decision_submissions pattern: ^[A-Za-z_]*$ type: string version: description: Version number example: 0 minimum: 0 type: integer required: - id - organisation_id type: object x-access: - Public ReversalCreationResponse: properties: data: $ref: '#/components/schemas/ReversalPayment' links: $ref: '#/components/schemas/Links' type: object x-access: - Public securitySchemes: Basic: type: http scheme: basic OAuth2: type: oauth2 flows: clientCredentials: scopes: {} tokenUrl: https://api.form3.tech/v1/oauth2/token description: OAuth 2.0 with Client Credentials Grant type