Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Finansystech's Smart Payments Initiation Journey has the flexibility to intelligently adapt to the needs and contexts of your business!

With it, your customer's experience will be shaped according to the parameters you have available, which allows us to serve all contexts in the market.

 

Instant PIX payment method

When guiding your customer to the moment of closing the purchase, it will be necessary to inform them between the PIX Via Open Finance payment methods , among the other conventional options in your sales channel. The format in which the journey will be called is up to the strategy that your company defines, and you can use, for example, a QR Code or a link to activate the journey, via a button.
 

How to start the journey

In order for a company contracting the Open Keys solution to be able to call the Payment Initiation Journey, it is necessary to generate a token in which the client_id and client_secret of the operation must be indicated, indicated in the application panel, settings menu.

...

  

Token generation URL

Panel
bgColor#F4F5F7

https://onboard.smartkeys.engdev8429y94d.dev.fsapps.ioapp/api/portal/onboard/v1/token

 

cURL for Token generation

Code Block
curl --location 'https://onboard.smartkeys.8429y94d.engdevdev.fsapps.ioapp/api/portal/onboard/v1/token' \
--header 'Content-Type: application/json' \
--data '{   
    "client_id":"...-2567-....-ace9-...",
    "client_secret": "...8136-....-42ce-..."
}'

 

Response

Code Block
{
    "access_token": "...iJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJJUV96OE...",
    "expires_in": 3600,
    "refresh_expires_in": 0,
    "token_type": "Bearer",
    "not-before-policy": 0,
    "scope": "email profile"
}

...

Code Block
'Authorization': 'Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJJUV96OE...'

 

 

POST Payment Initiantion

 

With the token generated, it is necessary to pass it in the authorization of the /consents call , to obtain the user's consent and information.

This is the moment in which you can provide as much information as necessary to open consent, as a way of optimizing your customer's experience.

 

Fields present in the request and UX customization

  • CPF - If passed in the parameter, the journey presents the field filled in for your customer.

  • Transaction value - If passed in the parameter, the journey presents the field filled in for your customer.

  • Paymentview Instant PIX ( deposit-confirmation ) - The day of the transaction must be passed as the date and the code will recognize that it is an Instant PIX

  • Paymentview PIX Scheduled ( deposit-deposit-scheduling ) - With the parameter open, the code will recognize that this is an operation that will allow the customer to choose whether they want to pay immediately or schedule payment for a future date (within a maximum period of 12 months)

 

Specificity for the Paymentview and Paymenttype fields

  • Paymenttype via DICT - presents the data registered in the Application Panel, Configure Journeys option, Receipt data field

  • Paymenttype via MANU - it is necessary to pass the “creditor” and “creditorAccount blocks, as per the example in the sketch below.

...

Code Block
curl --location 'https://onboard.smartkeys.celcoin8429y94d.dev.fsapps.ioapp/api/portal/onboard/v1/payment' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJJUV96OE...' \
--data '{
    "cpf": "**93135***",
    "name": "Fernando",
    "amount": "100.00",
    "paymentview": "deposit-confirmation",
    "paymenttype": "DICT"
}'

...

Code Block
curl --location 'https://onboard.smartkeys.celcoin8429y94d.dev.fsapps.ioapp/api/portal/onboard/v1/payment' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJJUV96OE...' \
--data '{
    "cpf": "***81994***",
    "name": "Fernando",
    "amount": "0.15",
    "paymentview": "deposit-confirmation",
    "paymenttype": "MANU",
    "creditor": {
        "cpfCnpj": "***81564***",
        "name": "HOMOLOGACAO PIX",
        "personType": "PESSOA_NATURAL"
    },
    "creditorAccount": {
        "accountType": "CACC",
        "ispb": "9289****",
        "issuer": "00**",
        "number": "***73*2"
    }
}'

...

Code Block
{
    "url": "https://smartkeys-wl.celcoin.dev.fsapps.io/select-institution?id=yL79m4Kzc7DI0WfL-QKW_k_2b5..."
}

 

...

Smart payments initiation journey slim flow

In the most optimized scenario of the Smart journey, when we receive the parameters indicating the transaction value , the payer's CPF/CNPJ and the indication of payment as Instant PIX , the customer will only need:

...

  1. Inform which institution you wish to make the payment with;

  2. Confirm the operation

  3. Automatic redirection to the account holding institution

 

...

 

...

Authentication and payment confirmation steps

After automatic redirection to the environment of the institution holding the account, the customer will go through the authentication and confirmation steps of the operation , following the standards established by the chosen Financial Institution.

 

 

...

Journey completion stage

After this confirmation, the operation will be processed by Celcoin and the customer will be directed to your company's environment, where it is essential to present the journey completion screen with the transaction statement with the information provided by Callback.

...

Configure o Callback de Dados

 

Track payment status 

To confirm whether the payment was processed successfully (and the status of the payment), you can track via Webhook in Payment Initiation or using the Pooling API .

...

Code Block
curl --location 'https://api-smartkeysopenkeys.celcoin8429y94d.dev.fsapps.ioapp/api/smartopen-keys-itp/api/payment-consumer/v1/pix/consents/HVLeXYgP6…' \
--header 'Authorization: Bearer <PUT_HERE_THE_ACCESS_TOKEN>' \

...

Code Block
{
    "data": {
        "paymentId": "9be63638-3ef9-4427...",
        "endToEndId": "E139358932023091...",
        "consentId": "urn:celcoin:1e308e7f-b705-...",
        "creationDateTime": "2023-09-12T19:11:38Z",
        "statusUpdateDateTime": "2023-09-12T19:11:42Z",
        "proxy": "55155...",
        "status": "ACSC",
        "localInstrument": "DICT",
        "cnpjInitiator": "1393589...",
        "payment": {
            "amount": "1.15",
            "currency": "BRL"
        },
        "remittanceInformation": "Pagamento Pix",
        "creditorAccount": {
            "accountType": "CACC",
            "ispb": "9289...",
            "issuer": "0...",
            "number": "101..."
        },
        "debtorAccount": {
            "ispb": "12345678",
            "issuer": "1774",
            "number": "1234567890",
            "accountType": "CACC"
        }
    },
    "links": {
        "self": "https://api.opb.celcoin.dev.fsapps.io/open-banking/payments/v2/pix/payments/9be63638-3ef9-..."
    },
    "meta": {
        "requestDateTime": "2023-09-12T19:11:56Z"
    }
}

 

The journey ID

The journey ID is the unique identifier of the whitelabel flow, which links the beginning of the journey with the consent and payment created, as at the beginning of this flow the consent does not yet exist. It's the code yL79m4Kzc7DI0WfL-QK...from our example above (payment creation response response).

...

Code Block
curl --location 'https://api-smartkeysopenkeys.celcoin8429y94d.dev.fsapps.ioapp/api/smartopen-keys-itp/api/payment-consumer/v1/pix/payments/journey/yL79m4Kzc7DI0WfL-QK...' \
--header 'Authorization: Bearer <PUT_HERE_THE_ACCESS_TOKEN>' \

...

Code Block
curl --location 'https://api-smartkeysopenkeys.celcoin8429y94d.dev.fsapps.ioapp/api/smartopen-keys-itp/api/interceptor' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJJUV96OE...' \
--data '{
    "endpoint": "",
    "isAuthenticated": true,
    "user": "",
    "password": ""
}'

...

Code Block
curl --location 'https://api-smartkeysopenkeys.celcoin8429y94d.dev.fsapps.ioapp/api/smartopen-keys-itp/api/payment-consumer/v1/pix/payments/0d42f0c8-f5ff-493f-a350-19d5b8b76618'
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJJUV96OE...' \

...

Code Block
curl --location 'https://api-smartkeysopenkeys.celcoin8429y94d.dev.fsapps.ioapp/api/smartopen-keys-itp/api/payment-consumer/v1/pix/consents/yfPdbpcWgHQo1VL5vrYzd0xIRuxEUJqPO5ufvEN2esA'
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJJUV96OE...' \

...