Sign in

v1

latestOpenAPI 3.0.3Apache License Version 2.02026-07-2631211285.4 KB
Onboarding Services

Send Data

Receives a new onboarding data.

post/v1/onboarding

Request body

Example request

{
  "store": {
    "name": "Store23",
    "countryCode": "BR",
    "document": "1234567"
  },
  "contacts": [
    {
      "contact": "test@example.com"
    }
  ],
  "payments": [
    {
      "personData": {
        "firstName": "John",
        "lastName": "Doe",
        "email": "test@example.com",
        "cpf": "57616508278",
        "birthDate": "1990-05-06",
        "countryCode": "55",
        "phone": "(11)23456-3456",
        "mcc": "8999",
        "address": {
          "address": "SCN Quadra 02, Bloco G",
          "number": "12",
          "cep": "05376-140"
        },
        "revenue": "500055"
      },
      "companyData": {
        "name": "Store 12",
        "cnpj": "56651716001150",
        "address": {
          "address": "SCN Quadra 02, Bloco G",
          "number": "12",
          "cep": "05376-140"
        },
        "email": "test@example.com",
        "countryCode": "55",
        "phone": "(11)23456-3456",
        "mcc": "8999",
        "revenue": "500055"
      },
      "transferData": {
        "account": "05376140",
        "bank": "John Doe",
        "code": "001",
        "branch": "0015",
        "documentNumber": "1234567889"
      },
      "pricing": [
        {
          "detailed": [
            {
              "installment": 1,
              "brand": "VISA"
            }
          ]
        }
      ]
    }
  ],
  "transaction": {
    "referenceId": "FGCCCEA53JYSHXX",
    "callbackUrl": "http://domain/service"
  }
}

Response

Onboarding response

onboardingIdstring required

Onboarding identification

referenceIdstring required

Client transaction identifier

status'PENDING' | 'INPROGRESS' | 'ACTIONREQUIRED' | 'COMPLETED' | 'REJECT' | 'CANCELLED' required

Onboarding status

messagestring

Information message

Example response

{
  "onboardingId": "31ff2cc8-199e-4c3c-ba2d-4d85b88bd9f2",
  "referenceId": "FGCCCEA53JYSHXX",
  "message": "Test message",
  "credentials": {
    "storeCode": "STORE12",
    "privateKey": "dqwg43yefnjnk5fe",
    "orgId": "s4fes6ytr4"
  },
  "paymentAccounts": [
    {
      "account": "AP12345PI",
      "evaluatesFraud": true
    }
  ]
}