Orchestration Template

Add an orchestration template

Requisição

Adds an orchestration template with a unique name.

Segurança

Bearer

Corpoapplication/jsonobrigatório

namestring, [ 1 .. 64 ] characters^[a-zA-Z0-9_-]*$obrigatório

Name of the orchestration template. It must start with 'custom'.

Exemplo:"custom_orchestration_template_v1"

payment_typestringobrigatório

The payment type for which the template is to be used.

Enum:"REGULAR""RETURN""ACCEPT""REVERSAL"

connector_rolestringobrigatório

The connector role for which the template is to be used.

Enum:"SENDING""RECEIVING""INTERMEDIARY"

default_templateboolean

Is orchestration template default.

Padrão:false

Exemplo:true

orchestration_template_descriptionstring, <= 256 characters^[a-zA-Z0-9@_,.:\s-]*$

Orchestration template description.

Padrão:""

activity_orderArray of objects, non-emptyobrigatório

Activity order list.

curl -i -X POST \
  https://docs.ripple.com/_mock/pt-br/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/template \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "custom_orchestration_template_v1",
    "payment_type": "REGULAR",
    "connector_role": "SENDING",
    "default_template": true,
    "orchestration_template_description": "",
    "activity_order": [
      {
        "activity_name": "activity_v1",
        "next_activity": [
          {
            "status": "SUCCESS",
            "activity_name": "activity_v1"
          }
        ]
      }
    ]
  }'

Respostas

Successfully created orchestration template.

Corpoapplication/json

namestring, <= 64 charactersobrigatório

Orchestration template name.

Exemplo:"custom_orchestration_template_v1"

payment_typestring

The payment type for which the template is to be used.

Enum:"REGULAR""RETURN""REVERSAL"

connector_rolestring