CEcelcoin
Iniciação de Pagamento

Processamento de Pagamento.

Método para Processamento de Pagamento.

post/open-keys/itp/api/v2/payments/v4/payment-initiation

Request

  • Base URL
    http://localhost:3000
  • URL
    http://localhost:3000/open-keys/itp/api/v2/payments/v4/payment-initiation
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://keycloak.sandbox.shared.fsapps.io/auth/realms/openkeys-itp-v2-sandbox-dev/protocol/openid-connect/token scopes: journey, app

Request body

brandIdstring required

ID é o identificador único da marca

journeySessionIdstring

O ID é o identificador único da jornada

redirectUrlstring uri

O URI de redirecionamento autorizado pela aplicação.

directoryCallbackboolean

Indica se o redirecionamento é direto do diretório

tagsstring

Tags que podem ser usadas para classificar a sessão da jornada.

Example request

{
  "journeySessionId": "f362a873-c127-4122-b711-a37b24a36914",
  "redirectUrl": "https://example.com",
  "enrollment": {
    "platform": "ANDROID"
  },
  "data": {
    "loggedUser": {
      "document": {
        "identification": "12345678909",
        "rel": "CPF"
      }
    },
    "businessEntity": {
      "document": {
        "identification": "11111111111111",
        "rel": "CNPJ"
      }
    },
    "creditor": {
      "cpfCnpj": "58764789000137",
      "personType": "PESSOA_JURIDICA",
      "name": "Marco Antonio de Brito"
    },
    "payment": {
      "type": "PIX",
      "schedule": {
        "single": {
          "date": "2023-08-23"
        },
        "daily": {
          "startDate": "2023-08-23"
        },
        "weekly": {
          "dayOfWeek": "QUINTA_FEIRA",
          "startDate": "2023-08-23"
        },
        "monthly": {
          "startDate": "2023-08-23"
        },
        "custom": {
          "additionalInformation": "Todas quintas e domingos por 6 meses"
        }
      },
      "date": "2024-03-05",
      "currency": "BRL",
      "amount": "1.12",
      "ibgeTownCode": "5300108",
      "details": {
        "localInstrument": "DICT",
        "qrCode": "\n\t\t\t\t\t\t  00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012\n\t\t\t\t\t\t  BR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062\n\t\t\t\t\t\t  530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123AB\n\t\t\t\t\t\t  CD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76",
        "proxy": "12345678901",
        "creditorAccount": {
          "accountType": "CACC",
          "ispb": "12345678",
          "issuer": "1774",
          "number": "1234567890"
        }
      }
    },
    "debtorAccount": {
      "accountType": "CACC",
      "ispb": "12345678",
      "issuer": "1774",
      "number": "1234567890"
    },
    "remittanceInformation": "Pagamento da nota XPTO035-002"
  }
}

Response

Payment Processing successfully returned.

idstring required

O ID é o identificador único do ITP

paymentInitiationApi'PAYMENTS_V4' required
createdAtstring required
updatedAtstring required
deletedAtstring required
brandIdstring required

ID é o identificador único da marca

journeySessionIdstring

O ID é o identificador único da jornada

redirectUrlstring uri

O URI de redirecionamento autorizado pela aplicação.

directoryCallbackboolean

Indica se o redirecionamento é direto do diretório

tagsstring

Tags que podem ser usadas para classificar a sessão da jornada.

applicationIdstring required

O ID da aplicação. É um número exclusivo que identifica a aplicação.

tokenIdstring required
authorizationUrlstring uri required
ofConsentIdstring required
idempotencyKeystring required

Example response

{
  "paymentInitiationApi": "PAYMENTS_V4",
  "createdAt": "2024-01-01T20:32:44.581Z",
  "updatedAt": "2024-01-01T20:32:44.581Z",
  "deletedAt": "2024-01-01T20:32:44.581Z",
  "journeySessionId": "f362a873-c127-4122-b711-a37b24a36914",
  "redirectUrl": "https://example.com",
  "enrollment": {
    "platform": "ANDROID"
  },
  "data": {
    "loggedUser": {
      "document": {
        "identification": "12345678909",
        "rel": "CPF"
      }
    },
    "businessEntity": {
      "document": {
        "identification": "11111111111111",
        "rel": "CNPJ"
      }
    },
    "creditor": {
      "cpfCnpj": "58764789000137",
      "personType": "PESSOA_JURIDICA",
      "name": "Marco Antonio de Brito"
    },
    "payment": {
      "type": "PIX",
      "schedule": {
        "single": {
          "date": "2023-08-23"
        },
        "daily": {
          "startDate": "2023-08-23"
        },
        "weekly": {
          "dayOfWeek": "QUINTA_FEIRA",
          "startDate": "2023-08-23"
        },
        "monthly": {
          "startDate": "2023-08-23"
        },
        "custom": {
          "additionalInformation": "Todas quintas e domingos por 6 meses"
        }
      },
      "date": "2024-03-05",
      "currency": "BRL",
      "amount": "1.12",
      "ibgeTownCode": "5300108",
      "details": {
        "localInstrument": "DICT",
        "qrCode": "\n\t\t\t\t\t\t  00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012\n\t\t\t\t\t\t  BR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062\n\t\t\t\t\t\t  530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123AB\n\t\t\t\t\t\t  CD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76",
        "proxy": "12345678901",
        "creditorAccount": {
          "accountType": "CACC",
          "ispb": "12345678",
          "issuer": "1774",
          "number": "1234567890"
        }
      }
    },
    "debtorAccount": {
      "accountType": "CACC",
      "ispb": "12345678",
      "issuer": "1774",
      "number": "1234567890"
    },
    "remittanceInformation": "Pagamento da nota XPTO035-002"
  },
  "journeySession": {
    "createdAt": "2024-01-01T20:32:44.581Z",
    "updatedAt": "2024-01-01T20:32:44.581Z",
    "deletedAt": "2024-01-01T20:32:44.581Z",
    "settings": [
      {
        "key": "JOURNEY_RULES"
      }
    ]
  },
  "authorizationUrl": "https://example.com",
  "ofConsent": {
    "authorization_url": "https://example.com",
    "status": "AWAITING_AUTHORISATION"
  },
  "httpCalls": [
    {
      "createdAt": "2024-01-01T20:32:44.581Z",
      "updatedAt": "2024-01-01T20:32:44.581Z",
      "deletedAt": "2024-01-01T20:32:44.581Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.