SYsynctera
PaymentSchedules

Create a payment schedule

Changed on

Create a payment schedule

post/payment_schedules

Request

  • Base URL
    https://api-sandbox.synctera.com/v0
  • URL
    https://api-sandbox.synctera.com/v0/payment_schedules
  • Auth
    HTTP bearer

Request body

descriptionstring required

User provided description for the payment schedule

idstring uuid

Payment schedule ID

metadataobject

User provided JSON format data

status'ACTIVE' | 'CANCELLED' | 'ERRORED' | 'EXPIRED'

Status of the payment schedule.

tenantstring

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example request

{
  "payment_instruction": {
    "request": {
      "amount": 607,
      "company_entry_description": "PAYROLL",
      "company_name": "Asdf Finance",
      "currency": "USD",
      "customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "dc_sign": "debit",
      "effective_date": "2022-03-18",
      "hold": {
        "duration": 2
      },
      "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "reference_info": "Tempore atque et cum."
    }
  },
  "schedule": {
    "execution_time": "07:30:00"
  },
  "tenant": "abcdef_ghijkl"
}

Response

Created payment schedule

creation_timestring date-time required
last_updated_timestring date-time required
tenantstring required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

descriptionstring required

User provided description for the payment schedule

idstring uuid

Payment schedule ID

metadataobject

User provided JSON format data

status'ACTIVE' | 'CANCELLED' | 'ERRORED' | 'EXPIRED'

Status of the payment schedule.

Example response

{
  "tenant": "abcdef_ghijkl",
  "payment_instruction": {
    "request": {
      "amount": 607,
      "company_entry_description": "PAYROLL",
      "company_name": "Asdf Finance",
      "currency": "USD",
      "customer_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "dc_sign": "debit",
      "effective_date": "2022-03-18",
      "hold": {
        "duration": 2
      },
      "originating_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "receiving_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "reference_info": "Tempore atque et cum."
    }
  },
  "schedule": {
    "execution_time": "07:30:00"
  }
}

Changes

  • a6363e3dbb7bRevision changes
    • warning

      added the new ACCOUNT_CLOSING_TRANSFER enum value to the ////////// response property for the response status

    • warning

      added the new ACCOUNT_CLOSING_TRANSFER_REVERSAL enum value to the ////////// response property for the response status

    • warning

      added the new INCOMING_WIRE_RETURN enum value to the ////////// response property for the response status

    • warning

      added the new INTERNATIONAL_INCOMING_WIRE enum value to the ////////// response property for the response status

    • warning

      added the new INTERNATIONAL_INCOMING_WIRE_RETURN enum value to the ////////// response property for the response status

    • info

      added the new ACCOUNT_CLOSING_TRANSFER enum value to the request property //////

    • info

      added the new ACCOUNT_CLOSING_TRANSFER_REVERSAL enum value to the request property //////

    • info

      added the new INCOMING_WIRE_RETURN enum value to the request property //////

    • info

      added the new INTERNATIONAL_INCOMING_WIRE enum value to the request property //////

    • info

      added the new INTERNATIONAL_INCOMING_WIRE_RETURN enum value to the request property //////

  • b0d812e6cdd0Revision changes
    • breaking

      removed the enum value CARD_CHARGEBACK_CASE1 of the request property //////

    • breaking

      removed the enum value CARD_CHARGEBACK_CASE1_REVERSAL of the request property //////

    • breaking

      removed the enum value CARD_CHARGEBACK_CASE2 of the request property //////

    • breaking

      removed the enum value CARD_CHARGEBACK_CASE2_REVERSAL of the request property //////

    • breaking

      removed the enum value CARD_CHARGEBACK_CASE3 of the request property //////

    • breaking

      removed the enum value CARD_CHARGEBACK_CASE3_REVERSAL of the request property //////

    • warning

      added the new ARBITRATION_FINAL_CREDIT enum value to the ////////// response property for the response status

    • warning

      added the new ARBITRATION_FINAL_CREDIT_REVERSAL enum value to the ////////// response property for the response status

    • warning

      added the new CHARGEBACK_FINAL_CREDIT enum value to the ////////// response property for the response status

    • warning

      added the new CHARGEBACK_FINAL_CREDIT_REVERSAL enum value to the ////////// response property for the response status

    • warning

      added the new PROVISIONAL_CREDIT enum value to the ////////// response property for the response status

    • warning

      added the new PROVISIONAL_CREDIT_REVERSAL enum value to the ////////// response property for the response status

    • warning

      added the new WRITEOFF_FRAUD_FINAL_CREDIT enum value to the ////////// response property for the response status

    • warning

      added the new WRITEOFF_FRAUD_FINAL_CREDIT_REVERSAL enum value to the ////////// response property for the response status

    • warning

      added the new WRITEOFF_NON_FRAUD_FINAL_CREDIT enum value to the ////////// response property for the response status

    • warning

      added the new WRITEOFF_NON_FRAUD_FINAL_CREDIT_REVERSAL enum value to the ////////// response property for the response status

    • info

      added the new ARBITRATION_FINAL_CREDIT enum value to the request property //////

    • info

      added the new ARBITRATION_FINAL_CREDIT_REVERSAL enum value to the request property //////

    • info

      added the new CHARGEBACK_FINAL_CREDIT enum value to the request property //////

    • info

      added the new CHARGEBACK_FINAL_CREDIT_REVERSAL enum value to the request property //////

    • info

      added the new PROVISIONAL_CREDIT enum value to the request property //////

    • info

      added the new PROVISIONAL_CREDIT_REVERSAL enum value to the request property //////

    • info

      added the new WRITEOFF_FRAUD_FINAL_CREDIT enum value to the request property //////

    • info

      added the new WRITEOFF_FRAUD_FINAL_CREDIT_REVERSAL enum value to the request property //////

    • info

      added the new WRITEOFF_NON_FRAUD_FINAL_CREDIT enum value to the request property //////

    • info

      added the new WRITEOFF_NON_FRAUD_FINAL_CREDIT_REVERSAL enum value to the request property //////

    • info

      removed the CARD_CHARGEBACK_CASE1 enum value from the ////////// response property for the response status

    • info

      removed the CARD_CHARGEBACK_CASE1_REVERSAL enum value from the ////////// response property for the response status

    • info

      removed the CARD_CHARGEBACK_CASE2 enum value from the ////////// response property for the response status

    • info

      removed the CARD_CHARGEBACK_CASE2_REVERSAL enum value from the ////////// response property for the response status

    • info

      removed the CARD_CHARGEBACK_CASE3 enum value from the ////////// response property for the response status

    • info

      removed the CARD_CHARGEBACK_CASE3_REVERSAL enum value from the ////////// response property for the response status