Bank Transfers

Bank Payout (Pix)

Auth-Service API

curl --location --request POST 'https://{{baseUrl}}/auth-service/1.1/protocol/openid-connect/token' \
--header 'x-api-key: {{apikey}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'username={{username}}' \
--data-urlencode 'password={{password}}'
{
    "access_token": "{{access_token}}",
    "expires_in": 300,
    "refresh_expires_in": 1800,
    "refresh_token": "{{refresh_token}}",
    "token_type": "Bearer",
    "not-before-policy": 0,
    "session_state": "{{session_state}}",
    "scope": "profile email"
}

PaymentMethod API

curl --location --request GET 'https://{{baseUrl}}/payment-methods/1.0/paymentmethodtypes?direction=out&country=BR&paymentMethodTypeClass=bank&paymentMethodTypeStatus=available' \
--header 'X-User-Bearer: {{access_token}}' \
--header 'x-api-key: {{api_key}}' 
[
    {
        "country": "UY",
        "currency": "UYU",
        "directUsage": true,
        "direction": "out",
        "fields": [
            {
                "description": "Document number",
                "fieldType": "input",
                "isUserField": true,
                "mandatory": true,
                "name": "document_number",
                "regex": ".*",
                "validOptions": []
            },
            {
                "description": "Expiration hours",
                "fieldType": "input",
                "isUserField": false,
                "mandatory": false,
                "name": "expiration_hours",
                "regex": ".*",
                "validOptions": []
            }
        ],
        "imageURL": null,
        "paymentMethodType": "redpagosout-uy",
        "paymentMethodTypeClass": "cash",
        "paymentMethodTypeDescription": "RedPagos",
        "paymentMethodTypePos": [],
        "paymentMethodTypeStatus": "available",
        "protected": false,
        "storable": false,
        "usage": null
    }
]

Transaction API

curl --location --request POST 'https://gateway-am.apps.ins.inswhub.com/transactions/1.0/transactions/type/withdrawal' \
--header 'X-User-Bearer: {{access_token}}' \
--header 'x-api-key: {{api_key}}' \
--header 'X-CorrelationID: 393c990f-ab88-4b49-8e68-869e093ef545' \
--header 'X-Callback-URL: https://webhook.site/db46c24f-b95a-4a8c-9a6a-636d6d575b21' \
--header 'X-Channel: WS' \
--header 'Content-Type: application/json' \
--data-raw '{
  "amount": "50",
  "currency": "BRL",
  "creditParty": {
      "type": "pixout-br",
      "data" : {
          "key" : "[email protected]"
      }
  },
  "debitParty": {
    "paymentMethodReference": "3334343132332D313030302D32333639"
  },
  "descriptionText": "PIX BR 13/04",
  "requestingOrganisationTransactionReference": "185668",
  "country": "BR"
}'
{
    "amount": "50.00000000",
    "conciliationOptions": [
        "finished",
        "error"
    ],
    "confirmed": true,
    "country": "BR",
    "creationDate": "2022-08-30T17:34:01.920166Z",
    "creditParty": {
        "data": {
            "key": "[email protected]"
        },
        "type": "pixout-br",
        "typeClass": "bank",
        "typeCountry": "BR"
    },
    "currency": "BRL",
    "debitParty": {
        "data": {
            "ACCOUNT_ID": "1000507"
        },
        "paymentMethodReference": "3334343132332D313030302D32333639",
        "type": "emoneyout-brl",
        "typeClass": "emoneyout",
        "typeCountry": "BR"
    },
    "descriptionText": "PIX BR 13/04",
    "fees": {
        "creditPartyEarnedCommission": "0.00000000",
        "creditPartyNetCommission": "0.00000000",
        "creditPartyPaidCommission": "0.00000000",
        "debitPartyEarnedCommission": "0.00000000",
        "debitPartyNetCommission": "0.00000000",
        "debitPartyPaidCommission": "0.00000000"
    },
    "fx": {},
    "geoCode": "",
    "metadata": [
        {
            "creationDate": "2022-08-30T17:34:02Z",
            "key": "SV_TRANSACTION_ID",
            "value": "107349"
        },
        {
            "creationDate": "2022-08-30T17:34:02Z",
            "key": "DEBIT_PARTY_PAID_COMMISSION",
            "value": "0.00000000"
        },
        {
            "creationDate": "2022-08-30T17:34:02Z",
            "key": "CREDIT_PARTY_NET_COMMISSION",
            "value": "0.00000000"
        },
        {
            "creationDate": "2022-08-30T17:34:02Z",
            "key": "DEBIT_PARTY_EARNED_COMMISSION",
            "value": "0.00000000"
        },
        {
            "creationDate": "2022-08-30T17:34:02Z",
            "key": "DEBIT_PARTY_NET_COMMISSION",
            "value": "0.00000000"
        },
        {
            "creationDate": "2022-08-30T17:34:02Z",
            "key": "CREDIT_PARTY_PAID_COMMISSION",
            "value": "0.00000000"
        },
        {
            "creationDate": "2022-08-30T17:34:02Z",
            "key": "CREDIT_PARTY_EARNED_COMMISSION",
            "value": "0.00000000"
        }
    ],
    "modificationDate": "2022-08-30T17:34:05.568213Z",
    "recipientKyc": {},
    "requestDate": "",
    "requestingOrganisationTransactionReference": "185668",
    "requiredAction": {
        "actionType": "awaitconfirmation",
        "data": {
            "additionalInformation": [
                {
                    "key": "endToEndId",
                    "value": "E1393589320220830173401277580400"
                },
                {
                    "key": "slip",
                    "value": "     COMPROVANTE TRANSFERENCIA PIX      \n            30/08/2022 14:34            \n           TERM 11 AGENTE 999           \n                CONTROLE                \n    E1393589320220830173401277580400    \n----------------------------------------\n                PAGADOR                 \n\n           Teste Interno Is2b           \n            AG:1 CC:100467472           \n          CPF/CNPJ:85932702559          \n----------------------------------------\n               RECEBEDOR                \n\n      54403563 AG:1 CC:0000372163       \n        CPF/CNPJ:04219219000480         \n         CHAVE:[email protected]          \n----------------------------------------\n   DATA DO PAGAMENTO 30/08/2022 14:34   \n\n            VALOR R$ 50,0000            \n----------------------------------------\n              AUTENTICACAO              \n1D.B7.AB.DE.DD.C8.99.A1.E7.60.61.B8.FF.C4.4A.1E\n"
                },
                {
                    "key": "slipAuth",
                    "value": "1D.B7.AB.DE.DD.C8.99.A1.E7.60.61.B8.FF.C4.4A.1E"
                }
            ]
        },
        "expirationDate": "2023-08-25T17:34:05Z",
        "relatedPaymentMethodData": {
            "paymentMethodType": "pixout-br",
            "paymentMethodTypeClass": "bank",
            "paymentMethodTypeCountry": "BR",
            "paymentMethodTypeDescription": "PIX"
        },
        "status": "active"
    },
    "senderKyc": {},
    "subType": "",
    "transactionReference": "1005511",
    "transactionStatus": "waiting",
    "type": "withdrawal"
}

Callbacks

curl -X 'PUT' '{{callback_URL}}' \
--header 'connection: close' \
--header 'accept-encoding: gzip'\
--header 'x-timestamp: 2022-08-25T19:38:25.684163Z'\
--header 'x-signature: pCk1LUp002BtQqPEGbU9/Uu8ZKuW4W1ceBOAeRmOYZwwoaUo/BjMtBtrDYoPd8d3RTSMOPh73kaqzJHXUX6TQ+ROy33zIJqMaHVU9nSqkk+LBePbuZ+bRTtHv2jEa3HNdLlU3QSH8cyi8JS7c8BMC4JO5KSHIYGFDJ/RpyUU1jhJZbn0KEqYlfePsNUzj2oDUPL6ALRPwWKrqVyOeUr1YZm2bMOIBQZu4IHFX43213nUp6jKSCHwgXBXL6iUOmfF5JRVOXNL5mG+f3kc6FRz8mn0nHWPJ8m2M94GJNO9TTR1KYXxmDHZy0u0Qs5zgxrmzXn4+Xx0ZGf2Iw5tAGBApQ==' \
--header 'x-correlationid: 393c990f-ab88-4b49-8e68-869e093ef545'\ 
--header 'content-type: application/json' 
--header 'content-length: 3049'\
--data-raw '{
  "amount": "50.00000000",
  "conciliationOptions": [
    "finished",
    "error"
  ],
  "confirmed": true,
  "country": "BR",
  "creationDate": "2022-08-30T17:34:01.920166Z",
  "creditParty": {
    "data": {
      "key": "[email protected]"
    },
    "type": "pixout-br",
    "typeClass": "bank",
    "typeCountry": "BR"
  },
  "currency": "BRL",
  "debitParty": {
    "data": {
      "ACCOUNT_ID": "1000507"
    },
    "paymentMethodReference": "3334343132332D313030302D32333639",
    "type": "emoneyout-brl",
    "typeClass": "emoneyout",
    "typeCountry": "BR"
  },
  "descriptionText": "PIX BR 13/04",
  "fees": {
    "creditPartyEarnedCommission": "0.00000000",
    "creditPartyNetCommission": "0.00000000",
    "creditPartyPaidCommission": "0.00000000",
    "debitPartyEarnedCommission": "0.00000000",
    "debitPartyNetCommission": "0.00000000",
    "debitPartyPaidCommission": "0.00000000"
  },
  "fx": {},
  "geoCode": "",
  "metadata": [
    {
      "creationDate": "2022-08-30T17:34:02Z",
      "key": "SV_TRANSACTION_ID",
      "value": "107349"
    },
    {
      "creationDate": "2022-08-30T17:34:02Z",
      "key": "DEBIT_PARTY_PAID_COMMISSION",
      "value": "0.00000000"
    },
    {
      "creationDate": "2022-08-30T17:34:02Z",
      "key": "CREDIT_PARTY_NET_COMMISSION",
      "value": "0.00000000"
    },
    {
      "creationDate": "2022-08-30T17:34:02Z",
      "key": "DEBIT_PARTY_EARNED_COMMISSION",
      "value": "0.00000000"
    },
    {
      "creationDate": "2022-08-30T17:34:02Z",
      "key": "DEBIT_PARTY_NET_COMMISSION",
      "value": "0.00000000"
    },
    {
      "creationDate": "2022-08-30T17:34:02Z",
      "key": "CREDIT_PARTY_PAID_COMMISSION",
      "value": "0.00000000"
    },
    {
      "creationDate": "2022-08-30T17:34:02Z",
      "key": "CREDIT_PARTY_EARNED_COMMISSION",
      "value": "0.00000000"
    }
  ],
  "modificationDate": "2022-08-30T17:34:05.568213Z",
  "recipientKyc": {},
  "requestDate": "",
  "requestingOrganisationTransactionReference": "185668",
  "requiredAction": {
    "actionType": "awaitconfirmation",
    "data": {
      "additionalInformation": [
        {
          "key": "endToEndId",
          "value": "E1393589320220830173401277580400"
        },
        {
          "key": "slip",
          "value": "     COMPROVANTE TRANSFERENCIA PIX      \n            30/08/2022 14:34            \n           TERM 11 AGENTE 999           \n                CONTROLE                \n    E1393589320220830173401277580400    \n----------------------------------------\n                PAGADOR                 \n\n           Teste Interno Is2b           \n            AG:1 CC:100467472           \n          CPF/CNPJ:85932702559          \n----------------------------------------\n               RECEBEDOR                \n\n      54403563 AG:1 CC:0000372163       \n        CPF/CNPJ:04219219000480         \n         CHAVE:[email protected]          \n----------------------------------------\n   DATA DO PAGAMENTO 30/08/2022 14:34   \n\n            VALOR R$ 50,0000            \n----------------------------------------\n              AUTENTICACAO              \n1D.B7.AB.DE.DD.C8.99.A1.E7.60.61.B8.FF.C4.4A.1E\n"
        },
        {
          "key": "slipAuth",
          "value": "1D.B7.AB.DE.DD.C8.99.A1.E7.60.61.B8.FF.C4.4A.1E"
        }
      ]
    },
    "expirationDate": "2023-08-25T17:34:05Z",
    "relatedPaymentMethodData": {
      "paymentMethodType": "pixout-br",
      "paymentMethodTypeClass": "bank",
      "paymentMethodTypeCountry": "BR",
      "paymentMethodTypeDescription": "PIX"
    },
    "status": "active"
  },
  "senderKyc": {},
  "subType": "",
  "transactionReference": "1005511",
  "transactionStatus": "waiting",
  "type": "withdrawal"
}'
curl -X 'PUT' '{{callback_URL}}' \
--header 'connection: close' \
--header 'accept-encoding: gzip'\
--header 'x-timestamp: 2022-08-25T21:49:25.529638Z' \
--header 'x-signature: hmJu9c2y4+p/VvbuM9buiXEkPJXBFife/fUbNHu+hQ15yuvYq7qOYIyPbzHY4HkEVr07RQzV22LS8K0b3zVUaVPvUh40u+bJjtCuRWTGnrwhmwrsPoMJV/baXkye9vA1D97/hE7hpjTUjnQ6CmZ/d2hQt77825Dxsv1o1VhN1q2dil+E8Mkvy8cw1bjPyQWYfr2jeIwg/TBpD1IbqgtYs6v9WVq1sSkeGuA+sRf0nVNHurEbMmNwMe8mxA/CWo1hYxqXP1R7oiAktYaOkUU0XNE9uHNdVr2cjSOVIEMjzZgNlNjEx7SJ/AnS5ldP3gbRunQd0IHPQRklyzoFZFHBvQ==' \
--header 'x-correlationid: 393c990f-ab88-4b49-8e68-869e093ef545'\ 
--header 'content-type: application/json' 
--header 'content-length: 3035'\
--data-raw '{
  "amount": "50.00000000",
  "conciliationOptions": [],
  "confirmed": true,
  "country": "BR",
  "creationDate": "2022-08-30T17:34:01.920166Z",
  "creditParty": {
    "data": {
      "key": "[email protected]"
    },
    "type": "pixout-br",
    "typeClass": "bank",
    "typeCountry": "BR"
  },
  "currency": "BRL",
  "debitParty": {
    "data": {
      "ACCOUNT_ID": "1000507"
    },
    "paymentMethodReference": "3334343132332D313030302D32333639",
    "type": "emoneyout-brl",
    "typeClass": "emoneyout",
    "typeCountry": "BR"
  },
  "descriptionText": "PIX BR 13/04",
  "fees": {
    "creditPartyEarnedCommission": "0.00000000",
    "creditPartyNetCommission": "0.00000000",
    "creditPartyPaidCommission": "0.00000000",
    "debitPartyEarnedCommission": "0.00000000",
    "debitPartyNetCommission": "0.00000000",
    "debitPartyPaidCommission": "0.00000000"
  },
  "fx": {},
  "geoCode": "",
  "metadata": [
    {
      "creationDate": "2022-08-30T17:34:02Z",
      "key": "SV_TRANSACTION_ID",
      "value": "107349"
    },
    {
      "creationDate": "2022-08-30T17:34:02Z",
      "key": "DEBIT_PARTY_PAID_COMMISSION",
      "value": "0.00000000"
    },
    {
      "creationDate": "2022-08-30T17:34:02Z",
      "key": "CREDIT_PARTY_NET_COMMISSION",
      "value": "0.00000000"
    },
    {
      "creationDate": "2022-08-30T17:34:02Z",
      "key": "DEBIT_PARTY_EARNED_COMMISSION",
      "value": "0.00000000"
    },
    {
      "creationDate": "2022-08-30T17:34:02Z",
      "key": "DEBIT_PARTY_NET_COMMISSION",
      "value": "0.00000000"
    },
    {
      "creationDate": "2022-08-30T17:34:02Z",
      "key": "CREDIT_PARTY_PAID_COMMISSION",
      "value": "0.00000000"
    },
    {
      "creationDate": "2022-08-30T17:34:02Z",
      "key": "CREDIT_PARTY_EARNED_COMMISSION",
      "value": "0.00000000"
    }
  ],
  "modificationDate": "2022-08-30T17:51:38.323681Z",
  "recipientKyc": {},
  "requestDate": "",
  "requestingOrganisationTransactionReference": "185668",
  "requiredAction": {
    "actionType": "awaitconfirmation",
    "data": {
      "additionalInformation": [
        {
          "key": "endToEndId",
          "value": "E1393589320220830173401277580400"
        },
        {
          "key": "slip",
          "value": "     COMPROVANTE TRANSFERENCIA PIX      \n            30/08/2022 14:34            \n           TERM 11 AGENTE 999           \n                CONTROLE                \n    E1393589320220830173401277580400    \n----------------------------------------\n                PAGADOR                 \n\n           Teste Interno Is2b           \n            AG:1 CC:100467472           \n          CPF/CNPJ:85932702559          \n----------------------------------------\n               RECEBEDOR                \n\n      54403563 AG:1 CC:0000372163       \n        CPF/CNPJ:04219219000480         \n         CHAVE:[email protected]          \n----------------------------------------\n   DATA DO PAGAMENTO 30/08/2022 14:34   \n\n            VALOR R$ 50,0000            \n----------------------------------------\n              AUTENTICACAO              \n1D.B7.AB.DE.DD.C8.99.A1.E7.60.61.B8.FF.C4.4A.1E\n"
        },
        {
          "key": "slipAuth",
          "value": "1D.B7.AB.DE.DD.C8.99.A1.E7.60.61.B8.FF.C4.4A.1E"
        }
      ]
    },
    "expirationDate": "2023-08-25T17:34:05Z",
    "relatedPaymentMethodData": {
      "paymentMethodType": "pixout-br",
      "paymentMethodTypeClass": "bank",
      "paymentMethodTypeCountry": "BR",
      "paymentMethodTypeDescription": "PIX"
    },
    "status": "confirmed"
  },
  "senderKyc": {},
  "subType": "",
  "transactionReference": "1005511",
  "transactionStatus": "finished",
  "type": "withdrawal"
}'